Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsPortal.ProductionDocument
Private  Storage   


class EnsPortal.ProductionDocument extends



Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 3 31


This is a Zen Page class. It belongs to the application EnsPortal.Application.

%ComponentClasses %ComponentNames %Components %CompositeList
%DeletedIds %NotifyList %RenderList %UserPackageList
%condition %import %includeFiles %page
%partial %resource %xmlOutputMode DocumentFormat
HelpAddress ISREADONLY LocatorHeader ParentURL
ProductionName SVGClassList StdTitle UserSVGPackageList
aboutPage align aux backgroundTimerInterval
canEdit canViewFileSystem cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle cssLevel currSortMode
currStep currViewMode designMode disabled
dragAndDrop dragEnabled dropEnabled dynamic
enableAutoRefresh enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle home
homePage id index inlineSVG
isPopup isSoftModal keepAliveInterval label
labelClass labelDisabledClass labelPosition labelStyle
lastModalIndex layout lblTitle limitPopups
msgNotPermitted name nextIndex onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onoverlay onrefresh onshow
onupdate overlayMode pageModified parent
popupParent renderFlag searchKey showLabel
slice title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

%%OIDGet %AddCSPShareHyperevents %AddChild %AddChildAfter
%AddChildBefore %AddComponent %AddEnsExceptionHandler %AddImportedComponents
%AddLocatorLinks %AddToSaveSet %ApplyURLParms %Attr
%BindExport %BuildObjectGraph %ClassIsLatestVersion %ClassName
%Close %ConstructClone %CreateApplication %CreatePage
%DetermineCSSLevel %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawAutoLogout %DrawClassDefinition %DrawClassDefinitions %DrawComponentHTML
%DrawHTML %DrawHTMLPage %DrawJSGetSettings %DrawJSSerialize
%DrawJSStrings %DrawObjectDefinitions %DrawObjectProperties %DrawSVGDef
%DrawStyleDefinitions %DrawStyleHTML %DrawStyleSVG %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GenerateCode %GetAllNamespaces
%GetChildIndex %GetClassCRC %GetClassDepth %GetComponent
%GetComponentById %GetComponentByName %GetComponentPropertyById %GetDependentComponents
%GetEventHandlers %GetHomePage %GetHomeParam %GetIncludeFiles
%GetIncludeInfo %GetLinks %GetLocatorInfo %GetLocatorLinks
%GetPageName %GetPaneContents %GetParameter %GetProductName
%GetRootLink %GetSuperClassList %GetValueById %GetValueByName
%GetXMLName %IncrementCount %IsA %IsEmbedded
%IsModified %Link %LinkCSS %LinkScript
%MakeId %New %NormalizeObject %ObjectModified
%ObjectSynch %OnAddToPage %OnAddToPageAfter %OnAddToPageBefore
%OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication %OnCreatePage
%OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead
%OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask %OnGetPageName
%OnGetProductName %OnGetSmallMenu %OnGetTitle %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnUseSoftModals %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %ReallyAddChild %Register
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%XMLGenerate %ZENDeserialize %ZENVersion BuildMenu
CheckAllBlanks CheckContextLinks CheckDocBookWebAppEnabled CheckEnterpriseManager
ConvertParameter DecideProductionJS Decrypt DoLogout
DocumentProductionJS DrawLocator DrawResults DrawRibbon
DrawStatus DrawTitle Encrypt EncryptBroker
EscapeHTML EscapeURL EvalResult FileProblem
GetCSPURL GetCompletionValue GetContextLinks GetDefaultDir
GetDocURL GetDocumentationStatus GetHomePage GetHyperEventResources
GetJobStatus GetNewURL GetQuickLinks GetRunningDuration
GetRunningProductionName GetRunningStartTime GetRunningStatus HyperEventBody
HyperEventCall HyperEventFrame HyperEventHead Include
InsertHiddenField InsertHiddenFields InvokeClassMethod InvokeInstanceMethod
IsPrivate Link LoadZenComponent MonitorBackgroundTask
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS ReallyRefreshContents
RegisterRecent RewriteURL RunDocumentInBackground SetCompletionValue
SetDefaultDir ShowError SimpleKeepAlive StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLAfterExport XMLBeforeExport XMLDTD XMLExport
XMLExportInternal XMLExportToStream XMLExportToString XMLGetSchemaImports
XMLImport XMLImportInternal XMLIsObjectEmpty XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addPopupSuffix arrowClick
backgroundTimerHandler browseSelect btnCreate btnView
cancelPopup changePassword changeURLNamespace checkEdit
childrenMutated clearBackgroundTask clientKeepAlive correctIELayering
createComponent createComponentNS deleteComponent disableCommandButton
doCreatePDF doStatus dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
enableCommandButton endModal exposeComponent findElement
fireOnLoadEvent fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getPageTitle getProperty getSettings
getTargetPage getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
inResizeLoop initPopupSuffix invokeSuper isOfType
launchPopupWindow logout makeId navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler progressBarHandler refreshContents
removeChild removePopupSuffix render renderContents
renderSVG searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress setBackgroundTask setComponentId
setConnectivityStatusMsg setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showCommandButton showContact showDocumentation
showHelp startKeepAlive startModal startProgressBar
stopKeepAlive stopProgressBar switchNamespace testConnectivity
timeout updateControlsInGroup


• parameter CSSINCLUDES = "ensemble/Ensemble_Wizards.css";
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.


• property DocumentFormat as %String;
Current document format: "PDF" or "HTML"
• property ProductionName as %ZEN.Datatype.string(ZENURL="PRODUCTION");
Name of production that is displayed.
• property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.


• method %OnAfterCreatePage() as %Status
Decorate the page.
• private method %OnGetJSResources(ByRef pResources As %String) as %Status
Pages can implement this callback method in order to define a set of client-side resources: javascript strings that have been localized.
This method should fill in the array pResources with a set of localized strings, indexed by resource id:
	 Set pResources("MyId") = $$$Text("Some string")
Javascript methods can refer to these resources using the helper function zenGetResource:
Zen defines a set of built-in resource strings using this mechanism. These have a "zen" prefix to keep them seperate from user ids.
You can also override the same callback method within your %ZEN.application class if you wish to share resources across an application. In this case, the application-wide callback is invoked first.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• method CheckDocBookWebAppEnabled() as %Boolean [ ZenMethod ]
Check that we will be able to create and display the documentation in the /csp/docbook web app
• 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 %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String) 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 ]
• method browseSelect() [ Language = javascript ]
User clicked the Browse button.
• method btnCreate(format) [ Language = javascript ]
Generate new document for the specifed production.
• method btnView() [ Language = javascript ]
Decide what to do about documenting the specifed production in HTML format.
• method doCreatePDF(filename) [ Language = javascript ]
The argument filename is the full pathname of the output PDF file.
• method doStatus() [ Language = javascript ]
This method calls server method to get current background documentation job status and update the UI.
• method 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.
• method 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.
• method 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).