Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsPortal] >  [InterfaceMaps]
Private  Storage   

Management Portal page for displaying the paths a message can take through a production

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 4 31


Summary

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

Properties
%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
ParentURL StdTitle aboutPage align
aux backgroundTimerInterval canEdit cellAlign
cellSize cellStyle cellVAlign children
composite contactPage containerStyle cssLevel
currSortMode currStep currViewMode currentPage
currentPageStart detailsHidden detailsWidth disabled
dragAndDrop dragEnabled dropEnabled enableAutoRefresh
enclosingClass enclosingStyle error groupClass
groupStyle height hidden hideDetailsMsg
hideSearchMsg hint hintClass hintStyle
home homePage id index
isFirstPage isLastPage keepAliveInterval label
labelClass labelDisabledClass labelPosition labelStyle
layout lblDetails lblTitle limitPopups
msgCloseDetail msgNotPermitted name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageId pageModified pageNumberId pageSizeId
parent queryAtEnd resultsTableId searchCriteria
searchJob searchKey searchQuery selectedId
showDetailsMsg showLabel showSearchMsg slice
tablePaneUsesSQLAttrib tempPortalNode title tuple
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%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 %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 %OnGetTableLinkMenu %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
BuildMenu CheckAllBlanks CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt DoExportInBackground DoLogout
DownloadStream DrawDetailsContent DrawLocator DrawRibbon
DrawStatusCircle DrawText DrawTitle Encrypt
EscapeHTML EscapeURL EvalResult GetCSPURL
GetColumnsAndFrom GetContextLinks GetDocURL GetErrValue
GetGlobalRef GetHomePage GetHyperEventResources GetNewURL
GetQuickLinks GetRemoteSearchJob GetTempFileName HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate JavaInstalled Link OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page PrepareCancel QuoteJS RegisterRecent
RemoveTempData ResetQuery RewriteURL ShowError
SignalCancel SimpleKeepAlive StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL UpdateProduction
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addPopupSuffix
adjustExpanderText adjustSizes arrowClick cancelPopup
cancelSearch changePassword changeURLNamespace checkEdit
childrenMutated clientKeepAlive correctIELayering createComponent
createComponentNS createTimeWarning deleteComponent disableCommandButton
displayCountDown doExportStatus doExportToFile doSearch
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler enableCommandButton endModal
executeSearch exportToFile exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
formReset getChildIndex getComponent getComponentById
getContentAreaHeight getEnclosingDiv getHidden getHintElement
getLabelElement getNextData getOpener getPageTitle
getProperty getResultsTable getSearchForm getSettings
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton hideTimeoutWarning
hideWarnContinue inResizeLoop indicateIfCancelled initPopupSuffix
invokeSuper isOfType launchPopupWindow logout
makeId manualKeepAlive navigate onAfterPageChange
onAfterSearch onChangeResultsPage onCreate onDelete
onDisplayHandler onEndModalHandler onEnsException onPopupAction
onRefreshContents onSearchHandler onSelectItem onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
onToggleDetails onToggleSearch ondisabledHandler onhandleAutoLogoutWarn
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshContents removeChild
removePopupSuffix render renderContents renderSVG
resetMsg searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress selectItem sequentialView
setComponentId setConnectivityStatusMsg setHidden setModified
setOverlayMode setPageTitle setProperty setPropertyAll
setSortMode setSortModeHandler setTraceOption setViewMode
setViewModeHandler setWarnInnerHTML showAbout showCommandButton
showContact showDocumentation showHelp showQuery
showTimeoutWarning startKeepAlive startModal startProgressBar
stopKeepAlive stopProgressBar switchNamespace toggleCancelState
toggleDetails toggleSearch toggleSearchState updateNavigationButtons
updatePageData updatePageNumber updatePageSize updateTermOptions
warnclickListener


Parameters

• parameter CANCANCELSEARCH = 1;
Indicate if can cancel search.
• parameter PAGENAME = "Interface Maps";
Displayed name of this page
• parameter RESOURCE = "%Ens_ProductionConfig:READ";
User needs READ permissions on the %Ens_ProductionConfig resource to view this page
• parameter SETUPTEMPPORTALNODE = 1;
Indicate if ought to create tempPortalNode when page created. Used by Cancel feature for example.

Properties

• property detailsWidth as %ZEN.Datatype.integer(MAXVAL=0,MINVAL=0) [ InitialExpression = 0 ];
Value to indicate the percentage of the horizontal screen which should be devoted to the details panel (if it is visible). This is exposed as a client-side property for the layout code to use the value.
• property resultsTableId as %ZEN.Datatype.id [ InitialExpression = "table" ];
Id of the results tablePane

Methods

• method %OnAfterCreatePage() as %Status
Show/hide the toggle buttons
• classmethod %OnFinishBackgroundTask(pTaskID As %String)
This server-side callback method is called whenever the client calls to monitor the current background task and the task is complete. Typically a subclass uses this to send back JavaScript to update the page.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• classmethod %OnMonitorBackgroundTask(pTaskID As %String, pStatus As %String, pPercentComplete As %Float)
This server-side callback method is called whenever the client calls to monitor the current background task. Typically a subclass uses this to send back JavaScript to update a progress bar.
• classmethod DoExportInBackground(filename As %String = "", pSearchTerm As %String = "", pCaseSensitive As %Boolean = 0, pSearchIn As %String = "{""svc"":1,""op"":1,""proc"":1,""rule"":1,""xform"":1}", pCategory As %String = "") as %String [ ZenMethod ]
Save ID values for Resend.
• classmethod DownloadStream(pExportTempFilename As %String = "", pDocName) as %String
• classmethod DrawStatusCircle(pSeed As %String) as %Status
• method DrawText(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
• method GetErrValue() as %String [ ZenMethod ]
• method GetGlobalRef() as %String [ ZenMethod ]
• classmethod GetTempFileName(pDocName As %String = "") as %String [ ZenMethod ]
• method OnDrawRibbon() as %Status
Add export refresh icon
• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
• method RemoveTempData() as %Integer [ ZenMethod ]
Remove Event.
• method UpdateProduction() [ ZenMethod ]
• method adjustSizes() [ Language = javascript ]
• method doExportStatus() [ Language = javascript ]
This method calls server method to get current background event log export job status and update the UI Used if auto refresh off
• method doExportToFile(value) [ Language = javascript ]
• method doSearch() [ Language = javascript ]
Invoke a search using values from the search form.
• method exportToFile() [ Language = javascript ]
• method formReset() [ Language = javascript ]
Reset the search form fields to blank
• method onAfterSearch() [ Language = javascript ]
Display error message if there is one
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when a popup page launched from this page fires an action.
• method onSearchHandler() [ Language = javascript ]
Notify subclass that a search is being executed.
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method resetMsg() [ Language = javascript ]
Clear error message from above results
• method sequentialView(checkForColClick) [ Language = javascript ]
Bring up dialog for the sequential view
• method updateTermOptions() [ Language = javascript ]


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.