Administration spécialisée > Analyse des informations système et métier > Administration d'audit > A propos du fichier configAudit.xml > Présentation et description des balises du fichier configAudit.xml
  
Présentation et description des balises du fichier configAudit.xml
Le schéma configAudit.xml contient les éléments suivants :
EventConfiguration
|
|— KeyEntry
|— ConfigEntry
|
|— KeyedEventEntry
|— EventEntry
Définissez l'élément parent EventConfiguration sur true pour activer l'audit de tous les événements de l'application.
<EventConfiguration enabled="true">
</EventConfiguration>
Pour effectuer des audits sur des événements particuliers, vous devez activer les événements d'audit appropriés. Par défaut, EventConfiguration est défini sur false, ce qui désactive l'audit.
Elément
Sous-élément
Description
Attributs
EventConfiguration
KeyEntry
Utilisez cet élément pour ajouter un événement devant faire l'objet d'un audit.
eventKey
multiObject
ConfigEntry
Utilisez cet élément pour auditer un type d'événement spécifique ou tous les types d'événements.
class
enabled
KeyEntry
Les sous-éléments et leurs attributs contenus dans KeyEntry sont les suivants :
Elément
Attribut
Description
Type de données
Valeur
KeyEntry
eventKey
Utilisez cet attribut pour ajouter les événements qui doivent faire l'objet d'un audit.
Chaîne
Spécifiez un événement qui nécessite un audit. Cet attribut requiert une valeur.
Par exemple,
eventKey="*/wt.team.TeamServiceEvent/REMOVE_ROLE"
multiObject
Utilisez cet attribut pour spécifier si l'événement est un événement à objet unique ou multi-objet.
Booléen
La valeur par défaut est false.
Si cet attribut est défini sur true, l'événement est considéré comme un événement multi-objet.
Si aucune valeur n'est spécifiée, la valeur par défaut false est utilisée, et l'événement est considéré comme un événement à objet unique.
Vous trouverez ci-après un extrait de code utilisant l'élément KeyEntry pour consigner l'événement "Supprimer un rôle de l'équipe associée au contexte" :
<EventConfiguration enabled="false">
<KeyEntry eventKey="*/wt.team.TeamServiceEvent/REMOVE_ROLE" multiObject="true"/>
</EventConfiguration>
Pour plus d'informations sur les événements et sur leurs éléments eventKey respectifs, consultez la section présentant la liste des événements et des éléments eventKey.
ConfigEntry
Définissez ConfigEntry sur "true" pour activer un type d'audit spécifique. Si aucune classe n'est spécifiée pour ConfigEntry, tous les événements sont enregistrés, indépendamment de leur type. Si une classe est spécifiée, les événements correspondant au type indiqué font l'objet d'un audit. wt.org.WTGroup et wt.team.RolePrincipalMap constituent deux exemples de classes. Les sous-éléments et leurs attributs contenus dans ConfigEntry sont les suivants :
Elément
Sous-élément
Description
Attributs
ConfigEntry
KeyedEventEntry
Utilisez cet élément pour activer l'audit des événements de type générique. Il s'agit notamment des événements tels qu'Archiver et Associer.
eventType
enabled
handler
EventEntry
Utilisez cet élément pour activer l'audit des événements de type non générique, tels que Restaurer l'itération et Changement d'état du processus.
Le format de spécification d'un événement est <nom_d'événement>EventEntry. Par exemple, AccessControlEventEntry.
eventType
enabled
handler
KeyedEventEntry
Les attributs contenus dans KeyedEventEntry sont les suivants :
Elément
Attribut
Description
Type de données
Valeur
KeyedEventEntry
eventType
ou eventKey
Utilisez cet attribut pour spécifier un événement de type générique qui doit faire l'objet d'un audit. Spécifiez les événements sous la forme eventType ou eventKey, selon la façon dont ils sont exécutés dans votre installation de Windchill.
Chaîne
Cet attribut requiert une valeur. Vous pouvez définir une valeur telle que :
KeyedEventEntry eventKey="*/wt.sandbox.SandboxServiceCheckoutEvent/POST_SB_CHECKOUT_EVENT"
Enabled
Utilisez cet attribut pour activer l'audit d'un événement.
Booléen
Cet attribut requiert une valeur. Pour activer l'audit, la valeur doit être définie sur true.
Handler
Utilisez cet attribut pour spécifier la classe d'assistance qui fournit la méthode de consignation d'un événement spécifique.
Chaîne
Cet attribut requiert une valeur. Vous pouvez définir une valeur telle que :
handler="wt.audit.configaudit.TeamAuditMapEventRecorder"
EventEntry
Les attributs contenus dans EventEntry sont les suivants :
Elément
Attribut
Description
Type de données
Valeur
EventEntry
eventType
Utilisez cet attribut pour spécifier un événement de type non générique qui doit faire l'objet d'un audit. Les événements Changement d'état et Non autorisé constituent deux exemples d'événements non génériques. Pour plus d'informations sur les événements non génériques et sur leurs éléments EventEntry respectifs, consultez la section présentant la liste des événements non génériques et des éléments eventType.
Chaîne
Cet attribut requiert une valeur. Spécifiez un événement dont vous souhaitez effectuer l'audit au format suivant : <nom_d'événement>EventEntry.
Par exemple : 
AccessControlEventEntry eventType="NOT_AUTHORIZED"
.
Enabled
Utilisez cet attribut pour activer l'audit d'un événement.
Booléen
Cet attribut requiert une valeur. Pour activer l'audit, définissez la valeur sur true.
Handler
Utilisez cet attribut pour spécifier la classe d'assistance qui fournit la méthode de consignation d'un événement spécifique.
Chaîne
Cet attribut requiert une valeur. Spécifiez une classe d'assistance qui fournit la méthode de consignation d'un événement spécifique.
Par exemple : 
handler="wt.audit.configaudit.TeamAuditMapEventRecorder"
.
Extrait de code utilisant l'élément 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>