Represents configuration data for audit disposition, a subsystem for automatic pruning (deletion) of audited events in the Content Engine audit log (Event table). Audit disposition runs as a background thread within the Content Engine.

A ICmAuditingConfiguration object can be assigned to objects of the server hierarchy (IDomain, ISite, IVirtualServer, and IServerInstance), with the first encountered by the current server being the active instance. A default instance is created at the domain level during domain creation. ICmAuditingConfiguration objects are persisted in the GCD.

ICmAuditingConfiguration allows admininistration clients to set or access audit disposition configuration settings, for example, the disposition schedule and the number of audited events deleted at one time. The disposition schedule is defined through a list-of-object property called IAuditDispositionTimeslots, where each element is a ICmTimeslot object with properties that specify a weekday, start time, and duration.

Complementing ICmAuditingConfiguration are the ICmAuditDispositionPolicy class, for setting the event selection criteria (query expression) that are applied by the audit disposition thread, and ICmAuditProcessingBookmark, a class with which an audit processing client can set its leave-off point in the audit log.

Audit disposition is enabled for the server or servers to which the configuration object applies when the AuditDispostionEnabled property is true and the AuditDispositionTimeslots list is non-empty. However, no disposition processing will take place for a particular object store until there is at least one enabled ICmAuditDispositionPolicy object defined in that object store.

To create a ICmAuditingConfiguration object, call the CreateInstance method on the Factory.CmAuditingConfiguration class. To instantiate a ICmAuditingConfiguration object, retrieve the SubsystemConfigurations property from an object of the server hierarchy, then iterate the ISubsystemConfigurationList for the ICmAuditingConfiguration object.

For more information, see Audit Disposition.

Namespace:  FileNet.Api.Admin
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Public Interface ICmAuditingConfiguration _
	Implements ISubsystemConfiguration, IEngineObject, ICloneable, IDependentObject
C#
public interface ICmAuditingConfiguration : ISubsystemConfiguration, 
	IEngineObject, ICloneable, IDependentObject
Visual C++
public interface class ICmAuditingConfiguration : ISubsystemConfiguration, 
	IEngineObject, ICloneable, IDependentObject
JavaScript
FileNet.Api.Admin.ICmAuditingConfiguration = function();
FileNet.Api.Admin.ICmAuditingConfiguration.createInterface('FileNet.Api.Admin.ICmAuditingConfiguration');

ToggleRemarks

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: SubsystemConfiguration

ToggleSee Also