Skip to main content


class EnsPortal.BPInstances extends EnsPortal.Template.viewerPage

This is the BPInstances page of the ZEN application.

Property Inventory

Method Inventory


parameter EDITRESOURCE = %Ens_Purge:USE;
User must have USE permissions on %Ens_Purge to run the purge action on this page.
parameter PAGENAME = Business Process Instances;
Displayed name of this page.
parameter RESOURCE = %Ens_Jobs:READ;
User must have READ permissions on the "%Ens_Jobs" resource to view this page.


property BusinessProcess as %String (ZENURL = "BP");
The business process whose instances are of interest. The URL may supply this business process class name or it defaults to "" (empty string) for all business processes.
Property methods: BusinessProcessDisplayToLogical(), BusinessProcessGet(), BusinessProcessIsValid(), BusinessProcessLogicalToDisplay(), BusinessProcessLogicalToOdbc(), BusinessProcessNormalize(), BusinessProcessSet()
property BusinessTable as %String (ZENENCRYPT = 1);
The name of the SQL table that stores information about the business process whose instances are of interest. If this is a BPL business process, the value is Ens.BusinessProcessBPL; otherwise, it is Ens.BusinessProcess. This property is encrypted and only modifiable on the server
Property methods: BusinessTableDisplayToLogical(), BusinessTableGet(), BusinessTableIsValid(), BusinessTableLogicalToDisplay(), BusinessTableLogicalToOdbc(), BusinessTableNormalize(), BusinessTableSet()
property HasContext as %Boolean [ InitialExpression = 0 ];
True if the business process whose instances are of interest is a BPL business process. If so it has a context that is stored in an SQL table. Default is false.
Property methods: HasContextDisplayToLogical(), HasContextGet(), HasContextIsValid(), HasContextLogicalToDisplay(), HasContextLogicalToXSD(), HasContextNormalize(), HasContextSet(), HasContextXSDToLogical()
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 linkHelper as %ZEN.proxyObject;
Property methods: linkHelperGet(), linkHelperGetSwizzled(), linkHelperIsValid(), linkHelperNewObject(), linkHelperSet()
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 resultsTableId as [ InitialExpression = "table" ];
Inherited description: Id of the results tablePane
Property methods: resultsTableIdDisplayToLogical(), resultsTableIdGet(), resultsTableIdIsValid(), resultsTableIdLogicalToDisplay(), resultsTableIdLogicalToOdbc(), resultsTableIdNormalize(), resultsTableIdSet()


method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
method CreateDataSet(pSeed As %String) as %Status
Server-side callback to provide data for the details table
classmethod DoPurge(keep As %Integer) as %String [ ZenMethod ]
Perform the purge operation and if there is an error, return the message to JavaScript by prepending the message with a '-'. If no error then return the zero or positive number of entries deleted, as a string.
method DrawYesNo(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Draw Yes or No in place of 1 or 0
method GetAndUseDefaults() as %String
Method called from %OnAfterCreatePage to get defaults and build up the initial display
method GetBusinessProcess() as %String
Method called from %OnAfterCreatePage to get business process information
method GetColumnsAndFrom(timeFormat As %String) as %String
Get the first part of the SQL statement.
classmethod GetCount() as %Integer [ 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.
method GetWhereClause(Defaults) as %String [ ZenMethod ]
Method called from doSearch and %OnAfterCreatePage to build the where clause
method GiveAdviceString(pSeed As %String) as %Status
Server-side callback to provide localized string introducing the details table
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 SaveDefaults(SortOrder, TimeFormat, Defaults, MaxRows, States, AutoRefresh) [ ZenMethod ]
Save user's last search criteria into global for page default
clientmethod changeRefresh() [ Language = javascript ]
User chose a new Auto-Refresh value; set a new timeout value and start the timer
clientmethod countReset() [ Language = javascript ]
Reset the current count of Rule Log entries
clientmethod expandoState() [ Language = javascript ]
Build the current expando state into a string concatenated with commas
clientmethod formReset() [ Language = javascript ]
Reset the "Search By..." form fields to blank, reset other fields to defaults
clientmethod onAfterPageChange() [ Language = javascript ]
Inherited description: Callback invoked after the next/previous page has been loaded.
clientmethod onSearchHandler() [ Language = javascript ]
User clicked the Search button, user changed a Quick Search criterion, or we have completed a non-zero Purge.
clientmethod onSelectItem() [ Language = javascript ]
toggle detailTable for a selected row.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod showJobs(session) [ Language = javascript ]
User clicked a link for Jobs. Display the Jobs page in a popup, so user can view queued messages without losing his/her place in the BP Log.
clientmethod showMessage(context) [ Language = javascript ]
clientmethod showQueues(session) [ Language = javascript ]
User clicked a link for Queues. Display the Queues page in a popup, so user can view queued messages without losing his/her place in the BP Log.
clientmethod showTrace(session) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page in a popup, so user can click the arrows to go from session to session without losing his/her place in the BP Log.
clientmethod startPurge() [ Language = javascript ]
User clicked the Purge button
clientmethod timeout(timer) [ Language = javascript ]
If auto-refresh is still on, refresh table and restart the timer

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab