Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsPortal.Agents
Private  Storage   


class EnsPortal.Agents extends

Agent browser page


Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 11 81 1


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

%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
ParentURL StdTitle aboutPage align
aux backgroundTimerInterval canEdit canViewFileSystem
cellAlign cellSize cellStyle cellVAlign
checkEdit children composite containerStyle
cssLevel currSortMode currStep currViewMode
currentPage currentPageStart detailsHidden detailsWidth
disabled dragAndDrop dragEnabled dropEnabled
enclosingClass enclosingStyle endId error
groupClass groupStyle height hidden
hideDetailsMsg hideSearchMsg hint hintClass
hintStyle home homePage id
index isFirstPage isLastPage keepAliveInterval
label labelClass labelDisabledClass labelPosition
labelStyle layout lblDetails lblTitle
limitPopups msgCloseDetail msgNotPermitted msgVersions
name onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate pageId pageModified
pageNumberId pageSizeId parent queryAtEnd
resultsTableId searchCriteria searchHidden searchJob
searchKey searchQuery selectedId sessionLinkTitle
showDetailsMsg showLabel showSearchMsg slice
startId tablePaneUsesSQLAttrib tempPortalNode title
tracePage tuple useSVG useSoftModals
valign visible width window

%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
%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
%OnGetTableLinkMenu %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
CheckAllBlanks CheckContextLinks CheckEnterpriseManager ConvertParameter
Decrypt DeleteItem DisplayStatus DoLogout
DrawDetailsContent DrawLocator DrawRibbon DrawStatusContent
DrawTitle Encrypt EnumerateClose EnumerateExecute
EnumerateFetch EscapeHTML EscapeURL EvalResult
Export FileExists GetAndUseDefaults GetCSPURL
GetColumnsAndFrom GetContextLinks GetDefaultDir GetDefaultFilename
GetDocPage GetHomePage GetHyperEventResources GetNewURL
GetQuickLinks GetRegItem GetRemoteSearchJob GetResultSet
GetSecurityHelper HyperEventCall HyperEventHead Include
InitEnumerateFetch InsertHiddenField InsertHiddenFields IsPrivate
Link OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Overwrite Page
PrepareCancel PurgeSelectedItems QuoteJS RegisterRecent
RemoveTempData ResetQuery RewriteURL SetDefaultDir
ShowError SignalCancel SimpleKeepAlive StartTimer
StopTimer SubmitRegItem ThrowError UnescapeHTML
UnescapeURL UpdateObj XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore addPopupSuffix adjustExpanderText applyChanges
applyInterfaces arrowClick beginExport beginImport
cancelPopup cancelSearch changePassword changeRefresh
changeURLNamespace changedInterfaces checkEdit checkForChanges
childrenMutated clearPageNumber clientInterfaces clientKeepAlive
cloneItem correctIELayering createComponent createComponentNS
deleteAgentInterfaces deleteComponent deleteInterface disableCommandButton
doAgent doDelete doExport doImport
doPurge doSearch dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
editInterface enableCommandButton endModal enterKey
executeSearch exposeComponent findConflicts findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
formReset getBaseItem getChildIndex getClientInterfaces
getComponent getComponentById getContentAreaHeight getEnclosingDiv
getHidden getHintElement getLabelElement getNextData
getOpener getProperty getResultsTable getSearchForm
getSettings getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
inResizeLoop indicateIfCancelled initPopupSuffix invokeSuper
isOfType launchPopupWindow layoutTabGroup logout
makeId navigate onAfterPageChange onAfterSearch
onChangeResultsPage onCreate onDelete onDisplayHandler
onEndModalHandler onEnsException onPopupAction onRefreshContents
onSearchHandler onSelectItem onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler onTabChange
onToggleDetails onToggleSearch onUpdate ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler populateControls popupActionHandler refreshContents
removeChild removePopupSuffix render renderContents
renderInterfacesTable renderSVG resolveImportConflicts rowSelected
rowUnSelected saveChanges saveDefaults saveInterface
saveOption saveProperty searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress selectFilepath
selectItem selectRow setComponentId setConnectivityStatusMsg
setHidden setModified setOverlayMode setProperty
setPropertyAll setSearchCriteria setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler setupImport
showAbout showCommandButton showDocumentation showHelp
showQuery startKeepAlive startModal startProgressBar
stopKeepAlive stopProgressBar switchNamespace textControlKeyDown
timeout toggleCancelState toggleDetails toggleSearch
toggleSearchState updateActions updateNavigationButtons updatePageData
updatePageNumber updatePageSize updateSecurityHelper


