自訂稽核類別
稽核子系統提供一組固定的可用稽核類別。系統已將由 ThingWorx Platform 中事件觸發的稽核訊息指派給這些類別。您無法變更這些指派。但是,如果需要不在此集合中的類別,您可建立自訂類別,並將自訂事件與稽核訊息指派給類別。
如何透過當地語系化表新增自訂稽核類別
稽核子系統的兩個實行提供下列方式,供您新增自訂稽核類別:
• 透過 ThingWorx 當地語系化表,使用 ThingWorx Composer 進行修改。
• 透過為 ThingWorx Platform 建立新的後端 Java 延伸功能。欲使用 ThingWorx Java SDK 建立自訂稽核類別來基於此目的建立延伸功能,請參閱
使用延伸功能建立自訂稽核類別。此方法仍使用當地語系化表,但您可以透過 Composer 使用者介面以程式設計或互動方式建立權杖,如下所述。
此部份內容說明如何透過當地語系化表使用者介面在 ThingWorx Platform 側新增自訂類別。如果您從未用過 ThingWorx 當地語系化表,請先花幾分鐘時間閱讀一下本說明中心的
當地語系化表主題。
準備就緒後,請遵循下列步驟來將自訂稽核類別新增至當地語系化表:
1. 登入 ThingWorx Composer 並按一下
![](../../../../../ThingWorx/images/thingworx.1.387.01.jpg)
(
「瀏覽」)。
2. 在「瀏覽」導覽面板中的「系統」下,選取「當地語系化表」,如下圖所示:
「當地語系化表」清單隨即顯示:
3. 選取「預設」當地語系化表的核取方塊,當其變為使用中狀態後,按一下「編輯」按鈕,來以「編輯」模式顯示該表格,如下所示:
「預設」當地語系化表的「當地語系化權杖」頁即會以「編輯」模式顯示:
4. 如下圖所示,按一下 +「新增」來為您的自訂稽核類別新增當地語系化權杖:
「新當地語系化權杖」頁即會顯示在畫面右側:
5. 在「名稱」欄位中,您必須先鍵入稽核類別當地語系化權杖的前綴 audit.AuditCategory.,然後再鍵入具唯一性的名稱。用於自訂類別的名稱必須具唯一性。例如,audit.AuditCategory.CustomAlertCategory。
| 只要權杖有效,QueryAuditHistory 與 QueryAuditHistoryWithQueryCriteria 服務就會傳回包含或不含前綴的自訂稽核訊息。但是,如果您不使用前綴,子系統便無法區分「稽核類別」權杖與「其他」權杖。此外,如果要讓稽核子系統在稽核記錄使用者介面的類別清單中顯示自訂稽核類別,每個自訂稽核類別都必須使用前綴 audit.AuditCategory.。 |
6. 在「權杖值」欄位中,您可以使用您認為適合類別的任何內容。例如,可使用您在前綴後鍵入之名稱的一部份。您也可以使用任何字母數字字元、空格及底線。
請注意,在其他語言的當地語系化表中,「權杖值」會變成此權杖的「參考值」。
7. 欲儲存此當地語系化權杖,然後為您的稽核訊息建立當地語系化權杖,請按一下
![](../../../../../ThingWorx/images/thingworx.1.387.07.jpg)
並繼續下一個步驟。如果您要在此停止,請按一下
![](../../../../../ThingWorx/images/thingworx.1.387.08.jpg)
,儲存並關閉頁面。
| 如果您在未於其他當地語系化表中定義此當地語系化權杖的情況下進行查詢,查詢服務只會傳回您已建立的內容。將權杖新增至其他當地語系化表後,結果將會包括其他語言。如果您尚未為自訂稽核訊息定義權杖,查詢則找不到它。 |
接下來,您要將自訂稽核訊息的當地語系化權杖新增至「預設」當地語系化表。
8. 如果您已關閉頁面,請按一下「新增」,再次顯示「新當地語系化權杖」頁。否則,請繼續進行下一個步驟。
9. 在「權杖名稱」欄位中,為自訂稽核訊息權杖鍵入具唯一性的前綴與名稱。請勿使用 audit.AuditCategory 作為前綴。自訂稽核訊息的名稱必須具唯一性。例如,myCustomAlertMessages.AlertEvent。
| 前綴 audit.AuditCategory 只會針對類別保留。如果您將該前綴用於訊息,則可能會將該訊息解譯為類別,而且其會在稽核記錄使用者介面中顯示為類別,而不是訊息。 |
對於自訂稽核訊息,您需要 ThingWorx 使用者介面中未提供的其他資訊。該資訊是自訂稽核訊息的引數。例如,您的引數可能是 thingName 與 alertEventMsg,其範例值為 mixer123 與 overflow。您可以在訊息的「權杖值」中指定此類引數。當稽核查詢產生並傳回自訂稽核訊息時,會取代這些值。例如「實體檔案匯入已成功完成」這類的簡單訊息便不需要指定任何引數。
10. 在「權杖值」欄位中,新增稽核訊息的引數。每個引數都必須在前後各加兩條底線。例如,假設用來移除 User 的自訂稽核訊息具有下列引數
◦ username
◦ entityType
◦ entityName
您需要在「權杖值」欄位中輸入下列內容:
User __username__ removed __entityType__ named '__entityName__'
在執行時間,只要自訂稽核訊息引數中存在對應值,就會取代這三個引數。
| 某些訊息不需要使用引數。例如,像是「實體檔案匯入已成功完成」這樣的簡單訊息便不會使用取代項。 |
11. 按一下
![](../../../../../ThingWorx/images/thingworx.1.387.09.jpg)
,儲存並關閉頁面。
12. 欲測試自訂稽核類別與訊息的新增,請觸發產生訊息的事件,然後執行 QueryAuditHistory 或 QueryAuditHistoryWithQueryCriteria 服務,指定要傳回的地區設定。請記住,您必須針對具有 QueryAuditHistoryWithQueryCriteria 服務的類別使用當地語系化權杖。
接下來,您需要將自訂稽核類別與訊息的當地語系化權杖新增至每個所需地區設定的當地語系化表。例如,ja (針對日文) 或 de (針對德文)。
請遵循以下步驟:
1. 按一下「瀏覽」標籤,返回當地語系化表清單,並選擇不同的地區設定。例如,選取 ja (日文) 並按一下「編輯」,如下所示:
2. 在 ja 地區設定的「當地語系化權杖」頁中,找到您剛剛針對自訂稽核類別建立的當地語系化權杖。
| 欲快速找到權杖,請使用清單最上方的「篩選器」。開始在權杖名稱中鍵入字詞。例如,如果您在名稱中使用了 "MyCustom",則如下圖所示開始在篩選器欄位中鍵入。包含該字詞的所有當地語系化權杖都會顯示出來。 |
3. 按一下自訂稽核類別權杖的名稱,以在標籤右側顯示其編輯頁,如上圖所示。
4. 在「權杖值」欄位中,輸入您在「預設」地區設定中用於此類別之「權杖值」的已翻譯值。
5. 按一下
![](../../../../../ThingWorx/images/thingworx.1.387.12.jpg)
,儲存並關閉編輯頁。
6. 在當地語系化權杖清單中,使用「篩選器」找到您在「預設」地區設定中針對自訂稽核訊息建立之權杖的名稱,然後按一下該名稱來在標籤右側顯示其編輯頁。
7. 在「權杖值」欄位中,新增訊息的翻譯部份,並在適用時,新增稽核訊息的已翻譯引數名稱。與「預設」地區設定的權杖值一樣,每個引數都必須在前後各加兩條底線。
8. 按一下
![](../../../../../ThingWorx/images/thingworx.1.387.13.jpg)
,儲存並關閉編輯頁。
9. 欲測試自訂稽核類別與訊息的新增,請觸發產生訊息的事件,然後執行 QueryAuditHistory 或 QueryAuditHistoryWithQueryCriteria 服務,指定要傳回的地區設定。請記住,您必須為類別指定當地語系化權杖,而不是為名稱指定。
| 如果使用 ThingWorx Java API,透過一個延伸功能,您即可完成所有操作。您可以建立要稽核的事件,然後將自訂稽核類別與自訂稽核訊息新增至當地語系化表,針對通用英文為「預設」,然後再新增至您需要之其他任何地區設定的表格。您也可以將匯入當地語系化表作為匯入延伸功能的一部份執行。 如需有關透過程式設計方式新增事件的資訊,請參閱本說明中心「開發應用程式的最佳作法」部份的 使用事件、警示與訂閱。您也應該參閱 ThingWorx API 的 Javadoc,即 API 文件集。 |