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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 9 58


Summary

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

Properties
%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
ParentURL RegistryType StdTitle aboutPage
align aux backgroundTimerInterval canEdit
cellAlign cellSize cellStyle cellVAlign
children composite contactPage containerStyle
cssLevel currSortMode currStep currViewMode
currentPage currentPageStart detailsHidden detailsWidth
disabled displayValues dragAndDrop dragEnabled
dropEnabled enableAutoRefresh enclosingClass enclosingStyle
error extraCriteria 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 searchHidden
searchJob searchKey searchQuery selectedId
showDetailsMsg showLabel showSearchMsg slice
tablePaneUsesSQLAttrib tempPortalNode tipAddCriterion tipAddCriterionTitle
tipAddOR tipAddORTitle 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 DrawDetailsContent
DrawLocator DrawRibbon DrawTitle Encrypt
EscapeHTML EscapeURL EvalResult GetCSPURL
GetColumnsAndFrom GetContextLinks GetDocURL GetHomePage
GetHyperEventResources GetNewURL GetQuickLinks GetRemoteSearchJob
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
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addOR
addPopupSuffix adjustExpanderText arrowClick cancelPopup
cancelSearch changePassword changeURLNamespace changedList
checkEdit checkForChanges childrenMutated clearPageNumber
clientKeepAlive cloneItem correctIELayering createComponent
createComponentNS createTimeWarning deleteAction deleteAttribute
deleteComponent deleteContact deleteFile disableCommandButton
displayCountDown doDelete doSaveAs doSearch
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
drawDisplayValues drawExtendedCriteria dropHandler dropStartHandler
editAction editAttribute editContact editCriterion
editDisplayValues enableCommandButton endModal executeSearch
exposeComponent findElement fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction formReset getBaseItem
getChildIndex getComponent getComponentById getContentAreaHeight
getEnclosingDiv getHidden getHintElement getLabelElement
getNextData getOpener getPageTitle getProperty
getResultsTable getSearchForm getSettings getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage hideCommandButton hideTimeoutWarning hideWarnContinue
importFile inResizeLoop indicateIfCancelled initPopupSuffix
invokeSuper isOfType launchPopupWindow layoutTabGroup
logout makeId manualKeepAlive navigate
newService onAfterPageChange onAfterSearch onChangeResultsPage
onCreate onDelete onDisplayHandler onEndModalHandler
onEnsException onPopupAction onRefreshContents onSearchHandler
onSelectItem onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler onTabChange onToggleDetails
onToggleSearch onUpdate ondisabledHandler onhandleAutoLogoutWarn
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler populateControls popupActionHandler refreshContents
removeChild removeCriterion removePopupSuffix render
renderActionsTable renderAttributesTable renderContactsTable renderContents
renderFilesTable renderSVG rowSelected rowUnSelected
saveChanges searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress selectItem selectRow
setComponentId setConnectivityStatusMsg setHidden setModified
setOverlayMode setPageModified setPageTitle setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler setWarnInnerHTML shiftCriterion
showAbout showCommandButton showContact showDocumentation
showHelp showQuery showTimeoutWarning startKeepAlive
startModal startProgressBar stopKeepAlive stopProgressBar
switchNamespace toggleCancelState toggleCriterion toggleDetails
toggleSearch toggleSearchState updateActions updateNavigationButtons
updatePageData updatePageNumber updatePageSize viewFile
warnclickListener

Subclasses

Parameters

• parameter JSINCLUDES = "ensemble/Ensemble_Utils.js";
Comma-separated list of additional JS include files for the page.
• parameter RegistryType;
Is this this Public or External Registry?

Properties

• property RegistryType as %ZEN.Datatype.string [ Final,InitialExpression = ..#RegistryType ];
Is this this Public or External Registry?
• property displayValues as %List;
• property extraCriteria as %ZEN.Datatype.string;
• property searchCriteria as %ZEN.proxyObject;
Search criteria from the client.
This is a proxy object whose contents are filled in from the search form by the doSearch method. It is expected that the search query will use this information to determine what results to display.
• property searchHidden as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether the searchPanel is currently hidden.
• property tipAddCriterion as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Add Criterion") ];
• property tipAddCriterionTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Add a new criterion") ];
• property tipAddOR as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Add OR") ];
• property tipAddORTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Add an OR condition") ];

Methods

• method %OnAfterCreatePage() as %Status
Show/hide the toggle buttons
• method %OnDrawObjectProperties()
For dealing with the extraCriteria property
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• method %OnZENDeserialize() as %Status
For dealing with the extraCriteria property
• 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 addOR() [ Language = javascript ]
• method changedList(currList, propName) [ Language = javascript ]
Check to see if items in a list property have changed since opening the current service
• method checkForChanges(obj, propName, changed) [ Language = javascript ]
Check to see if any properties of the current service have been changed since opening the current service (note that service re-opens on saving)
• method clearPageNumber() [ Language = javascript ]
• method cloneItem(obj) [ Language = javascript ]
• method deleteAction(key) [ Language = javascript ]
• method deleteAttribute(key) [ Language = javascript ]
• method deleteContact(key) [ Language = javascript ]
• method deleteFile(key) [ Language = javascript ]
• method doDelete() [ Language = javascript ]
Delete the selected service or client from the registry
• method doSaveAs() [ Language = javascript ]
• method doSearch() [ Language = javascript ]
Invoke a search using values from the search form.
• method drawDisplayValues() [ Language = javascript ]
Client-side method to render the display value expando.
• method drawExtendedCriteria() [ Language = javascript ]
Client-side method to render the extended criteria expando.
• method editAction(key) [ Language = javascript ]
Launch the actions dialog
• method editAttribute(key) [ Language = javascript ]
Launch the attributes dialog
• method editContact(key) [ Language = javascript ]
Launch the contact properties dialog.
• method editCriterion(k) [ Language = javascript ]
• method editDisplayValues() [ Language = javascript ]
• method formReset() [ Language = javascript ]
Reset the search form fields to defaults and perform search
• method getBaseItem(propName) [ Language = javascript ]
• method getNextData(next) [ Language = javascript ]
User clicked the Next Page or Previous Page button
• method getSearchForm() [ Language = javascript ]
Return the search form object.
• method importFile(key) [ Language = javascript ]
Launch file viewer dialog.
• method layoutTabGroup() [ Language = javascript ]
Handle the client-side rendering the of the right hand pane.
• method newService() [ Language = javascript ]
Open New Service dialog to register a new service in the registry
• method onPopupAction(popupName, action, value) [ Language = javascript ]
Subclass need to include the case "switchNamespace" if it is enabling "Switch" next to namespace.
• method onSearchHandler() [ Language = javascript ]
User clicked the Search button
• method onSelectItem() [ Language = javascript ]
populate detailTable for the selected row or no selected row
• method onSerialize() [ Language = javascript ]
For dealing with the extraCriteria property
• method onTabChange() [ Language = javascript ]
User clicked on a tab, or selected a new item, so we need to fetch the required content from the server.
• method onUpdate(table) [ Language = javascript ]
override resultsTable TablePane methods
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page. Do this differently for Registry than for other children of EnsPortal.Template.viewerPage (hence the override). In this case the details pane does NOT get large when the search pane is minimized.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method onlogoutHandler() [ Language = javascript ]
This client method, if defined and the AUTOLOGOUT parameter for this page is true, is invoked when the logout timer for this page fires.
If this method return true then the normal page logout behavior will fire. That is, the page will be reloaded causing a login page to appear if the current session has ended.
• 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 populateControls(obj, propName) [ Language = javascript ]
• method removeCriterion(k) [ Language = javascript ]
• method renderActionsTable() [ Language = javascript ]
Update the contents of the actions table
• method renderAttributesTable() [ Language = javascript ]
Update the contents of the Attributes table.
• method renderContactsTable() [ Language = javascript ]
Update the contents of the Contacts table.
• method renderFilesTable() [ Language = javascript ]
Update the contents of the files table
• method rowSelected(table) [ Language = javascript ]
User selected a row in the table
• method rowUnSelected(table) [ Language = javascript ]
User unselected a row in the table
• method saveChanges(obj, propName) [ Language = javascript ]
Save all properties to the current Client object
• method selectRow(row, scroll, which) [ Language = javascript ]
Overrides TablePane method
• method setPageModified() [ Language = javascript ]
• method shiftCriterion(k, direction) [ Language = javascript ]
• method toggleCriterion(k, enabled) [ Language = javascript ]
• method updateActions() [ Language = javascript ]
• method updateNavigationButtons() [ Language = javascript ]
Ensure that the "Next" and "Previous" buttons behave correctly based on the data returned from the current search.
• method updatePageSize() [ Language = javascript ]
Bring the maxRows property of the tablePane into line with the current page size.
• method viewFile(key) [ Language = javascript ]
Launch file viewer dialog.


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