• parameter EDITRESOURCE = "%Ens_Agents:WRITE";
User needs WRITE permissions on the %Ens_Agents resource to make changes to this page.
• parameter JSINCLUDES = "ensemble/Ensemble_Utils.js";
Comma-separated list of additional JS include files for the page.
• parameter PAGENAME = "Agents";
Displayed name of this page.
• parameter RESOURCE = "%Ens_Agents:READ";
User needs READ permissions on the %EnsLib_Agent resource to view this page.


• property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
• property checkEdit as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
• property detailsWidth as %ZEN.Datatype.integer(MAXVAL=80,MINVAL=5) [ InitialExpression = 30 ];
Value to indicate the percentage of the horizontal screen which should be devoted to the details panel (if it is visible). This is exposed as a client-side property for the layout code to use the value.
• property endId as %ZEN.Datatype.string(ZENURL="EndId");
• property msgVersions as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Versions") ];
• property pageNumberId as %ZEN.Datatype.id [ InitialExpression = "pageTotal" ];
Id of the page number field
• property pageSizeId as %ZEN.Datatype.id [ InitialExpression = "MaxRows" ];
Id of the page size field
• property searchHidden as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether the searchPanel is currently hidden.
• property sessionLinkTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Click to view a visual trace of the session") ];
• property startId as %ZEN.Datatype.string(ZENURL="StartId");
• property tracePage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.VisualTrace.zen" ];


