Home > Class Reference > %SYS namespace > %CSP.UI.Portal.GlobalList

%CSP.UI.Portal.GlobalList

class %CSP.UI.Portal.GlobalList 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 - Global list

Property Inventory

Method Inventory

Parameters

parameter AUTONS = 1;
Allow to change namespaces for this page.
parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.GlobalList.zen;
Inherited description: 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,Globals;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = GlobalList;
Displayed name of this page.
parameter RESOURCE = %Development;
Security requirement

Properties

property FILETYPE as %String [ InitialExpression = "Global" ];
Property methods: FILETYPEDisplayToLogical(), FILETYPEGet(), FILETYPEIsValid(), FILETYPELogicalToDisplay(), FILETYPELogicalToOdbc(), FILETYPENormalize(), FILETYPESet()
property FindPage as %String;
Property methods: FindPageDisplayToLogical(), FindPageGet(), FindPageIsValid(), FindPageLogicalToDisplay(), FindPageLogicalToOdbc(), FindPageNormalize(), FindPageSet()
property GlobalSpec as %String [ InitialExpression = "*" ];
Property methods: GlobalSpecDisplayToLogical(), GlobalSpecGet(), GlobalSpecIsValid(), GlobalSpecLogicalToDisplay(), GlobalSpecLogicalToOdbc(), GlobalSpecNormalize(), GlobalSpecSet()
property NAMESPACE as %String (ZENURL = "$NAMESPACE");
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()
property ViewGlobalURL as %String;
Property methods: ViewGlobalURLDisplayToLogical(), ViewGlobalURLGet(), ViewGlobalURLIsValid(), ViewGlobalURLLogicalToDisplay(), ViewGlobalURLLogicalToOdbc(), ViewGlobalURLNormalize(), ViewGlobalURLSet()
property writePERMISSION as %ZEN.Datatype.boolean [ InitialExpression = $System.Security.GetGlobalPermission($namespace) [ "WRITE" ];
Property methods: writePERMISSIONDisplayToLogical(), writePERMISSIONGet(), writePERMISSIONIsValid(), writePERMISSIONLogicalToDisplay(), writePERMISSIONLogicalToOdbc(), writePERMISSIONLogicalToXSD(), writePERMISSIONNormalize(), writePERMISSIONSet(), writePERMISSIONXSDToLogical()

Methods

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Subclass to override. Always include code in this method.
method %OnGetPageName() as %String [ Language = objectscript ]
Get the (localized) name of the page. This should be implemented in a subclass.
method CreateRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet [ Language = objectscript ]
pInfo holds details on how to create the query.
classmethod Delete(filetype) as %String [ Language = objectscript, ZenMethod ]
Delete selected globals now.
method DrawTableHeader(pSeed As %String) as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
Method for executing the global query.
method GetLastSearch() as %String [ Language = objectscript ]
classmethod GetList() as %String [ Language = objectscript, ZenMethod ]
Return Namespace list for UI's valueList.
method OnDrawRibbon() as %Status [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
Get information to display in the ribbon bar.
classmethod PrepareSelection(pFILETYPE, pSelectedRows) as %String [ Language = objectscript, ZenMethod ]
Pad selected items into string delimited by "^" before calling PrepareAction.
clientmethod changePage(newPage) [ Language = javascript ]
clientmethod doDelete() [ Language = javascript ]
clientmethod doEdit(globalName) [ Language = javascript ]
clientmethod doExport() [ Language = javascript ]
clientmethod doFind(isReplace) [ Language = javascript ]
Open up the Find/Replace CSP page.
clientmethod doImport() [ Language = javascript ]
clientmethod doList(nd) [ Language = javascript ]
Load Nemespace list or Database list
clientmethod doNamespace(selTypeChanged) [ Language = javascript ]
Changed Nemespace <==> Database (implied namespace).
clientmethod doSearch() [ Language = javascript ]
User clicked Go to start search.
clientmethod doView(globalName) [ Language = javascript ]
clientmethod keyUp(zenEvent) [ Language = javascript ]
Check if user hit [Enter].
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 onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod updateView() [ Language = javascript ]
Update / Reload table. This overrides the one in Template.List.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window