Documentum Audit Trail Scanner

Introduction

The Documentum Audit Trail Scanner extracts Documentum audit trail objects independently from document objects.

The scanner is available as the DocumentumAuditTrail adapter type. It creates source objects of type Documentum(audittrail) in auditObjects scanning mode or it creates Documentum(document) objects with a PDF rendition as content in the pdfPerDocumentVersion and pdfPerVersionTree scan modes.

It reuses the existing Documentum scanner behavior, and common parameters are unchanged. For supported Documentum Content Server versions, DFC configuration, scanner handling in WebClient, DQL usage, ID file usage, and general audit trail concepts, see the Documentum Scanner guide.

Scanner Configuration

To create a new Documentum Audit Trail Scanner job, specify the respective adapter type in the Scanner Properties window - from the list of available connectors DocumentumAuditTrail must be selected. Once the adapter type has been selected, the Parameters list will be populated with the parameters specific to the selected adapter type.

The Properties window of a scanner can be accessed by double-clicking a scanner in the list or selecting the Properties button/menu item from the toolbar/context menu.

A detailed description is always displayed at the bottom of the window for the currently selected parameter.

Scanner Parameters

The common adaptor parameters are described in Common Parameters.

The configuration parameters available for the Documentum Audit Trail Scanner are described below:

• username* Username for connecting to the source repository. The user must have permissions to read the selected documents and audit trail entries. A super user account is recommended.

• password* The user's password.

• repository* Name of the source repository. The source repository must be accessible from the machine where the selected Job Server is running.

• idsFilePath Path to a file containing the IDs of the documents whose audit trails should be scanned. The IDs can be delimited by comma, semicolon, or new line. When this parameter is set, dqlString must be empty.

• dqlString The DQL statement used to retrieve the r_object_id values of the documents whose audit trails should be scanned. The validation rules are the same as for the Documentum Scanner. When includeAllVersions is checked, the query must start with select r_object_id or select distinct r_object_id.

• auditTrailScanMode Determines how selected audit trails are saved in migration-center. Possible values are auditObjects, pdfPerDocumentVersion, and pdfPerVersionTree. The default value is auditObjects.

• includeAllVersions Flag indicating if audit trails should be scanned for the entire selected document version tree. This parameter is used by the auditObjects and pdfPerDocumentVersion scan modes.

• scanNullAttributes Flag indicating whether audit trail attributes with null values should be scanned. By default, this option is unchecked in order to reduce database usage.

• auditTrailType Documentum audit trail object type. The default value is dm_audittrail. Custom audit trail types derived from dm_audittrail are supported.

• auditTrailSelection DQL WHERE condition for selecting the audit trail objects. Leave it empty to select all audit trail entries for the selected documents. Example: event_name in ('dm_save', 'dm_checkin')

• auditTrailIgnoreAttributes List of audit trail attributes that will be ignored by the scanner.

• auditedDocumentAttributes Multi-value list of audited document attributes that should be added as metadata to generated PDF objects. This parameter is used only when auditTrailScanMode is pdfPerDocumentVersion or pdfPerVersionTree.

• exportLocation The location where generated PDF files should be saved. This parameter is required when auditTrailScanMode is pdfPerDocumentVersion or pdfPerVersionTree.

• loggingLevel* See Common Parameters.

Parameters marked with an asterisk (*) are mandatory.

Working with Documentum Audit Trail Scanner

The scanner selects the audited documents using dqlString or idsFilePath. These parameters are mutually exclusive.

The scanner then selects the matching audit trails from auditTrailType, optionally filtered by auditTrailSelection.

The scanner does not export the content of the selected documents. It scans audit trail data either as audit trail objects or as generated PDF document objects.

Scan modes

auditObjects

When auditTrailScanMode is set to auditObjects, the scanner creates one Documentum(audittrail) object for each selected audit trail.

The audit trail r_object_id is used as the object's id_in_source_system.

pdfPerDocumentVersion

When auditTrailScanMode is set to pdfPerDocumentVersion, the scanner creates one Documentum(document) object for each selected document version that has selected audit trails.

The generated object content is a PDF containing all selected audit trails for that document version. The object id_in_source_system is <r_object_id>_audit. The generated PDF is written under exportLocation and the path is saved in the content_location system attribute.

The generated object contains the source attributes latestAuditTrailId, audited_doc_i_chronicle_id, and audited_doc_r_object_id.

If no audit trails match a selected document version, no PDF object is created for that version.

pdfPerVersionTree

When auditTrailScanMode is set to pdfPerVersionTree, the scanner groups selected audit trails by i_chronicle_id and creates one Documentum(document) object for each version tree that has selected audit trails .

The generated object content is a PDF containing all selected audit trails for the version tree. The object id_in_source_system is <i_chronicle_id>_audit_vt. The generated PDF is written under exportLocation and the path is saved in the content_location system attribute.

The generated object contains the source attributes latestAuditTrailId, audited_doc_i_chronicle_id, and audited_doc_r_object_id.

If no audit trails match a selected version tree, no PDF object is created for that version tree.

Delta scans

The scanner can be run repeatedly. Re-running the scanner does not create duplicate audit trail objects for audit trails that were already scanned.

In auditObjects mode, only new selected audit trails are added as Documentum(audittrail) objects.

In pdfPerDocumentVersion mode, an update object with the same <r_object_id>_audit source system ID is generated only when new selected audit trails exist for that document version.

In pdfPerVersionTree mode, an update object with the same <i_chronicle_id>_audit_vt source system ID is generated only when new selected audit trails exist for that version tree.

Delta behavior respects auditTrailType, auditTrailSelection, dqlString, idsFilePath, and includeAllVersions.