IBM Enterprise Records, Version 5.1.2    

Auditing RM entities

The RM API framework makes it possible to audit various actions performed on RM entities.

If the auditing feature has been enabled for an RMObjectStore, an audit log is created each time an action is performed on the entity. This audit log contains information, such as the user performing the action, the date and time on which the action was performed, the type of action, reason for performing the action, and the description.

The RM API audits the RecordCategory, RecordFolder, Volume, and RecordInfo objects, with respect to the following actions:

To enable auditing for RM objects, the RM has defined the RMAudit class. RMAudit class is imported with the RM data model and is subscribed as an audit definition to RM entities when these actions are performed. This class extends from the Content Platform Engine CustomEvent class, and provides the metadata for storing the audit information. The RM API calls the raiseEvent() method of the Content Java™ API to audit RM objects for specific action events.

RMAudit calls the auditEvent() method on the RMUtil class after a particular event has occurred, and is successfully completed. This method invokes raiseEvent() through an instance of the RM object on which the action has been performed. It passes the classId of the RMAudit class and the properties collection of the required metadata for the audit entry. The property collection contains information about the following metadata fields:
Important: The description of the action is generated and passed only if the action type is Relocate. This metadata contains the source and the destination location where the RM entity has been moved in the file plan hierarchy.

You can use the auditEvent() method to audit objects other than RecordCategory, RecordFolder, Volume and RecordInfo. For this, you need to subscribe the RMAudit audit definition to the required class. By default, the RM API subscribes RMAudit for the RecordCategory, RecordFolder, Volume, and RecordInfo objects.



Feedback

Last updated: November 2013
ierdg022.htm

© Copyright IBM Corporation 2013