Home > Class Reference > ENSLIB namespace > EnsPortal.ProductionConfig
Private  Storage   


class EnsPortal.ProductionConfig extends EnsPortal.Template.prodConfigSCPage

Production configuration page. notify if settings modified, notify if settings externally modified, disable form update while modified


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 30 193


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

%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
OS ParentURL StdTitle aboutPage
align aux backgroundTimerInterval busProperty
canEdit canEditDB canViewFileSystem canViewMessageTrace
canViewProcessDetails cellAlign cellSize cellStyle
cellVAlign children composite contactPage
containerStyle cssLevel currCategory currItem
currRestartItem currRestartName currSortMode currStep
currTabNo currViewMode currentNamespace currentProject
currentUser dbIsRO deploymentFile disabled
dragAndDrop dragEnabled dropEnabled enableAutoRefresh
enclosingClass enclosingStyle error groupClass
groupStyle hasSCOutput height hidden
hint hintClass hintStyle home
homePage id index isWin64
keepAliveInterval label labelClass labelDisabledClass
labelPosition labelStyle layout lblTitle
limitPopups msgGoToEventLog msgGoToJobs msgGoToMessageViewer
msgGoToQueues msgLoading msgNoDBPermissions msgNotPermitted
msgProductionReadOnly msgSCReadOnly multiItems name
needProject onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate pageModified parent
productionId productionIdURL queueCount readOnly
readOnlyReason refreshMode renamed searchKey
securityHelper selectedHost settingsHidden showLabel
slice sourceControlEnabled sourceControlManagerDialog sourceControlNewlineFormat
sourceControlOutputDialog sourceControlVisible tabFontSizeForGerman title
tuple useSVG useSoftModals valign
visible visualAid width window

