EnsPortal.Jobs

class EnsPortal.Jobs extends EnsPortal.Template.listPage

This is the Jobs page of the ZEN application.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter JOBSRESOURCE = %Ens_Jobs:WRITE;
parameter PAGENAME = Currently Active Jobs;
Displayed name of this page.
parameter RESOURCE = %Ens_Jobs:READ;
User needs READ permissions on the %Ens_Jobs resource to access this page.
parameter SUSPENDRESOURCE = %Ens_MessageSuspend:USE;

Properties

property showRefresh as %Boolean [ InitialExpression = 1 ];
Inherited description: Does this page have refresh functionality? Note that this value is ignored when enableAutoRefresh is false.
Property methods: showRefreshDisplayToLogical(), showRefreshGet(), showRefreshIsValid(), showRefreshLogicalToDisplay(), showRefreshLogicalToXSD(), showRefreshNormalize(), showRefreshSet(), showRefreshXSDToLogical()

Methods

method %OnGetPageName() as %String [ Language = objectscript ]
Get the (localized) name of the page.
classmethod AbortJobMsg(pJob As %String) as %String [ Language = objectscript, ZenMethod ]
classmethod GetHyperEventResources(pMethod As %String = "") as %String [ Language = objectscript ]
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
classmethod GetSecurityHelper() as %ZEN.proxyObject [ Language = objectscript, 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 [ Language = objectscript ]
Get information to display in the ribbon bar.
classmethod StopJob(pJob As %String) as %String [ Language = objectscript, ZenMethod ]
classmethod SuspendJobMsg(pJob As %String) as %String [ Language = objectscript, ZenMethod ]
clientmethod checkHelper(toCheck, noAlert) [ Language = javascript ]
clientmethod jobAbortMsg() [ Language = javascript ]
clientmethod jobStop() [ Language = javascript ]
clientmethod jobSuspendMsg() [ Language = javascript ]
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod updateSecurityHelper() [ Language = javascript ]

Queries

query Enumerate(Filter As %String = "", QueryMethod As %String, QueryClass As %String)
Selects Job As %String, ConfigName As %String, Mode As %String, Status As %String, Detail As %String, ActiveMessage As %String, State As %String
Class query with filter added. Override this in order to add rowspec specific to the list being displayed

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback