This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


abstract class Ens.Util.LogBase extends Ens.Util.BitmapPurge

Common base class for event log and enterprise event log tables

Property Inventory


parameter XMLIGNORENULL = 1;
Ensure that we don't get $C(0) for values that are empty strings


property ConfigName as %String (MAXLEN = 128, TRUNCATE = 1);
Configured name of the Ensemble host from which the event was logged.
Property methods: ConfigNameDisplayToLogical(), ConfigNameGet(), ConfigNameIsValid(), ConfigNameLogicalToDisplay(), ConfigNameLogicalToOdbc(), ConfigNameNormalize(), ConfigNameSet()
property Job as %String (TRUNCATE = 1);
Identifies the job from which this event was logged.
Property methods: JobDisplayToLogical(), JobGet(), JobIsValid(), JobLogicalToDisplay(), JobLogicalToOdbc(), JobNormalize(), JobSet()
property MessageId as %Integer;
Value of the system Message ID counter when the event was logged.
Property methods: MessageIdDisplayToLogical(), MessageIdGet(), MessageIdIsValid(), MessageIdLogicalToDisplay(), MessageIdNormalize(), MessageIdSet()
property SessionId as %Integer;
Current Message Session (if any) when the event was logged.
Property methods: SessionIdDisplayToLogical(), SessionIdGet(), SessionIdIsValid(), SessionIdLogicalToDisplay(), SessionIdNormalize(), SessionIdSet()
property SourceClass as %String (MAXLEN = 255, TRUNCATE = 1);
Name of the class from which the event was logged.
Property methods: SourceClassDisplayToLogical(), SourceClassGet(), SourceClassIsValid(), SourceClassLogicalToDisplay(), SourceClassLogicalToOdbc(), SourceClassNormalize(), SourceClassSet()
property SourceMethod as %String (MAXLEN = 40, TRUNCATE = 1);
Name of the method from which the event was logged.
Property methods: SourceMethodDisplayToLogical(), SourceMethodGet(), SourceMethodIsValid(), SourceMethodLogicalToDisplay(), SourceMethodLogicalToOdbc(), SourceMethodNormalize(), SourceMethodSet()
property Stack as list of %String (MAXLEN = 400, TRUNCATE = 1);
For errors, contents of the stack at the time the error was logged.
Property methods: StackBuildValueArray(), StackCollectionToDisplay(), StackCollectionToOdbc(), StackDisplayToCollection(), StackDisplayToLogical(), StackGet(), StackGetObject(), StackGetObjectId(), StackGetSwizzled(), StackIsValid(), StackLogicalToDisplay(), StackLogicalToOdbc(), StackNormalize(), StackOdbcToCollection(), StackSet(), StackSetObject(), StackSetObjectId()
property Text as %String (MAXLEN = 32000, TRUNCATE = 1);
User-supplied description of the event.
Property methods: TextDisplayToLogical(), TextGet(), TextIsValid(), TextLogicalToDisplay(), TextLogicalToOdbc(), TextNormalize(), TextSet()
property TimeLogged as Ens.DataType.UTC;
Time when the event was logged.
Property methods: TimeLoggedDisplayToLogical(), TimeLoggedGet(), TimeLoggedIsValid(), TimeLoggedLogicalToDisplay(), TimeLoggedLogicalToOdbc(), TimeLoggedNormalize(), TimeLoggedOdbcToLogical(), TimeLoggedSet(), TimeLoggedStorageToLogical(), TimeLoggedtimeCmp(), TimeLoggedtimeDiff(), TimeLoggedtimeLocal(), TimeLoggedtimeLocaltoUTC(), TimeLoggedtimeUTC(), TimeLoggedtimeUTCH(), TimeLoggedtimeUTCHtoUTC(), TimeLoggedtimeUTCtoLocal(), TimeLoggedtimeUTCtoUTCH()
property TraceCat as %String (MAXLEN = 10, TRUNCATE = 1);
Specifies what the trace category for this event.
Property methods: TraceCatDisplayToLogical(), TraceCatGet(), TraceCatIsValid(), TraceCatLogicalToDisplay(), TraceCatLogicalToOdbc(), TraceCatNormalize(), TraceCatSet()
property Type as Ens.DataType.LogType;
What type of event.
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeNormalize(), TypeSet()

Inherited Members

Inherited Methods