Skip to main content


class EnsPortal.ProductionConfig extends EnsPortal.Template.prodConfigSCPage, EnsPortal.Util.PageLinks

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

Property Inventory

Method Inventory


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 methods: OSDisplayToLogical(), OSGet(), OSIsValid(), OSLogicalToDisplay(), OSLogicalToOdbc(), OSNormalize(), OSSet()
property busProperty as %ZEN.Datatype.string [ InitialExpression = "busPartner" ];
Specifies what property is used to draw the bus diagram.
Property methods: busPropertyDisplayToLogical(), busPropertyGet(), busPropertyIsValid(), busPropertyLogicalToDisplay(), busPropertyLogicalToOdbc(), busPropertyNormalize(), busPropertySet()
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 methods: canEditDBDisplayToLogical(), canEditDBGet(), canEditDBIsValid(), canEditDBLogicalToDisplay(), canEditDBLogicalToOdbc(), canEditDBLogicalToXSD(), canEditDBNormalize(), canEditDBSet(), canEditDBXSDToLogical()
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()
property canViewMessageTrace as %Boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];
Is the user permitted to view Message Trace
Property methods: canViewMessageTraceDisplayToLogical(), canViewMessageTraceGet(), canViewMessageTraceIsValid(), canViewMessageTraceLogicalToDisplay(), canViewMessageTraceLogicalToXSD(), canViewMessageTraceNormalize(), canViewMessageTraceSet(), canViewMessageTraceXSDToLogical()
property canViewProcessDetails as %Boolean [ InitialExpression = $system.Security.Check("%Admin_Operate","USE") ];
Is the user permitted to view Process Details
Property methods: canViewProcessDetailsDisplayToLogical(), canViewProcessDetailsGet(), canViewProcessDetailsIsValid(), canViewProcessDetailsLogicalToDisplay(), canViewProcessDetailsLogicalToXSD(), canViewProcessDetailsNormalize(), canViewProcessDetailsSet(), canViewProcessDetailsXSDToLogical()
property currCategory as %String;
Current selected Category.
Property methods: currCategoryDisplayToLogical(), currCategoryGet(), currCategoryIsValid(), currCategoryLogicalToDisplay(), currCategoryLogicalToOdbc(), currCategoryNormalize(), currCategorySet()
property currItem as %Integer [ InitialExpression = -1 ];
Index number of current selected item.
Property methods: currItemDisplayToLogical(), currItemGet(), currItemIsValid(), currItemLogicalToDisplay(), currItemNormalize(), currItemSet(), currItemXSDToLogical()
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 methods: currRestartItemDisplayToLogical(), currRestartItemGet(), currRestartItemIsValid(), currRestartItemLogicalToDisplay(), currRestartItemNormalize(), currRestartItemSet(), currRestartItemXSDToLogical()
property currRestartName as %String;
Used to validate that when restarting the item after a disable the item number has not changed.
Property methods: currRestartNameDisplayToLogical(), currRestartNameGet(), currRestartNameIsValid(), currRestartNameLogicalToDisplay(), currRestartNameLogicalToOdbc(), currRestartNameNormalize(), currRestartNameSet()
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 methods: currTabNoDisplayToLogical(), currTabNoGet(), currTabNoIsValid(), currTabNoLogicalToDisplay(), currTabNoNormalize(), currTabNoSet(), currTabNoXSDToLogical()
property dbIsRO as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate if the default db is mounted R/O
Property methods: dbIsRODisplayToLogical(), dbIsROGet(), dbIsROIsValid(), dbIsROLogicalToDisplay(), dbIsROLogicalToOdbc(), dbIsROLogicalToXSD(), dbIsRONormalize(), dbIsROSet(), dbIsROXSDToLogical()
property deploymentFile as %ZEN.Datatype.string;
Name of existing deployment export file (on server).
Property methods: deploymentFileDisplayToLogical(), deploymentFileGet(), deploymentFileIsValid(), deploymentFileLogicalToDisplay(), deploymentFileLogicalToOdbc(), deploymentFileNormalize(), deploymentFileSet()
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 methods: isWin64DisplayToLogical(), isWin64Get(), isWin64IsValid(), isWin64LogicalToDisplay(), isWin64LogicalToOdbc(), isWin64LogicalToXSD(), isWin64Normalize(), isWin64Set(), isWin64XSDToLogical()
property msgGoToEventLog as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Go To Event Log") ];
Property methods: msgGoToEventLogDisplayToLogical(), msgGoToEventLogGet(), msgGoToEventLogIsValid(), msgGoToEventLogLogicalToDisplay(), msgGoToEventLogLogicalToOdbc(), msgGoToEventLogNormalize(), msgGoToEventLogSet()
property msgGoToJobs as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Go To Jobs") ];
Property methods: msgGoToJobsDisplayToLogical(), msgGoToJobsGet(), msgGoToJobsIsValid(), msgGoToJobsLogicalToDisplay(), msgGoToJobsLogicalToOdbc(), msgGoToJobsNormalize(), msgGoToJobsSet()
property msgGoToMessageViewer as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Go To Message Viewer") ];
Property methods: msgGoToMessageViewerDisplayToLogical(), msgGoToMessageViewerGet(), msgGoToMessageViewerIsValid(), msgGoToMessageViewerLogicalToDisplay(), msgGoToMessageViewerLogicalToOdbc(), msgGoToMessageViewerNormalize(), msgGoToMessageViewerSet()
property msgGoToQueues as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Go To Queues") ];
Property methods: msgGoToQueuesDisplayToLogical(), msgGoToQueuesGet(), msgGoToQueuesIsValid(), msgGoToQueuesLogicalToDisplay(), msgGoToQueuesLogicalToOdbc(), msgGoToQueuesNormalize(), msgGoToQueuesSet()
property msgLoading as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Loading...") ];
Property methods: msgLoadingDisplayToLogical(), msgLoadingGet(), msgLoadingIsValid(), msgLoadingLogicalToDisplay(), msgLoadingLogicalToOdbc(), msgLoadingNormalize(), msgLoadingSet()
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 methods: msgNoDBPermissionsDisplayToLogical(), msgNoDBPermissionsGet(), msgNoDBPermissionsIsValid(), msgNoDBPermissionsLogicalToDisplay(), msgNoDBPermissionsLogicalToOdbc(), msgNoDBPermissionsNormalize(), msgNoDBPermissionsSet()
property msgSDSEnabledOverridden as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("The production definition Enabled setting for this item is currently specified using a System Default Setting. Either use the temporary Stop,Start Actions buttons or modify the appropriate System Default Setting.") ];
Property methods: msgSDSEnabledOverriddenDisplayToLogical(), msgSDSEnabledOverriddenGet(), msgSDSEnabledOverriddenIsValid(), msgSDSEnabledOverriddenLogicalToDisplay(), msgSDSEnabledOverriddenLogicalToOdbc(), msgSDSEnabledOverriddenNormalize(), msgSDSEnabledOverriddenSet()
property msgSDSOverridden as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("This core setting is currently specified using a System Default Setting. Modify or delete the appropriate System Default Setting to change this setting.") ];
Property methods: msgSDSOverriddenDisplayToLogical(), msgSDSOverriddenGet(), msgSDSOverriddenIsValid(), msgSDSOverriddenLogicalToDisplay(), msgSDSOverriddenLogicalToOdbc(), msgSDSOverriddenNormalize(), msgSDSOverriddenSet()
property multiItems as array of %Integer;
Property methods: multiItemsBuildValueArray(), multiItemsCollectionToDisplay(), multiItemsCollectionToOdbc(), multiItemsDisplayToCollection(), multiItemsDisplayToLogical(), multiItemsGet(), multiItemsGetObject(), multiItemsGetObjectId(), multiItemsGetSwizzled(), multiItemsIsValid(), multiItemsLogicalToDisplay(), multiItemsNormalize(), multiItemsOdbcToCollection(), multiItemsSet(), multiItemsSetObject(), multiItemsSetObjectId(), multiItemsXSDToLogical()
property productionId as %String [ InitialExpression = ..GetCurrentProduction() ];
ID of Production to display.
Property methods: productionIdDisplayToLogical(), productionIdGet(), productionIdIsValid(), productionIdLogicalToDisplay(), productionIdLogicalToOdbc(), productionIdNormalize(), productionIdSet()
property productionIdURL as %String (ZENURL = "PRODUCTION");
ID of Production passed in the URL.
Property methods: productionIdURLDisplayToLogical(), productionIdURLGet(), productionIdURLIsValid(), productionIdURLLogicalToDisplay(), productionIdURLLogicalToOdbc(), productionIdURLNormalize(), productionIdURLSet()
property queueCount as array of %Integer;
Array of queue counts to keep track of queue growth across refreshes
Property methods: queueCountBuildValueArray(), queueCountCollectionToDisplay(), queueCountCollectionToOdbc(), queueCountDisplayToCollection(), queueCountDisplayToLogical(), queueCountGet(), queueCountGetObject(), queueCountGetObjectId(), queueCountGetSwizzled(), queueCountIsValid(), queueCountLogicalToDisplay(), queueCountNormalize(), queueCountOdbcToCollection(), queueCountSet(), queueCountSetObject(), queueCountSetObjectId(), queueCountXSDToLogical()
property refreshMode as %Boolean [ InitialExpression = 0 ];
Current refresh mode.
Property methods: refreshModeDisplayToLogical(), refreshModeGet(), refreshModeIsValid(), refreshModeLogicalToDisplay(), refreshModeLogicalToXSD(), refreshModeNormalize(), refreshModeSet(), refreshModeXSDToLogical()
property securityHelper as %ZEN.proxyObject;
Zen proxy object to help determine what actions a user may take on the page.
Property methods: securityHelperGet(), securityHelperGetSwizzled(), securityHelperIsValid(), securityHelperNewObject(), securityHelperSet()
property selectedHost as %String (ZENURL = "HOST");
Name of selected host passed in the URL to be initially selected on the diagram
Property methods: selectedHostDisplayToLogical(), selectedHostGet(), selectedHostIsValid(), selectedHostLogicalToDisplay(), selectedHostLogicalToOdbc(), selectedHostNormalize(), selectedHostSet()
property settingsHidden as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether the settingsPanel is currently hidden.
Property methods: settingsHiddenDisplayToLogical(), settingsHiddenGet(), settingsHiddenIsValid(), settingsHiddenLogicalToDisplay(), settingsHiddenLogicalToOdbc(), settingsHiddenLogicalToXSD(), settingsHiddenNormalize(), settingsHiddenSet(), settingsHiddenXSDToLogical()
property tabFontSizeForGerman as %String [ InitialExpression = $S(%session.Language="de":"td.tabGroupButtonOn, td.tabGroupButtonOff, td.tabGroupButtonDisabled { font-size: 12px; }", 1:"") ];
Property methods: tabFontSizeForGermanDisplayToLogical(), tabFontSizeForGermanGet(), tabFontSizeForGermanIsValid(), tabFontSizeForGermanLogicalToDisplay(), tabFontSizeForGermanLogicalToOdbc(), tabFontSizeForGermanNormalize(), tabFontSizeForGermanSet()
property visualAid as %String (ZENURL = "VISUALAID");
visual aid
Property methods: visualAidDisplayToLogical(), visualAidGet(), visualAidIsValid(), visualAidLogicalToDisplay(), visualAidLogicalToOdbc(), visualAidNormalize(), visualAidSet()


