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 > CSPX.EnsRuleLogFilterForm


class CSPX.EnsRuleLogFilterForm extends %Library.RegisteredObject, CSPX.AutoFormCSP

An autoform for gathering Rule Log Filter info

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter FORMCOLUMNS = 2;
Number of columns used to layout forms for this class

Properties (Including Private)

property ColorBy as %String (CAPTION = "@Ensemble:ColorBy@Color By", VALUELIST = ",Session,TimeExecuted,HostClass,Activity,Rule,Reason,Return,IsError,ErrorMsg,RoutineName");
Column to color results by
Property methods: ColorByDisplayToLogical(), ColorByGet(), ColorByIsValid(), ColorByLogicalToDisplay(), ColorByLogicalToOdbc(), ColorByNormalize(), ColorBySet()
property EndTime as %String (CAPTION = "@EnsColumns:EndTime@End Time");
End date
Property methods: EndTimeDisplayToLogical(), EndTimeGet(), EndTimeIsValid(), EndTimeLogicalToDisplay(), EndTimeLogicalToOdbc(), EndTimeNormalize(), EndTimeSet()
property HostClass as %String (CAPTION = "@EnsColumns:PackageName@Package Name");
Host class #; YSD2201 Property HostClass As %CSP.Util.Choice(CAPTION = "@EnsColumns:PackageName@Package Name", CAPTIONCOLUMN = "Name", P1 = "Ens.BusinessProcessBPL", QUERYCLASS = "%Dictionary.ClassDefinition", QUERYNAME = "SubclassOf");
Property methods: HostClassDisplayToLogical(), HostClassGet(), HostClassIsValid(), HostClassLogicalToDisplay(), HostClassLogicalToOdbc(), HostClassNormalize(), HostClassSet()
property MaxRows as %Integer (CAPTION = "@Ensemble:MaxRows@Max Rows", MAXVAL = 500, MINVAL = 1) [ InitialExpression = 100 ];
Number of rows to display
Property methods: MaxRowsDisplayToLogical(), MaxRowsGet(), MaxRowsIsValid(), MaxRowsLogicalToDisplay(), MaxRowsNormalize(), MaxRowsSet()
property RuleName as %CSP.Util.Choice (CAPTION = "@EnsColumns:RuleName@Rule Name", CAPTIONCOLUMN = "Name", QUERYCLASS = "Ens.Rule.RuleDefinition", QUERYNAME = "EnumerateRuleNames");
Rule Name
Property methods: RuleNameDisplayToLogical(), RuleNameGet(), RuleNameIsValid(), RuleNameLogicalToDisplay(), RuleNameLogicalToOdbc(), RuleNameNormalize(), RuleNameSet()
property SessionId as %Integer (CAPTION = "@Ensemble:SessionId@Session Id");
Session ID
Property methods: SessionIdDisplayToLogical(), SessionIdGet(), SessionIdIsValid(), SessionIdLogicalToDisplay(), SessionIdNormalize(), SessionIdSet()
property SortOrder as %String (CAPTION = "@Ensemble:SortOrder@Sort Order", DISPLAYLIST = ",Oldest First,Newest First", VALUELIST = ",1,2");
How to sort data
Property methods: SortOrderDisplayToLogical(), SortOrderGet(), SortOrderIsValid(), SortOrderLogicalToDisplay(), SortOrderLogicalToOdbc(), SortOrderNormalize(), SortOrderSet()
property StartTime as %String (CAPTION = "@Ensemble:StartTime@Start Time");
Starting date
Property methods: StartTimeDisplayToLogical(), StartTimeGet(), StartTimeIsValid(), StartTimeLogicalToDisplay(), StartTimeLogicalToOdbc(), StartTimeNormalize(), StartTimeSet()
property TimeFormat as %String (CAPTION = "@Ensemble:TimeFormat@Time Format", DISPLAYLIST = ",Time Only,Complete", VALUELIST = ",12,999");
Time format
Property methods: TimeFormatDisplayToLogical(), TimeFormatGet(), TimeFormatIsValid(), TimeFormatLogicalToDisplay(), TimeFormatLogicalToOdbc(), TimeFormatNormalize(), TimeFormatSet()

Methods (Including Private)

classmethod CreateInstance(ByRef pID As %String) as %CSP.Util.AutoForm
Inherited description: Create an instance of the AutoForm object using the provided ID value(s). This is overridden by subclasses.
The default implementation will perform an OpenId if the AutoForm is a persistent object.
classmethod OnDefineButtons(ByRef pButtons As %CSP.Util.FormButton)
define buttons
method OnSubmit(ByRef pID As %String, pSubmit As %String) as %Status
Inherited description: This callback is called when this form is submitted. pID is the ID value associated with the form. The default implementation will perform a Save if the AutoForm is a persistent object.
pSubmit is the name of the submit button (i.e., $AUTOFORM_SAVE).

Inherited Members

Inherited Methods (Including Private)