%AddCSPShareHyperevents %AddChild %AddChildAfter
%AddChildBefore %AddComponent %AddEnsExceptionHandler
%AddImportedComponents %AddLocatorLinks %AddToSaveSet
%ApplyURLParms %Attr %BindExport
%ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawAutoLogout %DrawClassDefinitions
%DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSStrings %DrawObjectDefinitions %DrawSourceControlCommands
%DrawSourceControlHead %DrawSourceControlJS %DrawSourceControlStyle
%EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends
%ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers
%GetHomePage %GetHomeParam %GetLinks
%GetLocatorLinks %GetPageName %GetParameter
%GetProductName %GetRootLink %GetValueById
%GetValueByName %GetXMLName %IsA
%IsModified %Link %LinkCSS
%LinkScript %MakeId %New
%NormalizeObject %ObjectModified %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
%Register %RemoveChild %RemoveChildren
%RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified
%SetValueById %SetValueByName %SetValuesByName
%StartScript %ValidateObject %ZENVersion
AbortJobMsg AbortMessage AbortQueue
AddMsgToUpdateErrorLog AfterUserAction AppendSourceControlOutput
BuildMenu CheckAllBlanks CheckContextLinks
CheckEnterpriseManager CheckFileExists ClearSourceControlOutput
ConvertParameter CopyConfigItem CreateProject
CreateSourceControl CurrentTime Decrypt
DeleteConfigItem DoLogout DocumentLoad
DocumentSave DrawDiagramHeader DrawLocator
DrawRibbon DrawTitle Encrypt
EscapeHTML EscapeURL EvalResult
FormatDateTime GetCSPURL GetCategories
GetChangedStatuses GetConnectionArray GetConnectionArrayById
GetContextLinks GetCurrentProduction GetCurrentProject
GetDocURL GetDuplicateInfo GetDuplicateItems
GetFullProjectName GetHomePage GetHyperEventResources
GetInternalName GetJobsArray GetLogArray
GetModifiedSettings GetNewURL GetNextModifiedSetting
GetPreferredCategoryForProduction GetProductionArray GetQueueArray
GetQueueCount GetQuickLinks GetSecurityHelper
GetSettingsArray GetSettingsArrayById GetSourceControlClass
GetSourceControlCommands GetTestingServiceURL GetTimestamp
GetTitle HTMLPopup HaveSourceControlOutput
HostChangeClass HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields
IsDocReadOnly IsEnabled IsPrivate
IsProductionSCReadOnly IsProjectRequired IsRuntimeDifferentFromClass
IsSourceControlReadOnly KillModifiedSettings Link
LoadProject LocalizeProductionStatus OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page
QuoteJS RegisterRecent RemoveSettingByName
RewriteURL SCSubmitProduction SaveArraysOfSettings
SaveModifiedSetting SavePreferredCategoryForProduction SaveSettingsToServer
SetCurrentProject SetProjectRequired ShowError
SimpleKeepAlive StartTimer StopJob
StopTimer StoreExpandoStates SuspendJobMsg
ThrowError UnescapeHTML UnescapeURL
UpdateAutoRefreshStateProd UpdateProductionStatus UpdateSCMenus
UserAction XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore
addItem addPopupSuffix adjustSizes
appendServerOutput applyChanges arrowClick
backgroundMouseMoveHandler backgroundMouseUpHandler busPartnerClick
calculateHeight canUserModify cancelPopup
changeBusProperty changeClass changePassword
changeURLNamespace checkEdit checkEditDB
checkHelper checkLostSettings checkRuntimeAndClassInSync
checkTextControls childrenMutated chooseSCMenu
chooseSCProject clearActionTimer clearConnectors
clearSCOutput clearSearch clientKeepAlive
connectItems copyItem correctIELayering
createComponent createComponentNS createEditorComponent
createListingText createSCMenuItem createSCProject
createSCSubMenu ctrlSelectItem deleteComponent
deleteItem disableCommandButton disableComponents
disableMultiItems documentProduction dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler
drawBus drawDiagram drawDuplBox
drawListing drawOverview dropHandler
dropStartHandler enableCommandButton enableMultiItems
endModal endRubberBand errChangeClass
expandAll expandoStatesString exportItem
exposeComponent findElement findHostObj
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction fireTimerAction getChildIndex
getClientModel getComboboxList getComponent
getComponentById getConnectorInfo getCurrentExtension
getCurrentName getEnclosingDiv getHidden
getHintElement getHost getIsReadOnly
getLabelElement getNewClass getOpener
getPageTitle getPolyPath getProductionModel
getProperty getReadOnlyReason getSaveAction
getSettings getTitleAreaHeight getType
goHome goMenu gotoMessageViewer
gotoNamespace gotoPage grayOutNewButton
hasDBPermissions hideCommandButton htmlToTooltip
importFiletoExportDialog inResizeLoop initPopupSuffix
initSecurity initializeSourceControl initializeTextMonitor
invokeAfterUserAction invokeSourceControl invokeSuper
isOfType isTestingEnabled itemClick
itemDblClick itemDotMouseDown itemDotMouseOut
itemDotMouseOver itemMouseOut itemMouseOver
jobAbortMsg jobStop jobSuspendMsg
launchPopupWindow loadDocument loadProduction
logout makeId moveRubberBand
navigate newExpando newProduction
onCreate onDelete onDisplayHandler
onDocumentLoad onDocumentLoadComplete onDocumentSave
onDocumentSaveComplete onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler parseParamExpression popupActionHandler
queueAbortMsgs queueItemClick recoverProduction
rectMouseOut rectMouseOver redrawItemDuplControl
reexportItem refreshContents refreshDiagram
refreshDiagramHeaderStates refreshHandler refreshLogTab
refreshQueueTab refreshStatusHandler reloadDiagram
reloadDocument removeChild removePopupSuffix
render renderContents renderHelpText
renderSVG restartMultiItems restartMultiItemsPart2
restartRefreshTimer saveDocument scSetReadWriteState
scrollDiagram searchBlur searchBoxHandler
searchChanged searchFocus searchKeyDown
searchKeyPress selectCategory selectDirectory
selectFile selectItem selectSettingsDefaults
setComponentId setConnectivityStatusMsg setDisplaySort
setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll
setReadOnly setRefreshMode setSCProject
setShowBy setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler
settingChanged shiftSelectItem showAbout
showCommandButton showConnectors showConnectorsContd
showContact showDocumentation showHelp
showLegend showListingTip showMsgBox
showProcessDetails showRecoverButton showSCMenu
showSCOutput showTrace showUpdateButton
startActionTimer startKeepAlive startModal
startProduction startProgressBar startRubberBand
startTimers stopKeepAlive stopProduction
stopProgressBar stopTimers switchDuplItem
switchNamespace tempRestartItem tempStartItem
tempStopItem testItem textControlKeyDown
textControlKeyUp toggleReadOnly toggleSettings
unselectAll unselectItem updateActions
updateDocumentState updateDotColor updateExpandoStates
updateHasDups updateJobs updateLog
updateMessages updateModifiedSettings updateProduction
updatePropertySheet updatePropertySheetTabs updateQueue
updateSCIndicator updateSecurityHelper updateSettings
updateView visitQueuesPage


• parameter DEFAULTVIEWMODE = "list";
If this page has multiple views, this is its initial display mode.
• parameter EDITRESOURCE = "%Ens_ProductionConfig:WRITE";
User needs WRITE permissions on the %Ens_ProductionConfig resource to make changes to the Production configuration. Other actions require alternate privileges.
• parameter JSINCLUDES = "zenCSLM.js,EnsPortal_Component.js,zenMenusSMPEns.js";
JavaScript debug library Usage: ZLM.dumpObj(object);
• parameter PAGENAME = "Production Configuration";
Displayed name of this page.
• parameter RESOURCE = "%Ens_ProductionConfig:READ";
User needs READ permissions on the %Ens_ProductionConfig resource to view this page.


• property OS as %String [ InitialExpression = $system.Version.GetBuildOS() ];
OS platform ("Windows", "UNIX" or "VMS")
• property busProperty as %ZEN.Datatype.string [ InitialExpression = "busPartner" ];
Specifies what property is used to draw the bus diagram.
• property canEditDB as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether the user has WRITE permissions on the Databases used by this production
• property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
• property canViewMessageTrace as %Boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];
Is the user permitted to view Message Trace
• property canViewProcessDetails as %Boolean [ InitialExpression = $system.Security.Check("%Admin_Operate","USE") ];
Is the user permitted to view Process Details
• property currCategory as %String;
Current selected Category.
• property currItem as %Integer [ InitialExpression = -1 ];
Index number of current selected item.
• property currRestartItem as %Integer [ InitialExpression = -1 ];
Index number of current item that is being restarted. -1 is used to restart using disable and then enable - hence modifies the production -2 is used to restart using the temporary stop and start apis and does not modify the production.
• property currRestartName as %String;
Used to validate that when restarting the item after a disable the item number has not changed.
• property currTabNo as %Integer [ InitialExpression = 0 ];
Current tab (used when moving to a different tab to return later to the same tab it was before).
• property dbIsRO as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate if the default db is mounted R/O
• property deploymentFile as %ZEN.Datatype.string;
Name of existing deployment export file (on server).
• property isWin64 as %ZEN.Datatype.boolean [ InitialExpression = $$$isWINDOWS && $system.Version.Is64Bits() ];
Indicates if system is Windows 64-bits (used to show property Exec64 when applicable).
• property msgGoToEventLog as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Go To Event Log") ];
• property msgGoToJobs as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Go To Jobs") ];
• property msgGoToMessageViewer as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Go To Message Viewer") ];
• property msgGoToQueues as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Go To Queues") ];
• property msgLoading as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Loading...") ];
• property msgNoDBPermissions as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("This action writes to a database that you do not have WRITE permissions on.") ];
Message to inform user they don't have WRITE permissions on the DB required to perform an action
• property multiItems as array of %Integer;
• property productionId as %String [ InitialExpression = ..GetCurrentProduction() ];
ID of Production to display.
• property productionIdURL as %String(ZENURL="PRODUCTION");
ID of Production passed in the URL.
• property queueCount as array of %Integer;
Array of queue counts to keep track of queue growth across refreshes
• property refreshMode as %Boolean [ InitialExpression = 0 ];
Current refresh mode.
• property securityHelper as %ZEN.proxyObject;
Zen proxy object to help determine what actions a user may take on the page.
• property selectedHost as %String(ZENURL="HOST");
Name of selected host passed in the URL to be initially selected on the diagram
• property settingsHidden as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether the settingsPanel is currently hidden.
• property tabFontSizeForGerman as %String [ InitialExpression = $S(%session.Language="de":"td.tabGroupButtonOn, td.tabGroupButtonOff, td.tabGroupButtonDisabled { font-size: 12px; }", 1:"") ];
• property visualAid as %String(ZENURL="VISUALAID");
visual aid


