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

class EnsPortal.Jobs extends EnsPortal.Template.listPage

This is the Jobs page of the ZEN application.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 1 13 1


Summary

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

Properties
%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
ParentURL StdTitle aboutPage align
aux backgroundTimerInterval canEdit canViewFileSystem
cellAlign cellSize cellStyle cellVAlign
children 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 keepAliveInterval
label labelClass labelDisabledClass labelPosition
labelStyle layout lblTitle limitPopups
msgNotPermitted msgSelectItemToExport name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent searchKey showLabel
showRefresh slice 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 %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 AbortJobMsg
BuildMenu CheckAllBlanks CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt DoLogout DrawLocator
DrawRibbon DrawTitle Encrypt EnumerateClose
EnumerateExecute EnumerateFetch EscapeHTML EscapeURL
EvalResult Export FileExists GetCSPURL
GetContextLinks GetDefaultDir GetDefaultFile GetDocURL
GetHomePage GetHyperEventResources GetNewURL GetQuickLinks
GetSecurityHelper HyperEventCall HyperEventHead Import
Include InsertHiddenField InsertHiddenFields IsPrivate
JavaInstalled Link OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RegisterRecent RewriteURL SetDefaultDir
ShowError SimpleKeepAlive StartTimer StopJob
StopTimer SuspendJobMsg ThrowError UnescapeHTML
UnescapeURL XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
addPopupSuffix arrowClick cancelPopup changePassword
changeRefresh changeURLNamespace checkEdit checkHelper
childrenMutated clientKeepAlive correctIELayering createComponent
createComponentNS createTimeWarning deleteComponent disableCommandButton
displayCountDown doExport doImport doRefresh
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler enableCommandButton endModal
exposeComponent findElement fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getPageTitle getProperty
getSettings getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
hideTimeoutWarning hideWarnContinue inResizeLoop initPopupSuffix
invokeSuper isOfType jobAbortMsg jobStop
jobSuspendMsg launchPopupWindow logout makeId
manualKeepAlive 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 refreshTimeout removeChild
removePopupSuffix render renderContents renderSVG
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler setWarnInnerHTML showAbout
showCommandButton showContact showDocumentation showHelp
showTimeoutWarning startKeepAlive startModal startProgressBar
stopKeepAlive stopProgressBar switchNamespace updateSecurityHelper
warnclickListener


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 ];
Does this page have refresh functionality? Note that this value is ignored when enableAutoRefresh is false.

Methods

• method %OnGetPageName() as %String
Get the (localized) name of the page.
• classmethod AbortJobMsg(pJob As %String) as %String [ ZenMethod ]
• classmethod GetHyperEventResources(pMethod As %String = "") as %String
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 [ 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
Get information to display in the ribbon bar.
• classmethod StopJob(pJob As %String) as %String [ ZenMethod ]
• classmethod SuspendJobMsg(pJob As %String) as %String [ ZenMethod ]
• method checkHelper(toCheck, noAlert) [ Language = javascript ]
• method jobAbortMsg() [ Language = javascript ]
• method jobStop() [ Language = javascript ]
• method jobSuspendMsg() [ Language = javascript ]
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method 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

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