Represents a definition that specifies audit-event parameters. Audit events are set on a per-class basis: use this interface to configure a ISubscribableClassDefinition object or subobject for auditing. Create an IAuditDefinition object for each event that you want to audit for the class.

To create a IAuditDefinition object, call the createInstance method on the Factory.AuditDefinition class. Once created, set its properties, which define the event to be audited and other parameters.

For each IAuditDefinition object that you create, add it to a IAuditDefinitionList collection, then set the collection on the ISubscribableClassDefinition object.

To retrieve IAuditDefinition objects, get the IAuditDefinitionList collection and iterate it.


The following tables list the members exposed by IAuditDefinition.

Public Properties

 NameDescription
Public propertyAuditFailureA boolean value that indicates whether auditing for failed event operations is enabled (true) or not (false). Currently, auditable failures are limited to an access-denied result of an operation.

Note: If all audit definitions for a class specify that neither failed nor successful operations should be logged, then auditing for the class is effectively disabled.

Public propertyAuditSuccessA boolean value that indicates whether auditing for successful event operations is enabled (true) or not (false). Note: If all audit definitions for a class specify that neither failed nor successful operations should be logged, then auditing for the class is effectively disabled.
Public propertyEventClassThe class definition of the event that's being subscribed to or audited.
Public propertyIdA representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For IUser and IGroup classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, IUser.Id and IGroup.Id always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

  • PropertyDescription.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.Id.

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Public propertyIncludeSubclassesRequestedIndicates whether the operation should apply to the subclasses of the class. For a ClassSubscription object, this property indicates whether the subscription should also apply to the subclasses of the target class. For an AuditDefinition object, this property indicates whether auditing should also apply to the subclasses of the class configured for auditing.
Public propertyObjectStateRecordingLevelSpecifies the audit recording level of the source object for an event of type ObjectChangeEvent. (The source object is the object on which the event is fired.) The recording levels are ORIGINAL_AND_MODIFIED_OBJECTS (both the original, pre-event object and the modified, post-event object are recorded), MODIFIED_OBJECT (only the modified, post-event object is recorded), and NONE (no source objects are recorded). If MODIFIED_OBJECT is set, the event's OriginalObject property will be null. If NONE is specified, the event's OriginalObject and SourceObject properties will be null, and the event's ModifiedProperties property will be empty.

Note: Persisting audited source objects in a database can result in substantial consumption of large object (LOB) storage.

Top

See Also