Audit Archive, Export, and Clean-up Operations
The audit subsystem provides both online and offline storage for audit messages:
• Online—Individual entries are displayed online and are searchable using the QueryAuditHistory service of the audit subsystem.
• Offline—In the context of the audit subsystem, “offline” means that audit data is not available to be retrieved and seen in ThingWorx Composer, nor can it be retrieved using the QueryAuditHistory service. The data is archived in files that are stored in the file repository of the audit subsystem, called AuditArchiveFileRepository. It is possible to export these files from the repository. Permissions to this repository can be set to restrict access to the data. The data is exported in JSON format and compressed.
To maintain a controlled amount of online data and maintain performance while searching and filtering online audit data, the audit subsystem provides archive operations, scheduled and manual. To allow administrators to monitor activities when troubleshooting or examining activity for purposes of reporting, the audit subsystem provides export operations for both online and offline data. The export operation pushes the requested data to a target destination on request.
The archive operation is run on a schedule and can also be invoked manually. The archive operation copies online data to the offline storage, ensuring that the online data is copied before the archive operation. For more information about the archive operation, see
Exporting Audit Data. That section includes a
Sample Application for Exporting Audit Data.
As of v.8.5 of ThingWorx Platform, the archive and purge operations are separate. The archive operation continues to run on a schedule and can still be invoked manually. It no longer purges data. Instead, the purge operation is a service that has its own scheduler. This scheduler triggers the purge operation based on the time range and chunk size configured in the scheduler. The default schedule is every day at midnight.
For more information about archive and purge operations, see
Archiving and Purging Audit Data.
The audit subsystem provides a service that automatically cleans up the offline archive, based on a configured retention time and a scheduler. For more information, see
Clean-up of the Audit Archives.