AuditTrailProvider Property

[This is preliminary documentation and subject to change.]

Contains the ProgID of the COM class which will be used for logging.

[Visual Basic,VBScript]
Property AuditTrailProvider As String
[C++]
HRESULT get_AuditTrailProvider(BSTR* pVal);
HRESULT put_AuditTrailProvider(BSTR Val);
[IDL]
HRESULT [propget] AuditTrailProvider([out,retval] BSTR* pVal);
HRESULT [propput] AuditTrailProvider([in] BSTR Val);

Remarks

The AuditTrailProvider must support IAuditTrail interface. Cdowf.dll contains 3 sample Audit Trail providers (i.e. classes implementing IAuditTrail):

1. AuditTrailEventLog (writes to the Microsoft® Windows® 2000 event log),
2. AuditTrailPropPI (writes to a column on the process instance row),
3. AuditTrailWF (writes to a column on the workflow folder row).

The instance of AuditTrailProvider class is created automatically by the workflow engine in the following cases:

• When a new process definition URL set on a process instance (IProcessInstance::put_ProcessDefinitionURL() is called).
• When a process instance is loaded (IProcessInstance::DataSource::Open() is called).

The IAuditTrail::Bind() method is called immediately after creation of the AuditTrailProvider object.

To get the current audit trail from a process instance you can use IProcessInstance.Get_AuditTrail().

Entries are added to the audit trail by calling IAuditTrail.AddEntry().

• AddEntry() is called by our engine in case of state changes and state-transition failures.
• AddEntry() can be called from script using WorkflowSession.AuditTrail.AddEntry. Such entries are called custom.

Example

The following example defines a ProcessDefinition variable, creates the object, and uses the object to set the AuditTrailProvider property.

Dim strProgID As String
Dim iPD As CDOWF.ProcessDefinition
Set iPD = New CDOWF.ProcessDefinition

'strProgID may be the ProgID of a provider that you wrote,
'or one of the sample providers included with Workflow for
'Microsoft Exchange Platinum.
With iPD
   .AuditTrailProvider = strProgID
End With

See Also