This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsPortal.Agents


class EnsPortal.Agents extends EnsPortal.Template.viewerPage

Agent browser page

Property Inventory

Method Inventory


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 methods: canViewFileSystemDisplayToLogical(), canViewFileSystemGet(), canViewFileSystemIsValid(), canViewFileSystemLogicalToDisplay(), canViewFileSystemLogicalToXSD(), canViewFileSystemNormalize(), canViewFileSystemSet(), canViewFileSystemXSDToLogical()
property checkEdit as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Property methods: checkEdit(), checkEditDisplayToLogical(), checkEditGet(), checkEditIsValid(), checkEditLogicalToDisplay(), checkEditLogicalToOdbc(), checkEditLogicalToXSD(), checkEditNormalize(), checkEditSet(), checkEditXSDToLogical()
property detailsWidth as %ZEN.Datatype.integer (MAXVAL = 80, MINVAL = 5) [ InitialExpression = 30 ];
Inherited description: 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 methods: detailsWidthDisplayToLogical(), detailsWidthGet(), detailsWidthIsValid(), detailsWidthLogicalToDisplay(), detailsWidthLogicalToOdbc(), detailsWidthNormalize(), detailsWidthSet()
property endId as %ZEN.Datatype.string (ZENURL = "EndId");
Property methods: endIdDisplayToLogical(), endIdGet(), endIdIsValid(), endIdLogicalToDisplay(), endIdLogicalToOdbc(), endIdNormalize(), endIdSet()
property msgVersions as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Versions") ];
Property methods: msgVersionsDisplayToLogical(), msgVersionsGet(), msgVersionsIsValid(), msgVersionsLogicalToDisplay(), msgVersionsLogicalToOdbc(), msgVersionsNormalize(), msgVersionsSet()
property pageNumberId as [ InitialExpression = "pageTotal" ];
Inherited description: Id of the page number field
Property methods: pageNumberIdDisplayToLogical(), pageNumberIdGet(), pageNumberIdIsValid(), pageNumberIdLogicalToDisplay(), pageNumberIdLogicalToOdbc(), pageNumberIdNormalize(), pageNumberIdSet()
property pageSizeId as [ InitialExpression = "MaxRows" ];
Inherited description: Id of the page size field
Property methods: pageSizeIdDisplayToLogical(), pageSizeIdGet(), pageSizeIdIsValid(), pageSizeIdLogicalToDisplay(), pageSizeIdLogicalToOdbc(), pageSizeIdNormalize(), pageSizeIdSet()
property searchHidden as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether the searchPanel is currently hidden.
Property methods: searchHiddenDisplayToLogical(), searchHiddenGet(), searchHiddenIsValid(), searchHiddenLogicalToDisplay(), searchHiddenLogicalToOdbc(), searchHiddenLogicalToXSD(), searchHiddenNormalize(), searchHiddenSet(), searchHiddenXSDToLogical()
property sessionLinkTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Click to view a visual trace of the session") ];
Property methods: sessionLinkTitleDisplayToLogical(), sessionLinkTitleGet(), sessionLinkTitleIsValid(), sessionLinkTitleLogicalToDisplay(), sessionLinkTitleLogicalToOdbc(), sessionLinkTitleNormalize(), sessionLinkTitleSet()
property startId as %ZEN.Datatype.string (ZENURL = "StartId");
Property methods: startIdDisplayToLogical(), startIdGet(), startIdIsValid(), startIdLogicalToDisplay(), startIdLogicalToOdbc(), startIdNormalize(), startIdSet()
property tracePage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.VisualTrace.zen" ];
Property methods: tracePageDisplayToLogical(), tracePageGet(), tracePageIsValid(), tracePageLogicalToDisplay(), tracePageLogicalToOdbc(), tracePageNormalize(), tracePageSet()


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
clientmethod applyChanges() [ Language = javascript ]
clientmethod applyInterfaces() [ Language = javascript ]
clientmethod beginExport(pId) [ Language = javascript ]
clientmethod beginImport() [ Language = javascript ]
clientmethod changeRefresh() [ Language = javascript ]
User chose a new Auto-Refresh value; set a new timeout value and start the timer
clientmethod changedInterfaces() [ Language = javascript ]
Return boolean = true if client Interfaces have changed since opening the current item
clientmethod 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)
clientmethod clearPageNumber() [ Language = javascript ]
method clientInterfaces(name) as %Status [ ZenMethod ]
clientmethod cloneItem(obj) [ Language = javascript ]
classmethod deleteAgentInterfaces(tName) as %Boolean [ ZenMethod ]
clientmethod deleteInterface(key) [ Language = javascript ]
Delete the given Interface.
clientmethod doAgent() [ Language = javascript ]
Open New Agent dialog to register a new agent
clientmethod doDelete() [ Language = javascript ]
Delete the selected agent
method doExport(pId, pFile, pWhere, pSortBy, pDescend) [ ZenMethod ]
method doImport(value As %List) [ ZenMethod ]
clientmethod doPurge() [ Language = javascript ]
Delete all agents that satisfy the current search criteria
clientmethod editInterface(key) [ Language = javascript ]
Launch the Interface properties dialog.
clientmethod 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
clientmethod formReset() [ Language = javascript ]
Reset the "Search Events By..." form fields to blank, reset other fields to defaults
clientmethod getBaseItem(propName) [ Language = javascript ]
classmethod getClientInterfaces(name As %String, ByRef Interfaces) as %Status
clientmethod getNextData(next) [ Language = javascript ]
Inherited description: User clicked the Next Page or Previous Page button
clientmethod 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.
clientmethod logout() [ Language = javascript ]
To display a custom message, override logout() and do the unload check ourselves.
clientmethod onAfterPageChange() [ Language = javascript ]
Inherited description: Callback invoked after the next/previous page has been loaded.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
Subclass need to include the case "switchNamespace" if it is enabling "Switch" next to namespace.
clientmethod onSearchHandler() [ Language = javascript ]
User clicked the Search button, user changed a Quick Search or Event Type criterion,
clientmethod onSelectItem() [ Language = javascript ]
populate detailTable for the selected row or no selected row
clientmethod onTabChange() [ Language = javascript ]
User clicked on a tab, or selected a new item, so we need to fetch the required content from the server.
clientmethod onUpdate(table) [ Language = javascript ]
override resultsTable TablePane methods
clientmethod 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.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod onunloadHandler() [ Language = javascript ]
Inherited description: 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).
clientmethod populateControls(obj, propName) [ Language = javascript ]
clientmethod renderInterfacesTable() [ Language = javascript ]
Update the contents of the Interfaces table.
clientmethod resolveImportConflicts(fileName As %String) [ Language = javascript ]
clientmethod rowSelected(table) [ Language = javascript ]
User selected a row in the table
clientmethod rowUnSelected(table) [ Language = javascript ]
User selected a row in the table
clientmethod 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 ]
clientmethod selectFilepath(exp As %Boolean, fileName As %String) [ Language = javascript ]
clientmethod 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 ]
clientmethod textControlKeyDown(evt, escOnly) [ Language = javascript ]
clientmethod timeout(timer) [ Language = javascript ]
If auto-refresh is still on, refresh table and restart the timer
clientmethod updateActions() [ Language = javascript ]
clientmethod updateNavigationButtons() [ Language = javascript ]
Ensure that the "Next" and "Previous" buttons behave correctly based on the data returned from the current search.
clientmethod 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

Inherited Members

Inherited Properties

Inherited Methods