InfoSphere Optim Audit Reporting Utility

Users of certain IBM InfoSphere Optim solutions can enable process audit for these solutions. Process audit collects information on each request that is processed by your InfoSphere Optim solution, such as the type of request and the user who initiated it. Audit records are then written to an audit document, which is an XML file that is located in the Optim Directory audit table. Administrators can manually unload the audit document from the audit table and generate audit reports that are based on the information in the audit document.

Sheshnarayan Agrawal (, Software Architect, IBM

Shesh Agrawal photoSheshnaraya Agrawal (Shesh) works at IBM India Lab, Bangalore. Shesh has more than 13 years of IT experience. In his current role, Shesh is lead engineer for IBM Optim's distributed product at India Software Lab. Shesh is "Patent Plateau" holder in IBM. Shesh holds Masters Degree in Computer Science. Prior to the Optim responsibility, Shesh worked on IBM Informix CSDK (Client Software Development Kit) development for more than 8 years. Shesh has presented on various topics on Optim and Informix at various national and international conferences such as IOD Las Vegas, IIUG Lenexa, and Software Universe.

Mark Ploegstra (, Information Developer, IBM

Mark Ploegstra photoMark Ploegstra is an information developer based in IBM's office in Princeton, NJ. He has over 20 years of experience in writing about computer software and hardware.

12 January 2012

Alternatively, administrators can download and use the Audit Reporting Utility. The Audit Reporting Utility is a stand-alone command-line utility that can unload audit records from the audit document in the Optim™ Directory and load audit records into a separate XML document in a different, user-defined database. By default, the audit records are loaded into a single XML document. Optionally, you can specify that each audit record is saved within its own XML document in its own database row. The XML documents can also be saved to a file system. You can limit the audit records that are unloaded by request type or by request date.

Process audit and the Audit Reporting Utility is supported on version 7.3 and later of the following products:

  • IBM® InfoSphere® Optim Data Growth Solution
  • IBM InfoSphere Optim Test Data Management Solution
  • IBM InfoSphere Optim Data Masking Solution

The Audit Reporting Utility is available only for Windows® XP and later.

The Audit Reporting Utility can unload audit documents from Optim Directories that are located on the following relational database systems. The relational database system can be on any operating system that is supported by your InfoSphere Optim solution.

  • DB2® for Linux®, UNIX®, and Windows
  • Oracle
  • Informix®

Before you use the Audit Reporting Utility, you must configure the Optim Directory database as an ODBC System Data Source Name in the Windows ODBC Data Source Administrator.

Command syntax

To use this utility, enter the following command at the command prompt. Do not use spaces between the parameter names, the equals signs, and the parameter values.

<<-optim_audit_report.exe-- -dbtype=-+-oracle---+---------------<
   '--dsn=sourcedsnname-'  '--userid=userid-'   
   '--password=password-'  |           .-,-----------. |   
                           |           V .-ALL-----. | |   
   '--TableName=targettablename-'  |                .-No--. |   
   |                          .-No--.                                  |   
  • -dbtype= indicates the relational database system that is used by the Optim Directory.
  • -dsn=indicates the ODBC system data source that contains the Optim Directory. By default, the utility uses audit_dsn.
  • -userid= indicates the user ID that is used to access the ODBC system data source that contains the Optim Directory. By default, the utility uses the user ID that is configured in the ODBC system data source.
  • -password= indicates the password that is used to access the ODBC system data source that contains the Optim Directory. By default, the utility uses the password that is configured in the ODBC system data source.
  • -ReqType= indicates the request types whose audit records you want to unload. By default, all request types are unloaded. You can request multiple request types by separating the request types with commas.
  • -DateFrom= and -DateTo= indicate the date range of audit records that you want to unload. Enter the dates in YYYY-MM-DD format. By default, the utility unloads audit records without regard to date.
  • -TableName= indicates the name of the table to which you want to load the audit records. The utility creates this table if it does not already exist.
  • -DeleteRecord= indicates whether any existing audit records are deleted from the table before the new audit records are loaded. By default, the utility does not delete the old records from the table.
  • -GenerateUniqueXMLFiles= indicates whether the audit records are to be saved to separate XML files instead of to a single XML file. When you generate an XML file for each audit record, the XML files are named with the format <request_type><sequential_number>.XML. For example, ARCHIVE1.XML. By default, the utility loads all audit records to a single XML file, which is stored on a single row of the database.
  • -Location= indicates the file system directory to which the audit records will be saved. By default, audit records are not saved to a file system directory. You can save audit records to a file system directory only if a separate XML file is generated for each audit record (-GenerateUniqueXMLFiles=Yes).

For help on the utility parameters, enter the following command:

optim_audit_report.exe –help


When you enter the following command, the utility unloads the audit document from the Optim Directory in the ora_dsn ODBC system data source, which is an Oracle database. The utility then extracts the audit records for archive, extract, and browse requests that were generated between June 1, 2011 and January 14, 2011. The utility then loads these audit records to the table AuditTable2011Jan. The utility creates the AuditTable2011Jan table if the table does not already exist. If the AuditTable2011Jan table already exists, the utility deletes all existing audit records from this table before the utility loads the new audit records to the table. The utility creates a separate XML document for each audit record and saves each XML document on its own row in the AuditTable2011Jan table. The utility also saves all XML documents to the c:\temp directory.

optim_audit_report.exe -dbtype=oracle -dsn=ora_dsn -ReqType=Archive,Extract,Browse -DateFrom=2011-06-01 -DateTo=2011-01-14 -TableName=AuditTable2011Jan -DeleteRecord=Yes -GenerateUniqueXMLFiles=Yes -Location=c:\temp


InfoSphere Optim Audit Reporting UtilityOptim_Audit_Tool.zip80KB


Zone=Information Management
SummaryTitle=InfoSphere Optim Audit Reporting Utility