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

Management Portal page for displaying which components reference other components

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 3 40


Summary

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

Properties
%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
ParentURL SearchIn 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
ruleEditorBaseURL 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 DoLogout DoSearchInBackground
DrawBPLRefs DrawDTLRefs DrawDetailsContent DrawHostRefs
DrawLocator DrawRibbon DrawRuleRefs DrawStatus
DrawTitle Encrypt EscapeHTML EscapeURL
EvalResult GetBPLList GetCSPURL GetColumnsAndFrom
GetContextLinks GetDTLList GetDocURL GetFunctionList
GetHL7List GetHomePage GetHyperEventResources GetItemId
GetLUTList GetNewURL GetQuickLinks GetRemoteSearchJob
GetRuleList HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsBPL IsDTL
IsPrivate IsRule IsSearching JavaInstalled
Link OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page PrepareCancel
ProductionExists QuoteJS RegisterRecent RemoveTempData
ResetQuery RewriteURL RunSearch ShowError
SignalCancel SimpleKeepAlive StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL UpdateExpandosHeadings
UpdateStatus 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 delayedAdjustSizes
deleteComponent disableCommandButton displayCountDown doSearch
doShowResults dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal executeSearch 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 openBPL openDTL openProduction
openRule popupActionHandler refreshContents removeChild
removePopupSuffix render renderContents renderSVG
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress selectItem 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 updateResults updateTermOptions warnclickListener


Parameters

• parameter CANCANCELSEARCH = 1;
Indicate if can cancel search.
• parameter PAGENAME = "Interface References";
Displayed name of this page
• parameter RESOURCE = "%Ens_Code:READ";
User needs READ permissions on the %Ens_Code 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 SearchIn as %ZEN.Datatype.string;
result types for latest search
• 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 tempPortalNode as %ZEN.Datatype.string;
This is the temp global used for cancelling search

Methods

• method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
• 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.
• method DoSearchInBackground(pText As %String, pCaseSensitive As %Boolean = 1, pSearchFor As %String = "", pSearchIn As %String = "") [ ZenMethod ]
• method DrawBPLRefs(pSeed) as %Status
• method DrawDTLRefs(pSeed) as %Status
• method DrawHostRefs(pSeed) as %Status
• method DrawRuleRefs(pSeed) as %Status
• method DrawStatus(pSeed) as %Status
• method GetBPLList() as %String [ ZenMethod ]
• method GetDTLList() as %String [ ZenMethod ]
• classmethod GetFunctionList() as %String [ ZenMethod ]
• method GetHL7List() as %String [ ZenMethod ]
• classmethod GetItemId(pProdName, pItemName) as %Integer [ ZenMethod ]
• method GetLUTList() as %String [ ZenMethod ]
• method GetRuleList() as %String [ ZenMethod ]
• classmethod IsBPL(pClassname As %String) as %Boolean [ ZenMethod ]
• method IsDTL(pClassname As %String) as %Boolean [ ZenMethod ]
• classmethod IsRule(pClassname) as %Boolean [ ZenMethod ]
• method IsSearching() as %Boolean [ ZenMethod ]
• 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.
• classmethod ProductionExists(id) as %Boolean [ ZenMethod ]
• classmethod RunSearch(pText As %String, pCaseSensitive As %Boolean = 1, pSearchFor As %String = "", pSearchIn As %String = "", pTempPortalNode As %String) as %Status
• method UpdateExpandosHeadings() [ ZenMethod ]
• method UpdateStatus(pCheckStop As %Boolean = 1) [ ZenMethod ]
• method adjustSizes() [ Language = javascript ]
• method cancelSearch() [ Language = javascript ]
Client side method to invoke the Cancel.
• method delayedAdjustSizes() [ Language = javascript ]
• method doSearch() [ Language = javascript ]
Invoke a search using values from the search form.
• method doShowResults() [ Language = javascript ]
• method formReset() [ Language = javascript ]
Reset the search form fields to blank
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method openBPL(id) [ Language = javascript ]
• method openDTL(id) [ Language = javascript ]
• method openProduction(prodId, item) [ Language = javascript ]
• method openRule(id) [ Language = javascript ]
• method updateResults() [ Language = javascript ]
• method updateTermOptions() [ Language = javascript ]


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