Skip to main content


class EnsPortal.LegacyRuleLog extends EnsPortal.Template.viewerPage

This page is used to display RuleLog entries logged in Ensemble 2010.2 and earlier.

Property Inventory

Method Inventory


parameter EDITRESOURCE = %Ens_Purge:USE;
User needs USE permissions on the %Ens_Purge resource to start a purge from this page.
parameter PAGENAME = Legacy Rule Log;
Displayed name of this page.
parameter RESOURCE = %Ens_RuleLog:USE;
User needs USE permissions on the %Ens_RuleLog resource to view this page.


property canViewRules as %ZEN.Datatype.boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList("%Ens_Code:READ,%Ens_Rules:READ,%Ens_RoutingRules:READ,%Ens_BusinessRules:READ") ];
Property methods: canViewRulesDisplayToLogical(), canViewRulesGet(), canViewRulesIsValid(), canViewRulesLogicalToDisplay(), canViewRulesLogicalToOdbc(), canViewRulesLogicalToXSD(), canViewRulesNormalize(), canViewRulesSet(), canViewRulesXSDToLogical()
property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];
Property methods: canViewTraceDisplayToLogical(), canViewTraceGet(), canViewTraceIsValid(), canViewTraceLogicalToDisplay(), canViewTraceLogicalToOdbc(), canViewTraceLogicalToXSD(), canViewTraceNormalize(), canViewTraceSet(), canViewTraceXSDToLogical()
property detailsWidth as %ZEN.Datatype.integer (MAXVAL = 80, MINVAL = 5) [ InitialExpression = 29 ];
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 msgDays as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Days") ];
Property methods: msgDaysDisplayToLogical(), msgDaysGet(), msgDaysIsValid(), msgDaysLogicalToDisplay(), msgDaysLogicalToOdbc(), msgDaysNormalize(), msgDaysSet()
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.
classmethod BreakUpReturnText(pText As %String) as %String [ ZenMethod ]
Strategically insert spaces or carriage return line feed as needed to keep the return text inside the boundaries of the display.
method CreateDataSet(pSeed As %String) as %Status
Server-side callback to provide data for the details table
method CreateResultSet(Output pSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Callback used to construct the query for the current page based on the values in searchCriteria. The custom resultset creation is required to ensure that optimised queries are used to retrieve results.
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 DrawTimeExecuted(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Write out the formatted TimeExecuted value along with the unformatted value inside a custom "timeexecuted" tag.
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
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 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 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
clientmethod expandoState() [ Language = javascript ]
Build the current expando state into a string concatenated with commas
clientmethod formReset() [ Language = javascript ]
Reset the "Search Rules 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 onChangeResultsPage(next, pageSize, currentPage) [ Language = javascript ]
Callback to set up the resultset/query for paging.
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 showTrace(session, evt) [ 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 Rule 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
clientmethod updatePageData() [ Language = javascript ]
Helper method to record the ExecutionId and TimeExecuted values for first and last rows on the current page.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab