References an IPropertyTemplate that represents an individual property to be audited in a class. An audited source property in a class is mapped to an event property in an audit record of the Event table. By default, AuditAs is set to null.

Custom properties can be audited by setting IPropertyDefinition.AuditAs to an existing IPropertyTemplate, which typically is the same object from which the IPropertyDefinition was created. However, system properties do not have pre-existing property templates, so you must create a new property template for a system property that you want to audit. For code examples, see Configuring Property Auditing.

AuditAs is settable on an IPropertyDefintion as long as that IPropertyDefinition does not already inherit an AuditAs value. Once set, its value is automatically inherited as read-only in subclasses. If the IPropertyDefinition referenced by an AuditAs property is deleted, then that AuditAs property becomes settable on all immediate subclasses. For example, if root class A has a property P that is audited, and also has immediate subclasses A1 and A2, then P on A1 and P on A2 (referred to as P1 and P2) are inherited, with the same AuditAs value as set on A.P. If A.P is deleted, P1 and P2 get promoted to non-inherited properties on A1 and A2, respectively. As non-inherited properties, P1 and P2 now have AuditAs values that can be modified to point to a different property, independently of each other.

On IPropertyDescription, AuditAs is read only.

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

ToggleSyntax

Visual Basic (Declaration)
ReadOnly Property AuditAs As IPropertyTemplate
C#
IPropertyTemplate AuditAs { get; }
Visual C++
property IPropertyTemplate^ AuditAs {
	IPropertyTemplate^ get ();
}
JavaScript
function get_auditAs();

ToggleRemarks

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: PropertyTemplate
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ToggleSee Also