Class Reference
IRIS for UNIX 2024.1.2
|
|
Private
Storage
|
StartProduction
|
|
|
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).
Displayed name of this page.
User needs USE permissions on the %Ens_ProductionDocumentation resource to view this page.
|
Current document format: "PDF" or "HTML"
Name of production that is displayed.
Is the user permitted to access the fileSelect popup.
Time in seconds since last report before which a popup is given seeking confirmation. Compared with property secondsSinceLastReport
Time in seconds since the report was last generated. Only set when a production is selected and does not change until another production is selected or the page is refreshed.
|
Decorate the page.
Get the (localized) name of the page.
Get the (localized) title string for the page.
If HTML documentation exists for the Production, return the URL for display; otherwise return null.
This method generates a document for the specified production and returns a status that JavaScript can understand.
Draw results and log file if any.
Draw current documentation status; intended for use with background documentation jobs.
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.
Use when the documentation job is running in the background to check on running status. Returns either "running" or "idle" or "done".
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.
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.
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.
Use when the documentation job is running in the background to check on status.
Use when the documentation job is running in the background to check on status.
Use when the documentation job is running in the background to check on running status. Returns either "running" or "idle" or "done".
Get information to display in the ribbon bar. Make appropriate choices for Production Documentation.
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.
User clicked the Browse button.
Generate new document for the specifed production.
Decide what to do about documenting the specifed production in HTML format.
The argument filename is the full pathname of the output PDF file.
This method calls server method to get current background documentation job status and update the UI.
This client event, if present, is fired when the a popup page launched from this page fires an action.
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.
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).