ExtractAuditTrail

Extracts all audit trail records to a file and deletes the records afterwards

ExtractAuditTrail reads all audit trail records from the Identity Store and writes them to an external file through the Ident2AuditTrail output channel; once exported, the records are deleted from the Identity Store. The HistoryAgent performs both the export and the deletion in one run.

Run this workflow regularly — for example nightly — to keep the audit trail store compact and to archive change records in an external file for long-term storage and compliance purposes.

The workflows in this reference are delivered as factory data and are loaded into the Connectivity configuration database during the initial configuration. They are samples: use the Identity Manager to copy a workflow into your own scenario and adapt the copy. Do not change the delivered objects, because a product update can replace them.

At a Glance

Name

ExtractAuditTrail

Category

Identity Store

Technology

Tcl-based scheduled workflow

LDAP object class

dxmWorkflow

Workflow type

-

Connected system / controller type

-

Configuration wizard

LDAP-File

Active in the factory data

not set

Factory data version

7.0

Factory data path

Workflows/Default/Identity Store/ExtractAuditTrail

Prerequisites

  • The HistoryAgent must be deployed and configured in the C++-based Server.

  • The ExtractAuditTrailIn input channel and the Ident2AuditTrail output channel must be configured; the output channel specifies the target file and format for the exported records.

Workflow and Activities

Step Activity Description Agent Runs after

1

ExtractAuditTrail

Extracts all audit trail records to a file and deletes the records afterwards

HistoryAgent

start activity

Jobs and Agents

Activity Job Agent Operation Input channel Output channel

ExtractAuditTrail

ExtractAuditTrail

HistoryAgent

Full Import

ExtractAuditTrailIn

Ident2AuditTrail

Configuration Parameters

Table 1. Parameters of job ExtractAuditTrail
Parameter Default value

delta_mode

full

delta_on

0

trace

1

A Tcl-based workflow runs scheduled in the C++-based Server (IdS-C). Its activities run in the order defined by the dxmPredecessorActivity-DN chain, and each activity starts a job that runs one agent with one input and one output channel. Agents exchange their data through files or directly through the meta controller, so a typical workflow consists of an export activity that writes the data of the connected system and an import activity that maps and loads that data into the Identity Store.

You start these workflows manually from the Identity Manager or attach them to a schedule.

The workflow has a single activity, ExtractAuditTrail, which runs the HistoryAgent job of the same name. The job reads all audit trail records from the Identity Store through the ExtractAuditTrailIn input channel and exports them to a file through the Ident2AuditTrail output channel. After a successful export the records are deleted from the Identity Store.

Operation

  1. You start the workflow manually from the Identity Manager, attach it to a schedule, or trigger it as the SaveHistory activity in the CombinedMaintenance workflow.

  2. The C++-based Server starts the ExtractAuditTrail activity and launches the HistoryAgent job.

  3. The agent reads all audit trail records from the Identity Store through the ExtractAuditTrailIn input channel.

  4. The records are written to the external file specified by the Ident2AuditTrail output channel.

  5. After a successful export the agent deletes the exported records from the Identity Store, so subsequent runs only export new records.