Ens.Util.Documentation
class Ens.Util.Documentation
Method Inventory
Methods
classmethod BookName(pProduction As %String, Output BookName As %String, Output BookFileName As %String, Output LogFileName As %String)
Choose a book name and file name for the book and for the log, based on a CRC of the namespace and production name.
The files are temporary, they will be created in the system's temp directory.
Return a boolean value indicating if the production documentation already exists.
classmethod CreateDoc(pProduction As %String = "", pIntro As %Boolean = 1, pFormat As %String, Output LogFileName As %String, Output URL As %String, Output BookName As %String, PDFFileName As %String = "", PDFRenderer As %String = "", ByRef Params As %String, pAllSettings As %Boolean = 0) as %Status
Production documentation generation -- Common code for HTML and PDF formats.
See the description for methods CreateDocumentHTML and CreateDocumentPDF in class Ens.Config.Production.
The parameter pAllSettings defaults to 0 but if set to 1 all settings including default values for a host item will be included.
The parameter pAllSettings defaults to 0 but if set to 1 all settings including default values for a host item will be included.
Method to delete the HTML Report for a production in current namespace
API to provide cleanup should it be needed.
API to provide cleanup should it be needed.
Helper method: Return the URL to render the production documentation in HTML format.
classmethod LastHTMLCreationDate(pProduction As %String = "", pOutputEscape As %String = "HTML", Output pAgeInSeconds=0, Output pUser As %String) as %String
Method to retrieve last date the HTML report was created for a production to the minute.
The default is to return the value escaped for HTML.
Also returns the age in seconds in 3rd parameter and the user that generated.
The default is to return the value escaped for HTML.
Also returns the age in seconds in 3rd parameter and the user that generated.