• method %OnAfterCreatePage() as %Status
Decorate the page.
• classmethod %OnBeforeCreatePage() as %Status
This class method callback is called just before the server-side page object is created.
• method %OnDrawHTMLHead() as %Status
Add the EnsException error handling on the client.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
• classmethod AbortJobMsg(pJob As %String) as %String [ ZenMethod ]
• method AbortMessage(pHeaderId As %String, pPriority As %Integer, pQueueName As %String) as %String [ ZenMethod ]
• classmethod AbortQueue(pQueueName As %String) as %String [ ZenMethod ]
• method AddMsgToUpdateErrorLog(pMsg As %String = "", pClass As %String = "", pMethod As %String = "")
• method CheckFileExists(pFile) as %Boolean [ ZenMethod ]
• classmethod CopyConfigItem(pProduction As %String, pConfigId As %String, pNewName As %String) as %String [ ZenMethod ]
• classmethod CurrentTime() as %String [ ZenMethod ]
Return current server time in format HH:MM:SS
• classmethod DeleteConfigItem(pProduction As %String, pConfigId As %String) as %String [ ZenMethod ]
• method DrawDiagramHeader(pSeed As %String) as %Status
Draw the contents of the diagram header.
• method FormatDateTime(table As %ZEN.Component.tablePane, dt As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
Method to get the Date or Time piece from the TimeCreated field.
• classmethod GetCategories(pProd As %String = "") as %ListOfDataTypes [ ZenMethod ]
Return an array indexed categories.
• classmethod GetChangedStatuses(ByRef pProd As %String) as %String [ ZenMethod ]
Server-side method that checks if the Production status has changed and which item statuses have changed. Returns ProductionStatusHasChanged#ItemId,Lane,ItemStatus,AdapterStatus;..." (max. ~32K). Only items whose status has changed are in the list of items.
• classmethod GetConnectionArray(ByRef pParameters, Output pMetaData, Output pData) as %Status
Provide the data (as an array) that will drive the display of connection lines, by name.
• classmethod GetConnectionArrayById(ByRef pParameters, Output pMetaData, Output pData) as %Status
Provide the data (as an array) that will drive the display of connection lines, by id.
• classmethod GetCurrentProduction() as %String
Choose which Production to start with.
• classmethod GetDuplicateInfo(pId As %String, pProd As %String) as %ListOfDataTypes [ ZenMethod ]
Get host information for the newly selected item id.
• classmethod GetDuplicateItems(pProd As %String, pName As %String) as %ArrayOfDataTypes [ ZenMethod ]
See if there are multiple copies with the same name as the given item within the Production.
• 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 GetJobsArray(ByRef pParameters, Output pMetaData, Output pData) as %Status
Provide the data (as an array) for the job instances of the current item.
• classmethod GetLogArray(ByRef pParameters, Output pMetaData, Output pData) as %Status
Provide the data (as an array) for the event log entries of the current item.
• classmethod GetModifiedSettings(ByRef pMod As %ListOfDataTypes) as %Integer [ ZenMethod ]
Build an array with the name of all settings that were reset to default.
• classmethod GetNextModifiedSetting(pName) as %ListOfDataTypes [ ZenMethod ]
• classmethod GetPreferredCategoryForProduction(pProduction As %String = "", pCanEditDB As %Boolean = 1) as %String [ ZenMethod ]
Retrieve the preferred category for the Production.
• method GetProductionArray(ByRef pParameters, Output pMetaData, Output pData) as %Status
Provide the config data (as an array) that will drive the diagram.
• classmethod GetQueueArray(ByRef pParameters, Output pMetaData, Output pData) as %Status
Provide the data (as an array) for the queue entries of the current item.
• classmethod GetQueueCount(pQueueName As %String) as %Integer [ ZenMethod ]
Get Queue Count for Business Hosts with Queue Count larger than rowCount
• classmethod GetSecurityHelper() as %ZEN.proxyObject [ ZenMethod ]
• classmethod GetSettingsArray(ByRef pParameters, Output pMetaData, Output pData) as %Status
Provide the data (as an array) for the settings of the current item, by name.
• classmethod GetSettingsArrayById(ByRef pParameters, Output pMetaData, Output pData) as %Status
Provide the data (as an array) for the settings of the current item, by id.
• method GetTestingServiceURL() as %String [ ZenMethod ]
• method GetTitle() as %String [ ZenMethod ]
• method HTMLPopup(title, locName, text) [ Language = javascript ]
Helper method to set up popup for each setting's online help
• classmethod HostChangeClass(pHostId As %String, pClassName As %String, pProductionId As %String) as %String [ ZenMethod ]
Change the underlying class of a production item to the specified class
• classmethod KillModifiedSettings() [ ZenMethod ]
• classmethod LocalizeProductionStatus(pState As %String = "", Output pLocalizedState As %String, Output pStyle As %String)
• method OnDrawRibbon() as %Status
Add to the contents of the tool ribbon.
• 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.
• classmethod RemoveSettingByName(pItem As Ens.Config.Item, pName As %String, pTarget As %String = "") as %Status
Remove the first setting with a given name. If the user reverts a setting to its default, we remove it from the Production definition.
• classmethod SaveArraysOfSettings(pCount As %Integer, ByRef aName As %ListOfDataTypes, ByRef aTarget As %ListOfDataTypes, ByRef aValue As %ListOfDataTypes, ByRef aValueSource As %ListOfDataTypes, ByRef aDefaultValue As %ListOfDataTypes, ByRef aDefaultSource As %ListOfDataTypes) as %String [ ZenMethod ]
Save session data with information about the settings.
• classmethod SaveModifiedSetting(pName As %String, pValue As %String) as %String [ ZenMethod ]
Save session data with information about settings that have been modified by the user.
• classmethod SavePreferredCategoryForProduction(pCategory As %String = "", pProduction As %String = "", pCanEditDB As %Boolean = 1) [ ZenMethod ]
Save the selected category as the preferred category for the Production.
• classmethod SaveSettingsToServer(pProductionId As %String, pHostId As %String, pCoreSettings As %ZEN.proxyObject, pHostSettings As %ZEN.proxyObject, pAdapterSettings As %ZEN.proxyObject, pMessages As %ZEN.proxyObject, pExpandoStates As %String, pOldValuesCore As %ZEN.proxyObject, pOldValuesHost As %ZEN.proxyObject, pOldValuesAdapter As %ZEN.proxyObject) as %String [ ZenMethod ]
Save settings for the given configuration item or general Production.
• classmethod StopJob(pJob As %String) as %String [ ZenMethod ]
• classmethod StoreExpandoStates(pHostname As %String, pStatesString As %String, pNewHostname As %String) as %String [ ZenMethod ]
Remember the expando states of the settings of the old item, return the expando string for the new item.
• classmethod SuspendJobMsg(pJob As %String) as %String [ ZenMethod ]
• classmethod UpdateAutoRefreshStateProd(pIsAutoRefreshActive As %Boolean = 0, pProduction As %String = "") as %String [ ZenMethod ]
Remember the state of auto refresh for the given Production in the current namespace (we only expect this to be called when auto refresh is turned off because otherwise the state is updated with each refresh)
• classmethod UpdateProductionStatus(ByRef pStates As %ZEN.proxyObject) as %Integer [ ZenMethod ]
• method addItem(type) [ Language = javascript ]
User has pressed add item command - show corresponding add host wizard dialog.
• method adjustSizes(doSettings, adjustEvenIfSameSize) [ Language = javascript ]
Adjust sizes of components on the page.
• method applyChanges(noUpdate, noConfirmation) [ Language = javascript ]
Apply changes to current item.
• method backgroundMouseMoveHandler(evt) [ Language = javascript ]
Mouse move handler.
• method backgroundMouseUpHandler(evt) [ Language = javascript ]
Mouse up handler.
• method busPartnerClick(partnerName) [ Language = javascript ]
Click on business partner box.
• method calculateHeight(length, width) [ Language = javascript ]
Helper method to calculate appropriate height for online help window
• method changeBusProperty(value) [ Language = javascript ]
Change value of bus property.
• method changeClass() [ Language = javascript ]
Bridge to popup that allows changing the class associated to an item.
• method checkEditDB() [ Language = javascript ]
• method checkHelper(toCheck, noAlert) [ Language = javascript ]
• method checkLostSettings(itemNo) [ Language = javascript ]
Prompt if unsaved settings. Return false if there are unchanged settings and user elected not to continue. Return true otherwise.
• method clearActionTimer() [ Language = javascript ]
• method clearConnectors(config, frame, group) [ Language = javascript ]
Clear connectors for the given item.
• method clearSearch() [ Language = javascript ]
Clear value of Settings search expression
• method connectItems(startNo, endNo) [ Language = javascript ]
Try to make a connection from start item to end item. This works by modifying TargetConfigNames list in the start element.
• method copyItem() [ Language = javascript ]
Copy current item.
• method createEditorComponent(editorContext, ctrlid, form) [ Language = javascript ]
Helper method to create the component specified in editorComponent with the context specified in the editorContext string.
• method createListingText(svg, group, caption, value, size) [ Language = javascript ]
Create a text item on the listing tooltip. Size returns its width and height;
• method ctrlSelectItem(itemNo) [ Language = javascript ]
Select the item with the given id.
• method deleteItem() [ Language = javascript ]
Delete current item.
• method disableComponents() [ Language = javascript ]
Disable setting components when canEdit is false
• method disableMultiItems() [ Language = javascript ]
• method documentProduction() [ Language = javascript ]
User has pressed Document button.
• method drawBus(svg) [ Language = javascript ]
Render config diagram in bus mode.
• method drawDiagram(svg) [ Language = javascript ]
Render the svg diagram.
• method drawDuplBox(itemNo, count) [ Language = javascript ]
• method drawListing(svg) [ Language = javascript ]
Render config diagram in listing mode.
• method drawOverview(svg) [ Language = javascript ]
Render config diagram in monitor/overview mode.
• method enableMultiItems() [ Language = javascript ]
• method endRubberBand() [ Language = javascript ]
End of drag-drop connection.
• method errChangeClass(msg) [ Language = javascript ]
Helper method to display return error (if any) from the ChangeClass popup callback.
• method expandAll(doExpand) [ Language = javascript ]
Clear value of Settings search expression
• method expandoStatesString(form) [ Language = javascript ]
Update the settings form for the given host item.
• method exportItem() [ Language = javascript ]
User has pressed Export item button.
• method findHostObj(itemNo) [ Language = javascript ]
Find the hostObj[][] indices for a given item position.
• method fireTimerAction(code, index) [ Language = javascript ]
• method getComboboxList(list, isRequired) as %String [ Language = javascript ]
Convert a VALUELIST or DISPLAYLIST as used in ObjectScript properties to the format needed for combobox
• method getConnectorInfo(itemNo, inputList, outputList) [ Language = javascript ]
Get the information needed to display connectors for the given item.
itemNo is the index number of the item.
inputList is an array of index numbers of items that connect to the input.
outputList is an array of index numbers of items that connect to the output.
• method getHost(itemNo) [ Language = javascript ]
Return/find the host object given the item number.
• method getNewClass(hostName, hostId, oldClassName, hostType) [ Language = javascript ]
• method getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row. This should be implemented in a subclass.
• method getPolyPath(x1, y1, x2, y2) [ Language = javascript ]
Return a path string that best goes from p1 to p2.
• method getProductionModel(update) [ Language = javascript ]
Return the Production model object.
• method gotoMessageViewer() [ Language = javascript ]
• method grayOutNewButton() as %Boolean [ Language = javascript ]
Gray out "New" button
• classmethod hasDBPermissions(ByRef tOK, ByRef DB As %String = "") as %Status [ ZenMethod ]
• method htmlToTooltip(input) [ Language = javascript ]
Helper method to interpret HTML setting descriptions for display as tooltips
• method importFiletoExportDialog(extfile) [ Language = javascript ]
• method initSecurity() [ Language = javascript ]
• classmethod isTestingEnabled(pProduction) as %Boolean [ ZenMethod ]
Auxiliary method to identify if the Production is configured with TestingEnabled=true.
• method itemClick(evt, itemNo) [ Language = javascript ]
User clicked on an item.
• method itemDblClick(evt, itemNo) [ Language = javascript ]
User double-clicked on an item.
• method itemDotMouseDown(evt, itemNo, canConnect, cx, cy) [ Language = javascript ]
Mouse down on the status dot for an item.
• method itemDotMouseOut(evt, itemNo) [ Language = javascript ]
Mouse out on the status dot for an item.
• method itemDotMouseOver(evt, itemNo, acceptConnect) [ Language = javascript ]
Mouse over on the status dot for an item.
• method itemMouseOut(evt, itemNo) [ Language = javascript ]
• method itemMouseOver(evt, itemNo) [ Language = javascript ]
Mouse over in "dots" view mode.
• method jobAbortMsg() [ Language = javascript ]
• method jobStop() [ Language = javascript ]
• method jobSuspendMsg() [ Language = javascript ]
• method loadProduction() [ Language = javascript ]
Launch the open Production dialog.
• method logout() [ Language = javascript ]
To display a custom message, override logout() and do the unload check ourselves.
• method moveRubberBand(x, y) [ Language = javascript ]
Move edge of drag-drop connection.
• method newExpando(parentForm, category, caption, description, states) [ Language = javascript ]
Create a new expando for the given category
• method newProduction() [ Language = javascript ]
Create a new Production.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method onunloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is unloaded. If this method returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler (if more than one component returns a string, the first one encountered is used).
• method parseParamExpression(paramString) [ Language = javascript ]
Helper method to parse URL parameter expressions for specialised components. The format of the parameters should follow a straightforward key1=value1&key2=value2&... structure, with the additional option of using expressions as part of the values in the key/value pairs supplied from the server.
The supported expressions at present include:
  • $someFunction(args...) - the '$' indicates that zenPage.someFunction(args...) should be executed on the client to get the required value
  • @someVar - the '@' indicates that the value of zenPage.someVar should be used on the client
Note that it is possible to use both replacements in one expression, but the parser does not support more than one such replacement of each type per value expression.
• method queueAbortMsgs() [ Language = javascript ]
• method queueItemClick(row) [ Language = javascript ]
• method recoverProduction() [ Language = javascript ]
recover the Production after a crash
• method rectMouseOut(evt, itemNo, rclass, rclasss) [ Language = javascript ]
• method rectMouseOver(evt, itemNo, rclassh, rclasshs) [ Language = javascript ]
• method redrawItemDuplControl(host) [ Language = javascript ]
Show select control on diagram header offering choice of the duplicate item(s).
• method reexportItem() [ Language = javascript ]
User has pressed Re-Export item button.
• method refreshDiagram() [ Language = javascript ]
Refresh the SVG diagram.
• method refreshDiagramHeaderStates(redocats) [ Language = javascript ]
Update ribbon buttons based on current Production status.
• method refreshHandler() [ Language = javascript ]
Diagram auto-refresh timer handler.
• method refreshLogTab() [ Language = javascript ]
• method refreshQueueTab() [ Language = javascript ]
• method refreshStatusHandler() [ Language = javascript ]
Status indicators auto-refresh timer handler.
• method reloadDiagram() [ Language = javascript ]
Reload diagram with a fresh copy.
• method renderHelpText() [ Language = javascript ]
Helper method to add stuff to dynamically created controls after they are fully materialized
• method restartMultiItems() [ Language = javascript ]
• method restartMultiItemsPart2() [ Language = javascript ]
• method restartRefreshTimer() [ Language = javascript ]
Start refresh timer if Refresh=On.
• method scrollDiagram(row) [ Language = javascript ]
If needed, scroll diagram so that it shows the selected row
• method searchChanged() [ Language = javascript ]
Value of Settings search expression has changed
• method selectCategory(cat) [ Language = javascript ]
User selected a category for the diagram.
• method selectDirectory(controlIndex) [ Language = javascript ]
• method selectFile(controlIndex) [ Language = javascript ]
• method selectItem(itemNo, force, skipSettings) [ Language = javascript ]
Select the item with the given id.
• method selectSettingsDefaults() [ Language = javascript ]
Display the dialog popup to allow selection of settings' defaults.
• method setDisplaySort(sort) [ Language = javascript ]
Set the sort mode for the diagram.
• method setRefreshMode(newMode, notImmediate) [ Language = javascript ]
Turn auto-refresh mode on and off.
• method setShowBy(which) [ Language = javascript ]
Set the sort mode for the diagram.
• method setSortModeHandler(mode) [ Language = javascript ]
Change the current sort mode.
• method setViewModeHandler(mode, oldmode) [ Language = javascript ]
Do the actual work of updating the view to match the current view mode.
• method settingChanged(ctrlIndex, formIndex) [ Language = javascript ]
• method shiftSelectItem(itemNo, ctrlToo) [ Language = javascript ]
Select the item with the given id
• method showConnectors(display, itemNo) [ Language = javascript ]
Show connectors for the given listing item.
• method showConnectorsContd(itemNo, config, frame, group) [ Language = javascript ]
• method showLegend() [ Language = javascript ]
• method showListingTip(itemNo) [ Language = javascript ]
Show mouse tip for given listing item.
• method showMsgBox(pShow) [ Language = javascript ]
Show or hide message box.
• method showProcessDetails(jobID, evt) [ Language = javascript ]
User clicked a link for Process Details Page.
• method showRecoverButton(show) [ Language = javascript ]
Show or hide "Recover" button and set its own color. show=true indicates the button is to be shown, and false to be hidden.
• method showTrace(sessionId, evt) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page.
• method showUpdateButton(show, states) [ Language = javascript ]
Show or hide "Update" button and set its own color. show=true indicates the button is to be shown, and false to be hidden.
• method startActionTimer(timeout, code, index) [ Language = javascript ]
• method startProduction() [ Language = javascript ]
Start the Production.
• method startRubberBand(x, y) [ Language = javascript ]
Beginning of drag-drop connection.
• method startTimers(delay) [ Language = javascript ]
Start timers. The delay is in milliseconds and should be an integer, eg. 2000 for 2000 ms (2 s).
• method stopProduction() [ Language = javascript ]
Stop the Production.
• method stopTimers() [ Language = javascript ]
Stop timers.
• method switchDuplItem() [ Language = javascript ]
In case of duplicate names, handle the switch to a different item.
• method tempRestartItem() [ Language = javascript ]
• method tempStartItem() [ Language = javascript ]
• method tempStopItem() [ Language = javascript ]
• method testItem() [ Language = javascript ]
User has pressed Test item button.
• method toggleSettings() [ Language = javascript ]
Expands and contracts the settings pane, and ensures that the diagram pane is expanded to fill in the space.
• method unselectAll() [ Language = javascript ]
• method unselectItem(itemNo) [ Language = javascript ]
unselect the item with the given id.
• method updateActions(host) [ Language = javascript ]
• method updateDotColor(dot, host) [ Language = javascript ]
Update status indicator color for an item on the diagram (listing view or monitor view).
• method updateExpandoStates(form, states) [ Language = javascript ]
Update the settings form for the given host item.
• method updateHasDups(host) [ Language = javascript ]
• method updateJobs(host) [ Language = javascript ]
Update the instance jobs/processes table for the given host item.
• method updateLog(host) [ Language = javascript ]
Update the event log table for the given host item.
• method updateMessages(host) [ Language = javascript ]
Update the messages table for the given host item.
• method updateModifiedSettings() [ Language = javascript ]
Upon return from select defaults window, update any settings that were reset to default by the user. Returns true is any of the settings was actually reset by the user, otherwise returns false.
• method updateProduction(action) [ Language = javascript ]
This client method handles start / stop / update / recover Production. A popup is displayed containing progress messages.
• method updatePropertySheet(host, skipSettings) [ Language = javascript ]
This is called when a new item is selected. It should update the various property sheets.
• method updatePropertySheetTabs(host, skipSettings) [ Language = javascript ]
Update contents of the tabs
• method updateQueue(host) [ Language = javascript ]
Update the queue table for the current context (Production or item).
• method updateSecurityHelper() [ Language = javascript ]
• method updateSettings(host, searchStr) [ Language = javascript ]
Update the settings form for the given host item.
• method updateView(skipSettings) [ Language = javascript ]
Update diagram.
• method visitQueuesPage() [ Language = javascript ]
Visit queues page