Ens.Rule.RuleLog
persistent class Ens.Rule.RuleLog extends %Library.Persistent, %XML.Adaptor
SQL Table Name: Ens_Rule.RuleLog
Deprecated; use Ens.Rule.Log. Defines an audit trail for the Rules Engine.Maintains a history of when rules were invoked and the reason for the returned value.
Property Inventory
- ActivityName
- EffectiveBeginDateTime
- EffectiveEndDateTime
- ErrorMsg
- ExecutionId
- HostClass
- IsError
- Reason
- ReturnValue
- RoutineName
- RuleId
- RuleName
- RuleVersion
- SessionId
- TimeExecuted
Method Inventory
Parameters
parameter XMLIGNORENULL = 1;
Ensure that we don't get $C(0) for values that are empty strings
Properties
property ActivityName as %String (MAXLEN = 128, TRUNCATE = 1, XMLNAME = "activityName", XMLPROJECTION = "attribute");
(Optional) The name of the BPL rule activity that invoked the rule.
Property methods: ActivityNameDisplayToLogical(), ActivityNameGet(), ActivityNameGetStored(), ActivityNameIsValid(), ActivityNameLogicalToDisplay(), ActivityNameLogicalToOdbc(), ActivityNameNormalize(), ActivityNameSet()
property EffectiveBeginDateTime as %String (COLLATION = "EXACT", MAXLEN = 2000, XMLNAME = "effectiveBeginDateTime", XMLPROJECTION = "attribute");
The EffectiveBeginDateTime of the rule executed.
Property methods: EffectiveBeginDateTimeDisplayToLogical(), EffectiveBeginDateTimeGet(), EffectiveBeginDateTimeGetStored(), EffectiveBeginDateTimeIsValid(), EffectiveBeginDateTimeLogicalToDisplay(), EffectiveBeginDateTimeLogicalToOdbc(), EffectiveBeginDateTimeNormalize(), EffectiveBeginDateTimeSet()
property EffectiveEndDateTime as %String (COLLATION = "EXACT", MAXLEN = 2000, XMLNAME = "effectiveEndDateTime", XMLPROJECTION = "attribute");
The EffectiveEndDateTime of the rule executed.
Property methods: EffectiveEndDateTimeDisplayToLogical(), EffectiveEndDateTimeGet(), EffectiveEndDateTimeGetStored(), EffectiveEndDateTimeIsValid(), EffectiveEndDateTimeLogicalToDisplay(), EffectiveEndDateTimeLogicalToOdbc(), EffectiveEndDateTimeNormalize(), EffectiveEndDateTimeSet()
property ErrorMsg as %String (MAXLEN = 1024, TRUNCATE = 1, XMLNAME = "errorMsg", XMLPROJECTION = "attribute");
If the Rules Engine returns an error it is placed here.
Property methods: ErrorMsgDisplayToLogical(), ErrorMsgGet(), ErrorMsgGetStored(), ErrorMsgIsValid(), ErrorMsgLogicalToDisplay(), ErrorMsgLogicalToOdbc(), ErrorMsgNormalize(), ErrorMsgSet()
property ExecutionId as %Integer (XMLNAME = "executionId", XMLPROJECTION = "attribute") [ InitialExpression = $I(^Ens.Rule.RuleLogC("ExecutionId")) , Required ];
Unique id for this rule execution.
Property methods: ExecutionIdDisplayToLogical(), ExecutionIdGet(), ExecutionIdGetStored(), ExecutionIdIsValid(), ExecutionIdLogicalToDisplay(), ExecutionIdNormalize(), ExecutionIdSet(), ExecutionIdXSDToLogical()
property HostClass as %String (MAXLEN = 128, TRUNCATE = 1, XMLNAME = "host", XMLPROJECTION = "attribute");
The class name of the Business Process that invoked the rule.
Property methods: HostClassDisplayToLogical(), HostClassGet(), HostClassGetStored(), HostClassIsValid(), HostClassLogicalToDisplay(), HostClassLogicalToOdbc(), HostClassNormalize(), HostClassSet()
property IsError as %Boolean [ InitialExpression = 0 ];
True if this is an error.
Property methods: IsErrorDisplayToLogical(), IsErrorGet(), IsErrorGetStored(), IsErrorIsValid(), IsErrorLogicalToDisplay(), IsErrorLogicalToXSD(), IsErrorNormalize(), IsErrorSet(), IsErrorXSDToLogical()
property Reason as %String (MAXLEN = 128, TRUNCATE = 1, XMLNAME = "reason", XMLPROJECTION = "attribute");
The reason (e.g, rule name) that the Rules Engine performed its action.
Property methods: ReasonDisplayToLogical(), ReasonGet(), ReasonGetStored(), ReasonIsValid(), ReasonLogicalToDisplay(), ReasonLogicalToOdbc(), ReasonNormalize(), ReasonSet()
property ReturnValue as %String);
The value returned by the Rule Engine for this rule.
Property methods: ReturnValueDisplayToLogical(), ReturnValueGet(), ReturnValueGetStored(), ReturnValueIsValid(), ReturnValueLogicalToDisplay(), ReturnValueLogicalToOdbc(), ReturnValueNormalize(), ReturnValueSet()
property RoutineName as %String (MAXLEN = 255, TRUNCATE = 1, XMLNAME = "routineName", XMLPROJECTION = "attribute");
The name of the routine in the Rule Cache used to execute this rule.
Property methods: RoutineNameDisplayToLogical(), RoutineNameGet(), RoutineNameGetStored(), RoutineNameIsValid(), RoutineNameLogicalToDisplay(), RoutineNameLogicalToOdbc(), RoutineNameNormalize(), RoutineNameSet()
property RuleId as %String (XMLPROJECTION = "none") [ Calculated ];
Object Id of Rule Definition.
Property methods: RuleIdCompute(), RuleIdDisplayToLogical(), RuleIdIsValid(), RuleIdLogicalToDisplay(), RuleIdLogicalToOdbc(), RuleIdNormalize(), RuleIdSQLCompute()
property RuleName as %String (MAXLEN = 128, TRUNCATE = 1, XMLNAME = "ruleName", XMLPROJECTION = "attribute") [ Required ];
The name of the Rule Definition that was executed.
Property methods: RuleNameDisplayToLogical(), RuleNameGet(), RuleNameGetStored(), RuleNameIsValid(), RuleNameLogicalToDisplay(), RuleNameLogicalToOdbc(), RuleNameNormalize(), RuleNameSet()
property RuleVersion as %Integer (XMLNAME = "ruleVersion", XMLPROJECTION = "attribute");
The version number for the Rule Definition.
Property methods: RuleVersionDisplayToLogical(), RuleVersionGet(), RuleVersionGetStored(), RuleVersionIsValid(), RuleVersionLogicalToDisplay(), RuleVersionNormalize(), RuleVersionSet(), RuleVersionXSDToLogical()
property SessionId as %Integer (XMLNAME = "sessionId", XMLPROJECTION = "attribute") [ Required ];
The id for the session in which the Rule was fired.
Property methods: SessionIdDisplayToLogical(), SessionIdGet(), SessionIdGetStored(), SessionIdIsValid(), SessionIdLogicalToDisplay(), SessionIdNormalize(), SessionIdSet(), SessionIdXSDToLogical()
property TimeExecuted as Ens.DataType.UTC (XMLNAME = "timeExecuted", XMLPROJECTION = "attribute") [ InitialExpression = $$$timeUTC , Required ];
Time that this Rule was executed.
Property methods: TimeExecutedDisplayToLogical(), TimeExecutedGet(), TimeExecutedGetStored(), TimeExecutedIsValid(), TimeExecutedLogicalToDisplay(), TimeExecutedLogicalToOdbc(), TimeExecutedNormalize(), TimeExecutedOdbcToLogical(), TimeExecutedSet(), TimeExecutedStorageToLogical(), TimeExecutedtimeCmp(), TimeExecutedtimeDiff(), TimeExecutedtimeLocal(), TimeExecutedtimeLocaltoUTC(), TimeExecutedtimeUTC(), TimeExecutedtimeUTCH(), TimeExecutedtimeUTCHtoUTC(), TimeExecutedtimeUTCtoLocal(), TimeExecutedtimeUTCtoUTCH()
Methods
classmethod Purge(Output pDeletedCount As %Integer, pDaysToKeep As %Integer = 7, pDummy As %Boolean) as %Status
method RuleIdGet() as %String
Queries
query Enumerate()
SQL Query:
SELECT %ID, SessionId, ExecutionId, TimeExecuted, HostClass, ActivityName, RuleName, EffectiveBeginDateTime, EffectiveEndDateTime, RuleVersion, Reason, ReturnValue, IsError, ErrorMsg, RuleId, RoutineName FROM RuleLog ORDER BY ExecutionId
SELECT %ID, SessionId, ExecutionId, TimeExecuted, HostClass, ActivityName, RuleName, EffectiveBeginDateTime, EffectiveEndDateTime, RuleVersion, Reason, ReturnValue, IsError, ErrorMsg, RuleId, RoutineName FROM RuleLog ORDER BY ExecutionId
Returns the current contents of the Rule Audit Log.
Indexes
index (ID on SessionId,ExecutionId) [IdKey, Type = key];
IdKey
Index methods: IDCheck(), IDDelete(), IDExists(), IDOpen(), IDSQLCheckUnique(), IDSQLExists(), IDSQLFindPKeyByConstraint(), IDSQLFindRowIDByConstraint()
index (TimeExecuted on TimeExecuted);
Index methods: TimeExecutedDisplayToLogical(), TimeExecutedExists(), TimeExecutedGet(), TimeExecutedGetStored(), TimeExecutedIsValid(), TimeExecutedLogicalToDisplay(), TimeExecutedLogicalToOdbc(), TimeExecutedNormalize(), TimeExecutedOdbcToLogical(), TimeExecutedSet(), TimeExecutedStorageToLogical(), TimeExecutedtimeCmp(), TimeExecutedtimeDiff(), TimeExecutedtimeLocal(), TimeExecutedtimeLocaltoUTC(), TimeExecutedtimeUTC(), TimeExecutedtimeUTCH(), TimeExecutedtimeUTCHtoUTC(), TimeExecutedtimeUTCtoLocal(), TimeExecutedtimeUTCtoUTCH()
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDetermineClass()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Storage
Storage Model: CacheStorage (Ens.Rule.RuleLog)
^Ens.Rule.RuleLogD(ID) | = | %%CLASSNAME
ActivityName
HostClass
Reason
ReturnValue
RuleName
RuleVersion
TimeExecuted
Status
Status
ErrorMsg
IsError
RoutineName
EffectiveBeginDateTime
EffectiveEndDateTime
|