method %OnAfterCreatePage() as %Status
Inherited description: Decorate the page.
classmethod %OnBeforeCreatePage() as %Status
Inherited description: This class method callback is called just before the server-side page object is created.
method %OnDrawHTMLHead() as %Status
Inherited description: 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 ]
clientmethod 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 %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.
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 ]
clientmethod addItem(type) [ Language = javascript ]
User has pressed add item command - show corresponding add host wizard dialog.
clientmethod adjustSizes(doSettings, adjustEvenIfSameSize) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod applyChanges(noUpdate, noConfirmation) [ Language = javascript ]
Apply changes to current item.
clientmethod backgroundMouseMoveHandler(evt) [ Language = javascript ]
Mouse move handler.
clientmethod backgroundMouseUpHandler(evt) [ Language = javascript ]
Mouse up handler.
clientmethod busPartnerClick(partnerName) [ Language = javascript ]
Click on business partner box.
clientmethod calculateHeight(length, width) [ Language = javascript ]
Helper method to calculate appropriate height for online help window
clientmethod changeApplyStyle(event) [ Language = javascript ]
Assumes parameter is a CustomEvent with detail properties of hostid and unappliedChanges
clientmethod changeBusProperty(value) [ Language = javascript ]
Change value of bus property.
clientmethod changeClass() [ Language = javascript ]
Bridge to popup that allows changing the class associated to an item.
clientmethod checkEditDB() [ Language = javascript ]
clientmethod checkHelper(toCheck, noAlert) [ Language = javascript ]
clientmethod checkLostSettings(itemNo) [ Language = javascript ]
Prompt if unsaved settings. Return false if there are unchanged settings and user elected not to continue. Return true otherwise.
clientmethod clearActionTimer() [ Language = javascript ]
clientmethod clearConnectors(config, frame, group) [ Language = javascript ]
Clear connectors for the given item.
clientmethod clearSearch() [ Language = javascript ]
Clear value of Settings search expression
clientmethod 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.
clientmethod copyItem() [ Language = javascript ]
Copy current item.
clientmethod createEditorComponent(editorContext, ctrlid, form) [ Language = javascript ]
Helper method to create the component specified in editorComponent with the context specified in the editorContext string.
clientmethod createListingText(svg, group, caption, value, size) [ Language = javascript ]
Create a text item on the listing tooltip. Size returns its width and height;
clientmethod ctrlSelectItem(itemNo) [ Language = javascript ]
Select the item with the given id.
clientmethod deleteItem() [ Language = javascript ]
Delete current item.
clientmethod disableComponents() [ Language = javascript ]
Disable setting components when canEdit is false
clientmethod disableMultiItems() [ Language = javascript ]
clientmethod documentProduction() [ Language = javascript ]
User has pressed Document button.
clientmethod drawBus(svg) [ Language = javascript ]
Render config diagram in bus mode.
clientmethod drawDiagram(svg) [ Language = javascript ]
Render the svg diagram.
clientmethod drawDuplBox(itemNo, count) [ Language = javascript ]
clientmethod drawListing(svg) [ Language = javascript ]
Render config diagram in listing mode.
clientmethod drawOverview(svg) [ Language = javascript ]
Render config diagram in monitor/overview mode.
clientmethod enableMultiItems() [ Language = javascript ]
clientmethod endRubberBand() [ Language = javascript ]
End of drag-drop connection.
clientmethod errChangeClass(msg) [ Language = javascript ]
Helper method to display return error (if any) from the ChangeClass popup callback.
clientmethod expandAll(doExpand) [ Language = javascript ]
Clear value of Settings search expression
clientmethod expandoStatesString(form) [ Language = javascript ]
Update the settings form for the given host item.
clientmethod exportItem() [ Language = javascript ]
User has pressed Export item button.
clientmethod findHostObj(itemNo) [ Language = javascript ]
Find the hostObj[][] indices for a given item position.
clientmethod fireTimerAction(code, index) [ Language = javascript ]
clientmethod getComboboxList(list, isRequired) as %String [ Language = javascript ]
Convert a VALUELIST or DISPLAYLIST as used in ObjectScript properties to the format needed for combobox
clientmethod 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.
clientmethod getHost(itemNo) [ Language = javascript ]
Return/find the host object given the item number.
clientmethod getNewClass(hostName, hostId, oldClassName, hostType) [ Language = javascript ]
clientmethod getPageTitle() as %String [ Language = javascript ]
Inherited description: Get the title string to add to the locator row. This should be implemented in a subclass.
clientmethod getPolyPath(x1, y1, x2, y2) [ Language = javascript ]
Return a path string that best goes from p1 to p2.
clientmethod getProductionModel(update) [ Language = javascript ]
Return the Production model object.
clientmethod gotoMessageViewer() [ Language = javascript ]
clientmethod grayOutNewButton() as %Boolean [ Language = javascript ]
Gray out "New" button
classmethod hasDBPermissions(ByRef tOK, ByRef DB As %String = "") as %Status [ ZenMethod ]
clientmethod htmlToTooltip(input) [ Language = javascript ]
Helper method to interpret HTML setting descriptions for display as tooltips
clientmethod importFiletoExportDialog(extfile) [ Language = javascript ]
clientmethod initSecurity() [ Language = javascript ]
classmethod isTestingEnabled(pProduction) as %Boolean [ ZenMethod ]
Auxiliary method to identify if the Production is configured with TestingEnabled=true.
clientmethod itemClick(evt, itemNo) [ Language = javascript ]
User clicked on an item.
clientmethod itemDblClick(evt, itemNo) [ Language = javascript ]
User double-clicked on an item.
clientmethod itemDotMouseDown(evt, itemNo, canConnect, cx, cy) [ Language = javascript ]
Mouse down on the status dot for an item.
clientmethod itemDotMouseOut(evt, itemNo) [ Language = javascript ]
Mouse out on the status dot for an item.
clientmethod itemDotMouseOver(evt, itemNo, acceptConnect) [ Language = javascript ]
Mouse over on the status dot for an item.
clientmethod itemMouseOut(evt, itemNo) [ Language = javascript ]
clientmethod itemMouseOver(evt, itemNo) [ Language = javascript ]
Mouse over in "dots" view mode.
clientmethod jobAbortMsg() [ Language = javascript ]
clientmethod jobStop() [ Language = javascript ]
clientmethod jobSuspendMsg() [ Language = javascript ]
clientmethod loadProduction() [ Language = javascript ]
Launch the open Production dialog.
clientmethod logout() [ Language = javascript ]
To display a custom message, override logout() and do the unload check ourselves.
clientmethod moveRubberBand(x, y) [ Language = javascript ]
Move edge of drag-drop connection.
clientmethod newExpando(parentForm, category, caption, description, states) [ Language = javascript ]
Create a new expando for the given category
clientmethod newProduction() [ Language = javascript ]
Create a new Production.
clientmethod notifypageModifiedSet(isModified, hostid) [ Language = javascript ]
Send event that settings has applied or unapplied changes in order to modify Apply button style
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod onloadHandler() [ Language = javascript ]
Add event to handle changing Apply button style
clientmethod onunloadHandler() [ Language = javascript ]
Inherited description: 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).
clientmethod 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.
clientmethod queueAbortMsgs() [ Language = javascript ]
clientmethod queueItemClick(row) [ Language = javascript ]
clientmethod recoverProduction() [ Language = javascript ]
recover the Production after a crash
clientmethod rectMouseOut(evt, itemNo, rclass, rclasss) [ Language = javascript ]
clientmethod rectMouseOver(evt, itemNo, rclassh, rclasshs) [ Language = javascript ]
clientmethod redrawItemDuplControl(host) [ Language = javascript ]
Show select control on diagram header offering choice of the duplicate item(s).
clientmethod reexportItem() [ Language = javascript ]
User has pressed Re-Export item button.
clientmethod refreshDiagram() [ Language = javascript ]
Refresh the SVG diagram.
clientmethod refreshDiagramHeaderStates(redocats) [ Language = javascript ]
Update ribbon buttons based on current Production status.
clientmethod refreshHandler() [ Language = javascript ]
Diagram auto-refresh timer handler.
clientmethod refreshLogTab() [ Language = javascript ]
clientmethod refreshQueueTab() [ Language = javascript ]
clientmethod refreshStatusHandler() [ Language = javascript ]
Status indicators auto-refresh timer handler.
clientmethod reloadDiagram() [ Language = javascript ]
Reload diagram with a fresh copy.
clientmethod renderHelpText() [ Language = javascript ]
Helper method to add stuff to dynamically created controls after they are fully materialized
clientmethod restartMultiItems() [ Language = javascript ]
clientmethod restartMultiItemsPart2() [ Language = javascript ]
clientmethod restartRefreshTimer() [ Language = javascript ]
Start refresh timer if Refresh=On.
clientmethod scrollDiagram(row) [ Language = javascript ]
If needed, scroll diagram so that it shows the selected row
clientmethod searchChanged() [ Language = javascript ]
Value of Settings search expression has changed
clientmethod selectCategory(cat) [ Language = javascript ]
User selected a category for the diagram.
clientmethod selectDirectory(controlIndex) [ Language = javascript ]
clientmethod selectFile(controlIndex) [ Language = javascript ]
clientmethod selectItem(itemNo, force, skipSettings) [ Language = javascript ]
Select the item with the given id.
clientmethod selectParam(controlIndex, parms) [ Language = javascript ]
clientmethod selectSettingsDefaults() [ Language = javascript ]
Display the dialog popup to allow selection of settings' defaults.
clientmethod setDisplaySort(sort) [ Language = javascript ]
Set the sort mode for the diagram.
clientmethod setRefreshMode(newMode, notImmediate) [ Language = javascript ]
Turn auto-refresh mode on and off.
clientmethod setShowBy(which) [ Language = javascript ]
Set the sort mode for the diagram.
clientmethod setSortModeHandler(mode) [ Language = javascript ]
Change the current sort mode.
clientmethod setViewModeHandler(mode, oldmode) [ Language = javascript ]
Do the actual work of updating the view to match the current view mode.
clientmethod settingChanged(ctrlIndex, formIndex) [ Language = javascript ]
clientmethod shiftSelectItem(itemNo, ctrlToo) [ Language = javascript ]
Select the item with the given id
clientmethod showConnectors(display, itemNo) [ Language = javascript ]
Show connectors for the given listing item.
clientmethod showConnectorsContd(itemNo, config, frame, group) [ Language = javascript ]
clientmethod showLegend() [ Language = javascript ]
clientmethod showListingTip(itemNo) [ Language = javascript ]
Show mouse tip for given listing item.
clientmethod showMsgBox(pShow) [ Language = javascript ]
Show or hide message box.
clientmethod showProcessDetails(jobID, evt) [ Language = javascript ]
User clicked a link for Process Details Page.
clientmethod 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.
clientmethod showTrace(sessionId, evt) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page.
clientmethod 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.
clientmethod startActionTimer(timeout, code, index) [ Language = javascript ]
clientmethod startProduction() [ Language = javascript ]
Start the Production.
clientmethod startRubberBand(x, y) [ Language = javascript ]
Beginning of drag-drop connection.
clientmethod startTimers(delay) [ Language = javascript ]
Start timers. The delay is in milliseconds and should be an integer, eg. 2000 for 2000 ms (2 s).
clientmethod stopProduction() [ Language = javascript ]
Stop the Production.
clientmethod stopTimers() [ Language = javascript ]
Stop timers.
clientmethod switchDuplItem() [ Language = javascript ]
In case of duplicate names, handle the switch to a different item.
clientmethod tempRestartItem() [ Language = javascript ]
clientmethod tempStartItem() [ Language = javascript ]
clientmethod tempStopItem() [ Language = javascript ]
clientmethod testItem() [ Language = javascript ]
User has pressed Test item button.
clientmethod toggleSettings() [ Language = javascript ]
Expands and contracts the settings pane, and ensures that the diagram pane is expanded to fill in the space.
clientmethod unselectAll() [ Language = javascript ]
clientmethod unselectItem(itemNo) [ Language = javascript ]
unselect the item with the given id.
clientmethod updateActions(host) [ Language = javascript ]
clientmethod updateDotColor(dot, host) [ Language = javascript ]
Update status indicator color for an item on the diagram (listing view or monitor view).
clientmethod updateExpandoStates(form, states) [ Language = javascript ]
Update the settings form for the given host item.
clientmethod updateHasDups(host) [ Language = javascript ]
clientmethod updateJobs(host) [ Language = javascript ]
Update the instance jobs/processes table for the given host item.
clientmethod updateLog(host) [ Language = javascript ]
Update the event log table for the given host item.
clientmethod updateMessages(host) [ Language = javascript ]
Update the messages table for the given host item.
clientmethod 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.
clientmethod updateProduction(action) [ Language = javascript ]
This client method handles start / stop / update / recover Production. A popup is displayed containing progress messages.
clientmethod updatePropertySheet(host, skipSettings) [ Language = javascript ]
This is called when a new item is selected. It should update the various property sheets.
clientmethod updatePropertySheetTabs(host, skipSettings) [ Language = javascript ]
Update contents of the tabs
clientmethod updateQueue(host) [ Language = javascript ]
Update the queue table for the current context (Production or item).
clientmethod updateSecurityHelper() [ Language = javascript ]
clientmethod updateSettings(host, searchStr) [ Language = javascript ]
Update the settings form for the given host item.
clientmethod updateView(skipSettings) [ Language = javascript ]
Update diagram.
clientmethod visitQueuesPage() [ Language = javascript ]
Visit queues page

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab