This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsPortal.ProductionDocument

EnsPortal.ProductionDocument

class EnsPortal.ProductionDocument extends EnsPortal.Template.standardPage

StartProduction

Property Inventory

Method Inventory

Parameters

parameter CSSINCLUDES = ensemble/Ensemble_Wizards.css;
Inherited description: Comma-separated list of additional CSS include files for the page. If this page is using CSS3 then the CSS3INCLUDES parameter is used (if defined).
parameter PAGENAME = Production Document;
Displayed name of this page.
parameter RESOURCE = %Ens_ProductionDocumentation:USE;
User needs USE permissions on the %Ens_ProductionDocumentation resource to view this page.

Properties

property DocumentFormat as %String;
Current document format: "PDF" or "HTML"
Property methods: DocumentFormatDisplayToLogical(), DocumentFormatGet(), DocumentFormatIsValid(), DocumentFormatLogicalToDisplay(), DocumentFormatLogicalToOdbc(), DocumentFormatNormalize(), DocumentFormatSet()
property ProductionName as %ZEN.Datatype.string (ZENURL = "PRODUCTION");
Name of production that is displayed.
Property methods: ProductionNameDisplayToLogical(), ProductionNameGet(), ProductionNameIsValid(), ProductionNameLogicalToDisplay(), ProductionNameLogicalToOdbc(), ProductionNameNormalize(), ProductionNameSet()
property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
Property methods: canViewFileSystemDisplayToLogical(), canViewFileSystemGet(), canViewFileSystemIsValid(), canViewFileSystemLogicalToDisplay(), canViewFileSystemLogicalToXSD(), canViewFileSystemNormalize(), canViewFileSystemSet(), canViewFileSystemXSDToLogical()

Methods

method %OnAfterCreatePage() as %Status
Decorate the page.
method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
method DecideProductionJS(pProdId As %String) as %String [ ZenMethod ]
If HTML documentation exists for the Production, return the URL for display; otherwise return null.
classmethod DocumentProductionJS(pProdId As %String, pFormat As %String, pPDFFileName As %String = "", pPDFRenderer As %String = "") as %String
This method generates a document for the specified production and returns a status that JavaScript can understand.
method DrawResults(seed As %ZEN.Datatype.string = "") as %Status
Draw results and log file if any.
method DrawStatus(seed As %ZEN.Datatype.string) as %Status
Draw current documentation status; intended for use with background documentation jobs.
method FileProblem(pFilename As %String) as %String [ ZenMethod ]
Check for problems in the output file for PDF, and report back. "0" means ok, "1" means the file exists, "2" means the directory does not exist, "3" means the filename is not supplied, "4" means the filename is not correct for PDF output, "5" means a blank value was supplied.
classmethod GetCompletionValue() as %Boolean
classmethod GetDefaultDir() as %String [ ZenMethod ]
classmethod GetDocumentationStatus() as %String [ ZenMethod ]
Use when the documentation job is running in the background to check on running status. Returns either "running" or "idle" or "done".
classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
classmethod GetJobStatus() as %ListOfDataTypes [ ZenMethod ]
Use when the documentation job is running in the background to check on error status. Returns error message and log file name/contents if available.
classmethod GetRunningDuration() as %String
Use when the documentation job is running in the background to check on status. Gets the number of seconds job has been running (or ran, if complete) and formats it nicely as a string.
classmethod GetRunningProductionName() as %String
Use when the documentation job is running in the background to check on status.
classmethod GetRunningStartTime() as %String
Use when the documentation job is running in the background to check on status.
classmethod GetRunningStatus() as %String
Use when the documentation job is running in the background to check on running status. Returns either "running" or "idle" or "done".
method OnGetRibbonInfo(Output pDisplay As %Library.Boolean, Output pViewIcons As %Library.List, Output pSortOptions As %Library.List, Output pSearchBox As %Library.Boolean, Output pRibbonTitle As %Library.String, Output pCommands As %Library.List) as %Status
Get information to display in the ribbon bar. Make appropriate choices for Production Documentation.
classmethod RunDocumentInBackground(pProdId As %String, pFormat As %String, pPDFFileName As %String = "", pPDFRenderer As %String = "") as %ZEN.Datatype.string [ ZenMethod ]
Run method DocumentProductionJS() in a background job. Return 1 if this works out ok, an error string if there is an error in running the job (regardless of the results of the method DocumentProductionJS() itself). The input pFormat is the string "HTML" or "PDF" indicating the output format.
classmethod SetCompletionValue(pValue As %Integer) as %Boolean
classmethod SetDefaultDir(pPathname As %String) [ ZenMethod ]
clientmethod browseSelect() [ Language = javascript ]
User clicked the Browse button.
clientmethod btnCreate(format) [ Language = javascript ]
Generate new document for the specifed production.
clientmethod btnView() [ Language = javascript ]
Decide what to do about documenting the specifed production in HTML format.
clientmethod doCreatePDF(filename) [ Language = javascript ]
The argument filename is the full pathname of the output PDF file.
clientmethod doStatus() [ Language = javascript ]
This method calls server method to get current background documentation job status and update the UI.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded. Start the timer so we can check the status. If there is a background documentation job currently running, you will see a periodic update until the job is finished.
clientmethod timeout(timer) [ Language = javascript ]
This function controls the timer on updating progress. It is called from onload as well (in case a background documentation job is currently being run when the page is opened).

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window