• method %OnAfterCreatePage() as %Status
Fill search criteria defaults
• method %OnDrawHTMLHead() as %Status
This callback is called at the end of the HTML HEAD section of the page.
(default implementation is a simple expression).
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• classmethod DeleteItem(pId As %String) as %ZEN.Datatype.string [ ZenMethod ]
• classmethod DisplayStatus(status As %Integer) as %String
• method DrawStatusContent(pHeaderID As %String) as %Status
• classmethod EnumerateClose(ByRef qHandle As %Binary) as %Status
• classmethod EnumerateExecute(ByRef qHandle As %Binary, ByRef pWhere, ByRef pSortBy, ByRef pDescend) as %Status
• classmethod EnumerateFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod Export(pId As %Integer = -1, pFile As %String = "", pWhere, pSortBy, pDescend) as %String
• classmethod FileExists(filename As %String) as %String [ ZenMethod ]
• method GetAndUseDefaults() as %String
Method called from %OnAfterCreatePage to get defaults and build up the initial display
• classmethod GetDefaultDir() as %String [ ZenMethod ]
• classmethod GetDefaultFilename(pId As %Integer) 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 GetRegItem(ByRef pParms, Output pObject As %RegisteredObject) as %Status
• classmethod GetResultSet(pWhere, pSortBy, pDescend, Output pSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Callback that is executed to create the resultset for the main table.
• classmethod GetSecurityHelper() as %Boolean [ ZenMethod ]
• classmethod InitEnumerateFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• method OnDrawRibbon() as %Status
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
Get information to display in the ribbon bar.
• classmethod Overwrite(pFile As %String, ByRef pCount, ByRef items) as %String
each node in array should be items(agentName)=existance
• classmethod PurgeSelectedItems(where, sortBy, descend) as %ZEN.Datatype.string [ ZenMethod ]
• classmethod SetDefaultDir(pPathname As %String) [ ZenMethod ]
• classmethod SubmitRegItem(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As EnsLib.Agent.Interface, Output pResponseObject As %RegisteredObject) as %Status
Object submit handler JSON provider. This is called when the client submits the DTL definition.
• classmethod UpdateObj(pSrc As EnsLib.Agent.Interface, pTarg As EnsLib.Agent.Interface) as %Status
• method applyChanges() [ Language = javascript ]
• method applyInterfaces() [ Language = javascript ]
• method beginExport(pId) [ Language = javascript ]
• method beginImport() [ Language = javascript ]
• method changeRefresh() [ Language = javascript ]
User chose a new Auto-Refresh value; set a new timeout value and start the timer
• method changedInterfaces() [ Language = javascript ]
Return boolean = true if client Interfaces have changed since opening the current item
• method checkForChanges(obj, propName, changed) [ Language = javascript ]
Check to see if any properties of the current item have been changed since opening the current item (note that item re-opens on saving)
• method clearPageNumber() [ Language = javascript ]
• method clientInterfaces(name) as %Status [ ZenMethod ]
• method cloneItem(obj) [ Language = javascript ]
• classmethod deleteAgentInterfaces(tName) as %Boolean [ ZenMethod ]
• method deleteInterface(key) [ Language = javascript ]
Delete the given Interface.
• method doAgent() [ Language = javascript ]
Open New Agent dialog to register a new agent
• method doDelete() [ Language = javascript ]
Delete the selected agent
• method doExport(pId, pFile, pWhere, pSortBy, pDescend) [ ZenMethod ]
• method doImport(value As %List) [ ZenMethod ]
• method doPurge() [ Language = javascript ]
Delete all agents that satisfy the current search criteria
• method editInterface(key) [ Language = javascript ]
Launch the Interface properties dialog.
• method enterKey() [ Language = javascript ]
Use with certain fields so user can hit Enter to indicate that an entry in the field is done and ready to use
• classmethod findConflicts(pFile As %String) as %String
on first pass through the import file, tabulate types of conflicts for each item
• method formReset() [ Language = javascript ]
Reset the "Search Events By..." form fields to blank, reset other fields to defaults
• method getBaseItem(propName) [ Language = javascript ]
• classmethod getClientInterfaces(name As %String, ByRef Interfaces) as %Status
• method getNextData(next) [ Language = javascript ]
User clicked the Next Page or Previous Page button
• method layoutTabGroup() [ Language = javascript ]
Handle the client-side rendering the of the right hand pane. This is primarily due to IE as it shrinks the contents div without this intervention. The function only adjusts the size of the tab group is not hidden.
• method logout() [ Language = javascript ]
To display a custom message, override logout() and do the unload check ourselves.
• method onAfterPageChange() [ Language = javascript ]
Callback invoked after the next/previous page has been loaded.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
Subclass need to include the case "switchNamespace" if it is enabling "Switch" next to namespace.
• method onSearchHandler() [ Language = javascript ]
User clicked the Search button, user changed a Quick Search or Event Type criterion,
• method onSelectItem() [ Language = javascript ]
populate detailTable for the selected row or no selected row
• method onTabChange() [ Language = javascript ]
User clicked on a tab, or selected a new item, so we need to fetch the required content from the server.
• method onUpdate(table) [ Language = javascript ]
override resultsTable TablePane methods
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page. Do this differently for Registry than for other children of EnsPortal.Template.viewerPage (hence the override). In this case the details pane does NOT get large when the search pane is minimized.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method onunloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is unloaded. If this method returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler (if more than one component returns a string, the first one encountered is used).
• method populateControls(obj, propName) [ Language = javascript ]
• method renderInterfacesTable() [ Language = javascript ]
Update the contents of the Interfaces table.
• method resolveImportConflicts(fileName As %String) [ Language = javascript ]
• method rowSelected(table) [ Language = javascript ]
User selected a row in the table
• method rowUnSelected(table) [ Language = javascript ]
User selected a row in the table
• method saveChanges(obj, propName) [ Language = javascript ]
• method saveDefaults(SortBy, Descend, MaxRows, AutoRefresh, Expanded, HideDetails, HideSearch) [ ZenMethod ]
Save user's last search criteria into global for page default
• classmethod saveInterface(Name, ID, Description="", Type, Location="", Config="", Timeout="", Port="", Notes="", Credential="", Availability="", Options="") as %String [ ZenMethod ]
• classmethod saveOption(AgentName, propName, value) as %Status [ ZenMethod ]
• classmethod saveProperty(Agent, propName, value) as %Status [ ZenMethod ]
• method selectFilepath(exp As %Boolean, fileName As %String) [ Language = javascript ]
• method selectRow(row, scroll, which) [ Language = javascript ]
Overrides TablePane method
• method setSearchCriteria(init, ready, failed, stopped, overdue, part, partFail, partStop, other, word, sort, descend) as %String [ ZenMethod ]
• method setupImport(pFile) [ ZenMethod ]
• method textControlKeyDown(evt, escOnly) [ Language = javascript ]
• method timeout(timer) [ Language = javascript ]
If auto-refresh is still on, refresh table and restart the timer
• method updateActions() [ Language = javascript ]
• method updateNavigationButtons() [ Language = javascript ]
Ensure that the "Next" and "Previous" buttons behave correctly based on the data returned from the current search.
• method updateSecurityHelper() [ Language = javascript ]


• query Enumerate(ByRef pWhere, ByRef pSortBy, ByRef pDescend)
Selects ID As %String, Name As %String, ConfigName As %String, LastInvocation As %String, Status As %String, Description As %String, Outbound As %Integer, Inbound As %Integer