Specialized Administration > Analyzing System and Business Information > Auditing Administration > About configAudit XML File > Tags in configAudit.xml and their Significance
  
Tags in configAudit.xml and their Significance
The configAudit.xml schema contains the following elements:
EventConfiguration
|
|— KeyEntry
|— ConfigEntry
|
|— KeyedEventEntry
|— EventEntry
Set the parent element EventConfiguration to true to enable auditing for all the events in the application.
<EventConfiguration enabled="true">
</EventConfiguration>
To selectively audit events, you must customize which auditing events are enabled. By default, EventConfiguration is set to false, auditing is disabled.
Element
Sub-Element
Description
Attributes
EventConfiguration
KeyEntry
Use this element to add an event that requires auditing.
• eventKey
• multiObject
ConfigEntry
Use this element to audit a type specific event or all types of events.
• class
• enabled
• KeyEntry
The sub-elements and their attributes contained in KeyEntry are as follows:
Element
Attribute
Description
Data Type
Value
KeyEntry
eventKey
Use this attribute to add events that need to be audited.
String
Specify an event that requires auditing. A value for this attribute is required.
For example,
eventKey="*/wt.team.TeamServiceEvent/REMOVE_ROLE"
multiObject
Use this attribute to specify whether the event is a single-object event or a multi-object event.
Boolean
The default value is false.
If set to true, the event is considered as a multi-object event.
If no value is specified, the default value false is used and the event is considered as a single-object event.
Following is a snippet usage of KeyEntry which will log the event "Remove Role from Context Team”:
<EventConfiguration enabled="false">
<KeyEntry eventKey="*/wt.team.TeamServiceEvent/REMOVE_ROLE" multiObject="true"/>
</EventConfiguration>
For information about events and their respective eventKey, see the section List of Events and eventKey.
• ConfigEntry
Set ConfigEntry to true to enable type specific auditing. If no class is specified for ConfigEntry, then all events are recorded, regardless of type. If a class is specified, events respective to the mentioned type are audited. Example of class is wt.org.WTGroup or wt.team.RolePrincipalMap. The sub-elements and their attributes contained in ConfigEntry are as follows:
Element
Sub-Element
Description
Attributes
ConfigEntry
KeyedEventEntry
Use this element to enable auditing of generic type of events. For example, events like Archive and Associate.
• eventType
• enabled
• handler
EventEntry
Use this element to enable auditing of non-generic type of events, such as Rollback Iteration and Workflow State Change.
The format to specify an event is <eventname>EventEntry. For example, AccessControlEventEntry.
• eventType
• enabled
• handler
◦ KeyedEventEntry
The attributes contained in KeyedEventEntry are as follows:
Element
Attribute
Description
Data Type
Value
KeyedEventEntry
eventType
or eventKey
Use this attribute to specify a generic type of event that needs to be audited. Specify events as eventType or eventKey depending on how they are executed in your installation of Windchill.
String
A value for this attribute is required. You can define a value such as:
KeyedEventEntry eventKey="*/wt.sandbox.SandboxServiceCheckoutEvent/POST_SB_CHECKOUT_EVENT"
Enabled
Use this attribute to enable auditing of an event.
Boolean
A value for this attribute is required. To enable auditing, the value must be set to true.
Handler
Use this attribute to specify the helper class which provides the method to log a specific event.
String
A value for this attribute is required. You can define a value such as:
handler="wt.audit.configaudit.TeamAuditMapEventRecorder"
◦ EventEntry
The attributes contained in EventEntry are as follows:
Element
Attribute
Description
Data Type
Value
EventEntry
eventType
Use this attribute to specify a non-generic type of event that needs to be audited. Example of a non-generic event is STATUS_CHANGE or NOT_AUTHORIZED. For information on non-generic events and their respective EventEntry, see the section List of Non-Generic Events and eventType.
String
A value for this attribute is required. Specify an event that you want to be audited in the format: <eventname>EventEntry.
For example,
AccessControlEventEntry eventType="NOT_AUTHORIZED"
Enabled
Use this attribute to enable auditing of an event.
Boolean
A value for this attribute is required. To enable auditing, set the value to true.
Handler
Use this attribute to specify the helper class which provides method to log specific event.
String
A value for this attribute is required. Specify a helper class which provides the method to log a specific event.
For example,
handler="wt.audit.configaudit.TeamAuditMapEventRecorder"
Snippet usage of ConfigEntry
<EventConfiguration enabled="false">
<KeyEntry eventKey="*/wt.team.TeamServiceEvent/REMOVE_ROLE" multiObject="true"/>
<ConfigEntry class="" enabled="true">
<KeyedEventEntry eventKey="*/wt.sandbox.SandboxServiceCheckoutEvent/POST_SB_CHECKOUT_EVENT" enabled="true" handler="wt.audit.configaudit.PDMCheckoutEventRecorder"/>
</ConfigEntry>
<ConfigEntry class="wt.team.RolePrincipalMap" enabled="true">
<KeyedEventEntry eventKey="*/wt.team.TeamServiceEvent/ADD_ROLE" enabled="true" handler="wt.audit.configaudit.TeamAuditMapEventRecorder"/>
<KeyedEventEntry eventKey="*/wt.team.TeamServiceEvent/REMOVE_ROLE" enabled="true" handler="wt.audit.configaudit.TeamAuditMapEventRecorder"/>
</ConfigEntry>
<ConfigEntry class="" enabled="true">
<AccessControlEventEntry eventType="NOT_AUTHORIZED" enabled="true" handler="wt.audit.configaudit.NotAuthorizedEventRecorder"/>
<VCEventEntry eventType="POST_ROLLBACK" enabled="true" handler="wt.audit.configaudit.DefaultAuditEventRecorder"/>
<ConfigEntry>
</EventConfiguration>