ThingWorx 稽核訊息
本主題提供有關 ThingWorx 稽核訊息內容的詳細資訊,其包含以下幾部分:
稽核訊息的類型
「稽核子系統」會針對 ThingWorx Platform 中的不同活動產生訊息。訊息分為下列一般類型:
對物件的變更 - 稽核對實體諸如建立、刪除或修改的變更。實體可以是物件,也可以是非物件,例如子系統或組織。
對使用者的變更 - 稽核對使用者或應用程式金鑰諸如建立或修改的變更。
對物件的操作 - 稽核對實體的操作。範例包括物件的遠端工作階段活動 (通道傳輸)。
對系統的操作 - 在訊息不存在目標物件的情況下進行稽核,例如使用者登入與匯入/匯出操作。
稽核訊息包含稽核項目,其提供活動相關資訊。
* 
如需有關在安全性前後關聯中稽核切換的資訊,請參閱 稽核安全性前後關聯的轉換
稽核項目
每個稽核項目都由兩個元件組成,即「稽核類別金鑰」與「稽核訊息金鑰」。
「稽核類別金鑰」是一個當地語系化權杖,其可指定稽核訊息與之相關聯的功能區或類別。此金鑰為 STRING。如需類別清單,請參閱 稽核類別
「稽核訊息金鑰」是指向稽核訊息文字的當地語系化權杖。此金鑰為 STRING
每個元件的值都從對應內建事件定義或實例中提取。請注意,不支援稽核使用者定義的事件。
稽核訊息引數
稽核訊息提供用來產生本地化文字訊息與執行此操作之實體名稱的引數。替代名稱/值對的 ValueCollection 用來產生本地化文字訊息。會從事件實例的 eventData 欄位擷取此資訊。ThingWorx 實體 (例如物件或使用者) 與稽核訊息相關聯,包括執行屬於稽核訊息主旨之操作的人員或項目。
稽核類別
所有稽核項目都與稽核類別相關聯。稽核類別可讓您輕鬆篩選稽核資料,及查看某種類別之操作的活動趨勢。此外,稽核類別還可協助您偵測嘗試未經授權存取的情況,或 Edge 裝置無法連線至 ThingWorx Platform 的問題。
每個稽核項目都有一個類別,其會與稽核項目一起儲存為字串。顯示的稽核類別字串已本地化。根據使用者偏好的地區設定,稽核類別會以適當語言顯示。
下表列出並簡要說明了稽核子系統中的可用類別。
類別
描述
範例
當地語系化權杖
ANALYTICS
與分析實體有關的動作。由 ThingWorx Analytics 執行的操作。
對資料分析定義執行的建立、編輯、刪除操作。
ThingWorx Analytics 內的其他動作。
audit.AuditCategory.Analytics
AUTHENTICATION
與驗證有關的動作。
與使用應用程式金鑰相關之成功與失敗的使用者登入、使用者鎖定及錯誤。例如:Login successful for user: Administrator
audit.AuditCategory.Authentication
COLLABORATION
與協同合作實體有關的動作。
對部落格及 Wiki 執行的建立、編輯與刪除操作。
audit.AuditCategory.Collaboration
DATA_MANAGEMENT
與管理或使用資料有關的動作。
對資料執行的刪除操作。
audit.AuditCategory.DataManagement
DATA_STORAGE
與資料儲存實體及相關子系統有關的動作。
對資料表、串流及其他資料儲存實體執行的建立、編輯與刪除操作。
audit.AuditCategory.DataStorage
DEVICE_COMMUNICATION
與和 Edge 裝置通訊有關的動作與事件。
對「遠端物件」呼叫的重要服務 (RestartThingEnableThingDisableThing)。
會稽核 WSCommunicationSubsystemCloseWebSocketSessions 服務。如需有關服務的詳細資訊,請參閱 WebSocket 通訊子系統
audit.AuditCategory.DeviceCommunication
FILE_TRANSFER
與檔案上載與下載有關的動作及事件。
適用於檔案傳輸、成功完成傳輸、取消傳輸及在傳輸期間產生錯誤。
audit.AuditCategory.FileTransfer
IMPORT_EXPORT
與將資料匯入 ThingWorx 及將資料從中匯出有關的動作。
模型及資料匯入/匯出操作。
匯入延伸功能。
audit.AuditCategory.ImportExport
LIFECYCLE
與物件特定事件 (例如 ThingStart) 有關的動作
ThingStart 事件
audit.AuditCategory.Lifecycle
MODELING
與「建模」實體有關的動作。建立實體時,系統會產生包括指派給新實體之擁有者的稽核訊息。請注意,實體擁有者會自動設定為建立實體的使用者名稱。
當使用任何建立實體的方式時,系統都會產生稽核訊息:
在 Composer 中透過 PUT 呼叫
透過對 Create API、Clone API 或 SetOwnerAPI 的呼叫
任何有權檢視稽核子系統的使用者都可以檢視有關擁有權變更的報告。
對「物件」、「物範本」、「物形式」、「資料形式」、網路、專案、模型、標籤執行的建立、編輯、刪除操作。
稽核訊息的格式為:
"Created <Source Type> <Source> with owner <username of owner>."
其中:
Source Type 是所建立的實體種類。例如,物件。
Source 是新實體的名稱。
owner 會顯示執行建立動作之使用者的 username
類別金鑰:audit.AuditCategory.Modeling
訊息金鑰為:audit.EntityLifecycle.Create
REMOTE_ACCESS
與遠端存取 (通道傳輸) 有關的動作。
工作階段開始/結束 (TunnelSession 事件),取消工作階段。
audit.AuditCategory.RemoteAccess
SCM (Software Content Management)
與封裝、部署及組態變更有關的動作。
建立、編輯、發佈及刪除封裝。建立、開始、轉移及刪除部署。包括測試與實際部署、針對測試部署指定的資產,以及成功或失敗的封裝安裝。自動清除與同步部署的組態變更。
audit.AuditCategory.SoftwareManagement
SECURITY_CONFIGURATION
與安全性實體及權限 (包括使用者、使用者群組、物群組、組織、應用程式金鑰、目錄服務以及驗證器) 有關的動作。
當實體的擁有權變更時,會產生稽核訊息。您可透過 Composer 、透過 API 呼叫或透過匯入實體 XML 檔案來變更擁有者
在下列情況下,不會產生擁有權稽核訊息:
稽核子系統已禁用。
實體已更新,但擁有權未變更。
SetOwner API 呼叫設定了已是實體擁有者的相同擁有者。
對使用者、使用者群組、物群組、組織、應用程式金鑰、目錄服務及驗證器執行的建立、編輯與刪除操作。
可以追蹤使用者群組變更。當將使用者或或使用者群組新增為另一個使用者群組的成員時,會產生 audit.Groups.Added 項目。當從使用者群組移除使用者或使用者群組時,會產生 audit.Groups.Removed 實體。
實體權限變更 (所有實體類型)。請參閱上述稽核安全性前後關聯的轉換部份。
擁有權變更稽核訊息的一般格式如下:
"Owner for <Source Type> <Source> changed from <original owner username> to <new owner username>."
其中:
Source Type 是其擁有者已變更之實體的種類。例如,物件。
Source 是其擁有者已變更之實體的名稱。
original owner username 會顯示執行變更動作之使用者的 username
new owner username 是新擁有者的 username
類別金鑰:audit.AuditCategory.SecurityConfiguration
訊息金鑰:
audit.Groups.Added
audit.Groups.Removed
audit.entity.ownership.change
管理員在「使用者管理子系統」中啟用及禁用物群組可見度權限委派
稽核操作與稽核訊息如下:
管理員已在「使用者管理子系統」中啟用物群組可見度權限委派 - 稽核訊息為「已啟用物群組可見度權限委派」。
管理員已在「使用者管理子系統」中禁用物群組可見度權限委派 - 稽核訊息為「已禁用物群組可見度權限委派」。
類別金鑰:audit.AuditCategory.SecurityConfiguration
訊息金鑰:
com.thingworx.thinggroups.ThingGroup.VisibilityPermissionDelegationEnabled
com.thingworx.thinggroups.ThingGroup.VisibilityPermissionDelegationDisabled
SYSTEM
與系統實體有關的動作。
對當地語系化表、資源、子系統及記錄檔執行的建立、編輯與刪除操作。
子系統組態變更與動作,包括啟動、停止與重新啟動。所有子系統相關項目都在此類別中,根本不會顯示在其他類別中。
* 
重新啟動操作會產生二或三個稽核訊息,具體視呼叫重新啟動時子系統的狀態而定。如果子系統的狀況是 RUNNING,會寫入三個訊息,重新啟動、停止與啟動各一個。如果子系統的狀況不是 RUNNING,則會寫入兩個訊息,重新啟動與啟動各一個。在此情況下,不會執行停止動作。
audit.AuditCategory.System
VISUALIZATION
與「視覺化」實體有關的動作。
對混搭、主物件、小工具、儀表板、選單、媒體實體、樣式定義及狀態定義執行的建立、編輯與刪除操作。
audit.AuditCategory.Visualization