Home > Class Reference > ENSLIB namespace > %CSP.UI.Portal.Processes

%CSP.UI.Portal.Processes

class %CSP.UI.Portal.Processes extends %CSP.UI.Portal.Utils

System Management Portal - System Operations - Processes

Property Inventory

Method Inventory

Parameters

parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/op/%CSP.UI.Portal.Processes.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,Processes;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Operation Processes;
Displayed name of this page.
parameter RESOURCE = %Admin_Operate;
Security requirement

Properties

property CurrentColumn as %ZEN.Datatype.string [ InitialExpression = "DisplayPID" ];
Column the table is sorted by. Default is the "Process ID" column. User may change and the value is saved and reloaded for this page.
Property methods: CurrentColumnDisplayToLogical(), CurrentColumnGet(), CurrentColumnIsValid(), CurrentColumnLogicalToDisplay(), CurrentColumnLogicalToOdbc(), CurrentColumnNormalize(), CurrentColumnSet()
property DetailsPage as %String [ InitialExpression = ..Link("/csp/sys/op/%25CSP.UI.Portal.ProcessDetails.zen",,1) ];
Property methods: DetailsPageDisplayToLogical(), DetailsPageGet(), DetailsPageIsValid(), DetailsPageLogicalToDisplay(), DetailsPageLogicalToOdbc(), DetailsPageNormalize(), DetailsPageSet()
property Filter as %ZEN.Datatype.string;
Filter value user entered into the "Filter" field in the table navigator. This value is saved and reloaded for this page.
Property methods: FilterDisplayToLogical(), FilterGet(), FilterIsValid(), FilterLogicalToDisplay(), FilterLogicalToOdbc(), FilterNormalize(), FilterSet()
property PrevFilter as %ZEN.Datatype.string [ InitialExpression = "PrevFilter" ];
Property methods: PrevFilterDisplayToLogical(), PrevFilterGet(), PrevFilterIsValid(), PrevFilterLogicalToDisplay(), PrevFilterLogicalToOdbc(), PrevFilterNormalize(), PrevFilterSet()
property TableMaxRows as %Integer [ InitialExpression = "1000" ];
Max rows value user entered into the "Max rows" field in the table navigator. This value is saved and reloaded for this page.
Property methods: TableMaxRowsDisplayToLogical(), TableMaxRowsGet(), TableMaxRowsIsValid(), TableMaxRowsLogicalToDisplay(), TableMaxRowsNormalize(), TableMaxRowsSet(), TableMaxRowsXSDToLogical()
property TablePageSize as %Integer [ InitialExpression = "0" ];
Page size value user entered into the "Page size" field in the table navigator. This value is saved and reloaded for this page.
Property methods: TablePageSizeDisplayToLogical(), TablePageSizeGet(), TablePageSizeIsValid(), TablePageSizeLogicalToDisplay(), TablePageSizeNormalize(), TablePageSizeSet(), TablePageSizeXSDToLogical()
property colDetails as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Details") ];
Store translated targetCol linkCaption for
Property methods: colDetailsDisplayToLogical(), colDetailsGet(), colDetailsIsValid(), colDetailsLogicalToDisplay(), colDetailsLogicalToOdbc(), colDetailsNormalize(), colDetailsSet()

Methods

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Be sure to do ##super() when overriding.
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.
method ExecuteRS(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean [ Language = objectscript ]
Method for executing the process query.
method OnDrawRibbon() as %Status [ Language = objectscript ]
Add to the contents of the tool ribbon.
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.
clientmethod doBroadcast() [ Language = javascript ]
clientmethod filterChanged(value) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
Inherited description: Maybe overriden by subclass.
Inherited description: Maybe overriden by subclass.
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 Portal.Utils.

Inherited Members

Inherited Properties

Inherited Methods

Feedback