configAudit.xml 中的標籤及其含意

特定管理 > 分析系統與企業資訊 > 稽核管理 > 關於 configAudit XML 檔案 > configAudit.xml 中的標籤及其含意

configAudit.xml 中的標籤及其含意

configAudit.xml 結構描述包含下列元素：

EventConfiguration
|
|— KeyEntry
|— ConfigEntry
|
|— KeyedEventEntry
|— EventEntry

將父元素 EventConfiguration 設定為 true 可針對應用程式中的所有事件啟用稽核。

<EventConfiguration enabled="true">
</EventConfiguration>

若要自由地稽核事件，您必須自訂啟用的稽核事件。依預設，將 EventConfiguration 設定為 false，會禁用稽核。

元素	子元素	描述	屬性
EventConfiguration	KeyEntry	使用此元素可新增需要稽核的事件。	• eventKey • multiObject
EventConfiguration	ConfigEntry	使用此元素可稽核特定類型的事件或所有類型的事件。	• class • enabled

• KeyEntry

包含在 KeyEntry 中的子元素及其屬性如下︰

元素	屬性	描述 (Description)	資料類型	值
KeyEntry	eventKey	使用此屬性可新增需要稽核的事件。	字串	指定需要稽核的事件。此屬性的值為必填。舉例來說， eventKey="*/wt.team.TeamServiceEvent/REMOVE_ROLE"
KeyEntry	multiObject	可使用此屬性指定事件是單一物件事件還是多物件事件。	布林值	預設值為 false。如果設定為 true，會將事件視為多物件事件。如果未指定值，會使用預設值 false，且會將事件視為單一物件事件。

以下是一段使用 KeyEntry 的程式碼片段，其將記錄「從前後關聯小組移除角色」事件：

<EventConfiguration enabled="false">
<KeyEntry eventKey="*/wt.team.TeamServiceEvent/REMOVE_ROLE" multiObject="true"/>
</EventConfiguration>

如需有關事件及其各自 eventKey 的資訊，請參閱事件與 eventKey 清單一節。

• ConfigEntry

將 ConfigEntry 設定為 true 可啟用特定類型稽核。如果未針對 ConfigEntry 指定類別，將會記錄所有事件，不論類型為何。如果指定了類別，則會稽核與所述類型對應的事件。類別範例為 wt.org.WTGroup 或 wt.team.RolePrincipalMap。包含在 ConfigEntry 中的子元素及其屬性如下︰

元素	子元素	描述	屬性
ConfigEntry	KeyedEventEntry	使用此元素可對泛用類型事件啟用稽核。例如，「封存」與「關聯」事件。	• eventType • enabled • handler
ConfigEntry	EventEntry	使用此元素可對非泛用類型事件啟用稽核，例如「回復版序」與「工作流程狀態變更」。用來指定事件的格式為 <事件名稱>EventEntry。例如，AccessControlEventEntry。	• eventType • enabled • handler

◦ KeyedEventEntry

包含在 KeyedEventEntry 中的屬性如下︰

元素	屬性	描述 (Description)	資料類型	值
KeyedEventEntry	eventType 或eventKey	使用此屬性可指定需要稽核的泛用類型事件。請根據事件在安裝 Windchill 時的執行方式將事件指定為 eventType 或 eventKey。	字串	此屬性的值為必填。您可以定義值，例如︰ KeyedEventEntry eventKey="*/wt.sandbox.SandboxServiceCheckoutEvent/POST_SB_CHECKOUT_EVENT"
	Enabled	使用此屬性可啟用事件稽核。	布林值	此屬性的值為必填。欲啟用稽核，必須將值設定為 true。
	Handler	使用此屬性可指定提供特定事件記錄方法的 helper 類別。	字串	此屬性的值為必填。您可以定義值，例如︰ handler="wt.audit.configaudit.TeamAuditMapEventRecorder"

◦ EventEntry

包含在 EventEntry 中的屬性如下︰

元素	屬性	描述 (Description)	資料類型	值
EventEntry	eventType	使用此屬性可指定需要稽核的非泛用類型事件。非泛用事件的範例為 STATUS_CHANGE 或 NOT_AUTHORIZED。如需有關非泛用事件及其各自 EventEntry 的資訊，請參閱非泛用事件與 eventType 清單一節。	字串	此屬性的值為必填。請以下列格式指定要稽核的事件：<事件名稱>EventEntry。例如， AccessControlEventEntry eventType="NOT_AUTHORIZED"
	Enabled	使用此屬性可啟用事件稽核。	布林值	此屬性的值為必填。欲啟用稽核，請將值設定為 true。
	Handler	使用此屬性可指定提供特定事件記錄方法的 helper 類別。	字串	此屬性的值為必填。請指定提供特定事件記錄方法的 helper 類別。例如， handler="wt.audit.configaudit.TeamAuditMapEventRecorder"

使用 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>