Home > Class Reference > ENSLIB namespace > EnsPortal.RuleLog

EnsPortal.RuleLog

class EnsPortal.RuleLog extends EnsPortal.Template.viewerPage

This is the RuleLog page of the ZEN Ensemble application.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter CANCANCELSEARCH = 1;
Indicate if can cancel search. This defines whether tempPortalNode is set.
parameter EDITRESOURCE = %Ens_Purge:USE;
User needs USE permissions on the %Ens_Purge resource to start a purge from this page.
parameter JSINCLUDES = ensemble/Ensemble_Utils.js;
Comma-separated list of additional JS include files for the page.
parameter PAGENAME = 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.
parameter SETUPTEMPPORTALNODE = 1;
Indicate if ought to create tempPortalNode when page created. Used by Cancel feature for example.

Properties (Including Private)

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 %ZEN.Datatype.id [ InitialExpression = "pageTotal" ];
Inherited description: Id of the page number field
Property methods: pageNumberIdDisplayToLogical(), pageNumberIdGet(), pageNumberIdIsValid(), pageNumberIdLogicalToDisplay(), pageNumberIdLogicalToOdbc(), pageNumberIdNormalize(), pageNumberIdSet()
property pageSizeId as %ZEN.Datatype.id [ InitialExpression = "MaxRows" ];
Inherited description: Id of the page size field
Property methods: pageSizeIdDisplayToLogical(), pageSizeIdGet(), pageSizeIdIsValid(), pageSizeIdLogicalToDisplay(), pageSizeIdLogicalToOdbc(), pageSizeIdNormalize(), pageSizeIdSet()
property resultsTableId as %ZEN.Datatype.id [ InitialExpression = "table" ];
Inherited description: Id of the results tablePane
Property methods: resultsTableIdDisplayToLogical(), resultsTableIdGet(), resultsTableIdIsValid(), resultsTableIdLogicalToDisplay(), resultsTableIdLogicalToOdbc(), resultsTableIdNormalize(), resultsTableIdSet()

Methods (Including Private)

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 %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 BreakUpText(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