Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [RoutineList]
Private  Storage   

class %CSP.UI.Portal.RoutineList extends %CSP.UI.Template.List

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Zen page for System Management Portal - Routines list

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 8 31


Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource BeginDate ClassURL CurrentColumn
CurrentSort DocPage EndDate ExecuteSpec
FILETYPE Filter FindPage FirstFailed
GlobalURL HelpAddress ISREADONLY InvalidParam
IsEMSReadOnly IsEditForm LocatorHeader MaxRows
NAMESPACE NamespaceList OnclickArray PID
ParentURL RoutineURL ShowGen ShowMap
ShowSys StdTitle TableMaxRows TablePageSize
ValidationErrorMsg aboutPage align aux
backgroundTimerInterval captionLastUpdate cellAlign cellSize
cellStyle cellVAlign children colCode
composite contactPage containerStyle cssLevel
currSortMode currStep currViewMode disabled
dragAndDrop dragEnabled dropEnabled enableAutoRefresh
enclosingClass enclosingStyle error groupClass
groupStyle height hidden hint
hintClass hintStyle home homePage
id index label labelClass
labelDisabledClass labelPosition labelStyle layout
lblTitle limitPopups name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent searchKey showLabel
slice title tuple useSVG
useSoftModals valign visible width
window writePERMISSION zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddLocatorLinks %AddToSaveSet %ApplyURLParms
%Attr %BindExport %ChangeNS %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
%GetNavTableState %GetPageName %GetParameter %GetProductName
%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 BuildMenu BuildMeter
CheckAllBlanks CheckContextLinks CheckEnterpriseManager ConvertParameter
Decrypt Delete DoLogout DrawAutoRefresh
DrawLocator DrawRibbon DrawTableHeader DrawTitle
Encrypt EscapeHTML EscapeURL EvalResult
ExecuteRS FindDBDir FindDBName GetCSPURL
GetContextLinks GetDBList GetDocURL GetExpandState
GetHomePage GetLastSearch GetNSList GetNewURL
GetQuickLinks GetRecentList HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
JavaInstalled LastUpdateTime Link OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page PrepareAction QuoteJS RegisterRecent
RewriteURL SaveExpandState SaveSelections ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL UpdateAutoRefreshRate UpdateAutoRefreshState UpdateTableNavState
UpdateTableState XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
adjustSizes afterSave afterValidate cancelPopup
changePage changePassword checkURLNamespace childrenMutated
codeClicked columnSort correctIELayering createComponent
createComponentNS deleteComponent disableCommandButton doCancel
doCompare doCompile doDelete doDoc
doExport doFind doFullView doImport
doMask doModified doNamespace doSearch
doSelectRow dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal exposeComponent findElement findNSMatch
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getPageTitle getProperty getSelectedNamespace getSettings
getTime getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
hideDoc invokeSuper isButtonDisabled isOfType
keyUp launchPopupWindow logout makeId
navMaxRowsChanged navPageSizeChanged navigate onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onhandleAutoLogoutWarn
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshContents refreshHandler
refreshkeyUp removeChild render renderContents
renderSVG resetMsg saveOptions searchBlur
searchBoxHandler searchFocus searchKeyDown searchKeyPress
setComponentId setConnectivityStatusMsg setHidden setModified
setOverlayMode setPageTitle setProperty setPropertyAll
setRefreshMode setRefreshRate setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showCommandButton showContact showDocumentation showExpand
showHelp showMsg startModal startProgressBar
stopProgressBar switchNamespace toggleDetails toggleSearch
trimSpace updatePreference updateTime updateView
validateRequired zeroFill


Parameters

• parameter AUTONS = 1;
Allow to change namespaces for this page.
• parameter CSPURL = "/csp/sys/exp/%CSP.UI.Portal.RoutineList.zen";
This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
• parameter HELPADDRESS = "Home,Routines";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "RoutineList";
Displayed name of this page.
• parameter RECENT = 0;
If true, register visits to this page in the recent list.
• parameter RESOURCE = "%Development";
Security requirement

Properties

• property CurrentColumn as %ZEN.Datatype.string [ InitialExpression = "Name" ];
• property CurrentSort as %ZEN.Datatype.string [ InitialExpression = "asc" ];
• property ExecuteSpec as %String [ InitialExpression = "*.mac" ];
Actual spec that the query executed
• property FILETYPE as %String [ InitialExpression = "Routine" ];
• property FindPage as %String;
• property NAMESPACE as %String(ZENURL="$NAMESPACE");
• property colCode as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Code") ];
Store translated targetCol linkCaption for
• property writePERMISSION as %ZEN.Datatype.boolean [ InitialExpression = $System.Security.GetRoutinePermission($namespace)["WRITE" ];

Methods

• method %OnAfterCreatePage() as %Status
Subclass to override. Always include code in this method.
• method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
• classmethod Delete(FILETYPE) as %String [ ZenMethod ]
Delete selected routines now.
• method DrawTableHeader(pSeed As %String) as %Status
Draw the contents of the Table Header (the region between the diagram and the table).
• method ExecuteRS(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean
Method for executing the mapping query.
• method GetLastSearch() as %String
• method OnDrawRibbon() as %Status
This is called in the middle of rendering the tool ribbon. Subclasses can inject their own content into the ribbon by writing it out in this method. This content is best wrapped within a single td element. It can also consist of multiple td elements.

To achieve a fixed position for elements within the ribbon, for a fixed width page you can use a single enclosing td that contains a table and a single tr, with td elements inside that single tr that contain your content for the ribbon.

To achieve a fixed position for elements within the ribbon, for a page whose width varies depending on its contents (thereby stretching the ribbon) you can use multiple td elements to contain your content and then a final td element that is empty and has width 40% (or so) to push your contents towards the left and keep them in their proper locations.

• 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 changePage(newPage) [ Language = javascript ]
User clicked Routines or Globals to change page.
• method codeClicked() [ Language = javascript ]
this method is called when user clicked the "Code" link. The value could not be passed with the correct escaping so we have to use the table value here.
• method doCompare() [ Language = javascript ]
if user has selected some routines, pick the first two and pass to the Compare page.
• method doCompile() [ Language = javascript ]
• method doDelete() [ Language = javascript ]
• method doDoc(routineName) [ Language = javascript ]
• method doExport() [ Language = javascript ]
• method doFind(isReplace) [ Language = javascript ]
Open up the Find/Replace CSP page.
• method doFullView(routineName) [ Language = javascript ]
• method doImport() [ Language = javascript ]
• method doMask(nametype) [ Language = javascript ]
User clicked one of the routine name type.
• method doNamespace(selTypeChanged) [ Language = javascript ]
Changed Nemespace <==> Database (implied namespace).
• method doSearch() [ Language = javascript ]
User clicked Go to start search.
• method doSelectRow(routineName) [ Language = javascript ]
• method getSelectedNamespace() [ Language = javascript ]
return true namespace value or implied namespace value.
• method hideDoc() [ Language = javascript ]
• method keyUp(zenEvent) [ Language = javascript ]
Check if user hit [Enter].
• 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 onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
• method saveOptions() [ Language = javascript ]
Generic function to save user input options, called by doNamespace and doSearch, and when chkAlwaysFullView or chkAllowSelectRow is changed.
• method updatePreference() [ Language = javascript ]
• method updateView() [ Language = javascript ]
Update / Reload table. This overrides the one in Template.List.


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