persistent class Ens.Rule.RuleLog
extends %Persistent, %XML.Adaptor
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.
• parameter XMLIGNORENULL = 1;
Ensure that we don't get $C(0) for values that are empty strings
• 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 EffectiveBeginDateTime
as %String(COLLATION="EXACT",MAXLEN=2000,XMLNAME="effectiveBeginDateTime",XMLPROJECTION="attribute");
The EffectiveBeginDateTime of the rule executed.
• property EffectiveEndDateTime
as %String(COLLATION="EXACT",MAXLEN=2000,XMLNAME="effectiveEndDateTime",XMLPROJECTION="attribute");
The EffectiveEndDateTime of the rule executed.
• property ErrorMsg
as %String(MAXLEN=1024,TRUNCATE=1,XMLNAME="errorMsg",XMLPROJECTION="attribute");
If the Rules Engine returns an error it is placed here.
• property ExecutionId
as %Integer(XMLNAME="executionId",XMLPROJECTION="attribute") [ InitialExpression = $I(^Ens.Rule.RuleLogC("ExecutionId")) ];
Unique id for this rule execution.
• property HostClass
as %String(MAXLEN=128,TRUNCATE=1,XMLNAME="host",XMLPROJECTION="attribute");
The class name of the Business Process that invoked the rule.
• property IsError
as %Boolean [ InitialExpression = 0 ];
True if this is an error.
• 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 ReturnValue
as %String(MAXLEN="",XMLNAME="returnValue",XMLPROJECTION="attribute");
The value returned by the Rule Engine for this rule.
• 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 RuleId
as %String(XMLPROJECTION="none") [ Calculated ];
Object Id of Rule Definition.
• property RuleName
as %String(MAXLEN=128,TRUNCATE=1,XMLNAME="ruleName",XMLPROJECTION="attribute") [ Required ];
The name of the Rule Definition that was executed.
• property RuleVersion
as %Integer(XMLNAME="ruleVersion",XMLPROJECTION="attribute");
The version number for the Rule Definition.
• property SessionId
as %Integer(XMLNAME="sessionId",XMLPROJECTION="attribute");
The id for the session in which the Rule was fired.
• property TimeExecuted
as Ens.DataType.UTC(XMLNAME="timeExecuted",XMLPROJECTION="attribute") [ InitialExpression = $$$timeUTC,Required ];
Time that this Rule was executed.
• 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
Returns the current contents of the Rule Audit Log.
•index (ID on SessionId,ExecutionId) [IdKey];
IdKey
•index (TimeExecuted on TimeExecuted);
