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.EnsMsgTraceFilterForm


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

An AutoForm for gathering Message Trace filter info

Property Inventory (Including Private)

Method Inventory (Including Private)


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

Properties (Including Private)

property EndId as %String (CAPTION = "@Ensemble:EndId@End Id", MAXLEN = 25);
Ending id
Property methods: EndIdDisplayToLogical(), EndIdGet(), EndIdIsValid(), EndIdLogicalToDisplay(), EndIdLogicalToOdbc(), EndIdNormalize(), EndIdSet()
property EndTime as %String (CAPTION = "@Ensemble:EndTime@End Time", MAXLEN = 25);
Ending date and time
Property methods: EndTimeDisplayToLogical(), EndTimeGet(), EndTimeIsValid(), EndTimeLogicalToDisplay(), EndTimeLogicalToOdbc(), EndTimeNormalize(), EndTimeSet()
property EventsMaxRows as %Integer (CAPTION = "@Ensemble:EventsMaxRows@Events Max Rows");
Maximum number of Event Log records to scan after start time to include session events
Property methods: EventsMaxRowsDisplayToLogical(), EventsMaxRowsGet(), EventsMaxRowsIsValid(), EventsMaxRowsLogicalToDisplay(), EventsMaxRowsNormalize(), EventsMaxRowsSet()
property EventsWindow as %Integer (CAPTION = "@Ensemble:EventsWindow@Events Time Window");
Time window after last message to include session events
Property methods: EventsWindowDisplayToLogical(), EventsWindowGet(), EventsWindowIsValid(), EventsWindowLogicalToDisplay(), EventsWindowNormalize(), EventsWindowSet()
property IncludeEvents as %Boolean (CAPTION = "@Ensemble:IncludeEvents@Include Events");
Include session events
Property methods: IncludeEventsDisplayToLogical(), IncludeEventsGet(), IncludeEventsIsValid(), IncludeEventsLogicalToDisplay(), IncludeEventsNormalize(), IncludeEventsSet()
property IncludeIOLogEntries as %Boolean (CAPTION = "@Ensemble:IncludeIOLogEntries@Include IO Log Entries");
Include IO Log Entries
Property methods: IncludeIOLogEntriesDisplayToLogical(), IncludeIOLogEntriesGet(), IncludeIOLogEntriesIsValid(), IncludeIOLogEntriesLogicalToDisplay(), IncludeIOLogEntriesNormalize(), IncludeIOLogEntriesSet()
property SessionId as %String (CAPTION = "@Ensemble:SessionId@Session Id", MAXLEN = 25);
Session id
Property methods: SessionIdDisplayToLogical(), SessionIdGet(), SessionIdIsValid(), SessionIdLogicalToDisplay(), SessionIdLogicalToOdbc(), SessionIdNormalize(), SessionIdSet()
property ShowInternalItems as %Boolean (CAPTION = "@Ensemble:ShowInternalItems@Show Internal Items");
Enable display of internal messages and related events
Property methods: ShowInternalItemsDisplayToLogical(), ShowInternalItemsGet(), ShowInternalItemsIsValid(), ShowInternalItemsLogicalToDisplay(), ShowInternalItemsNormalize(), ShowInternalItemsSet()
property StartId as %String (CAPTION = "@Ensemble:StartId@Start Id", MAXLEN = 25);
Starting id
Property methods: StartIdDisplayToLogical(), StartIdGet(), StartIdIsValid(), StartIdLogicalToDisplay(), StartIdLogicalToOdbc(), StartIdNormalize(), StartIdSet()
property StartTime as %String (CAPTION = "@Ensemble:StartTime@Start Time", MAXLEN = 25);
Starting date and time
Property methods: StartTimeDisplayToLogical(), StartTimeGet(), StartTimeIsValid(), StartTimeLogicalToDisplay(), StartTimeLogicalToOdbc(), StartTimeNormalize(), StartTimeSet()

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)