Process audit reporting

Use the optim_audit_report.exe utility to extract audit data from the Optim™ Directory audit table into XML documents that can be parsed to generate reports.

The utility can save the audit data to an XML document that is stored in a row of a user-specified table within your Optim Directory database. The utility can also save the audit data to your local file system as XML documents.

The utility is in the install_folder\rt\bin directory on Microsoft Windows computers, where install_folder is the Optim installation folder. For example, if Optim is installed in C:\IBM\InfoSphere\Optim, the utility is at C:\IBM\InfoSphere\Optim\rt\bin\optim_audit_report.exe.

Requirements

The utility can run only on versions of Microsoft Windows that are supported by your Infosphere Optim solution.

The Audit Reporting Utility can extract audit data from Optim Directories that are 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
  • DB2 for z/OS®
  • Oracle
  • Informix®
Before you use the optim_audit_report.exe utility, configure the Optim Directory database as an ODBC System Data Source Name in the Windows ODBC Data Source Administrator. For more information about how to configure ODBC data sources on a Windows computer, click Start > Help and Support in Windows and search for ODBC Data Source Administrator.

Command structure

The following syntax diagram illustrates how to enter parameters with the optim_audit_report.exe utility.

Read syntax diagramSkip visual syntax diagram
Process audit reporting command

>>-optim_audit_report.exe-- -dbtype=--+-oracle---+--+-----------------------+-->
                                      +-db2------+  '- -dsn=--sourcedsnname-'   
                                      '-informix-'                              

>--+-------------------+--+-----------------------+--+-----------------------------+-->
   '- -userid=--userid-'  '- -password=--password-'  |             .-,-----------. |   
                                                     |             V .-all-----. | |   
                                                     '- -reqtype=----+-archive-+-+-'   
                                                                     +-browse--+       
                                                                     +-convert-+       
                                                                     +-compare-+       
                                                                     +-create--+       
                                                                     +-delete--+       
                                                                     +-export--+       
                                                                     +-extract-+       
                                                                     +-edit----+       
                                                                     +-import--+       
                                                                     +-insert--+       
                                                                     +-load----+       
                                                                     +-odm-----+       
                                                                     +-report--+       
                                                                     '-restore-'       

>--+-----------------------------+--+-------------------------+--+-------------------------------+-->
   '- -dbaliasname=--dbaliasname-'  '- -creatorid=--creatorid-'  '- -starttable=--starttablename-'   

>--+-------------------------+--+-----------------------+------->
   '- -datefrom=--YYYY-MM-DD-'  '- -dateto=--YYYY-MM-DD-'   

>--+-------------------------------------------------------------+-->
   '- -tablename=--targettablename--+--------------------------+-'   
                                    |                  .-no--. |     
                                    '- -deleterecord=--+-yes-+-'     

>--+-------------------------------------------------------------------------+-><
   |                            .-no--.                                      |   
   '- -generateuniquexmlfiles=--+-yes-+--+---------------------------------+-'   
                                         '- -location=--targetlocationname-'     

Parameters

Use the following parameters to specify how the optim_audit_report.exe utility extracts audit data from the Optim Directory audit table.
-dbtype=
The parameter -dbtype= indicates the relational database system that is used by the Optim Directory.
-dsn=
The parameter -dsn= indicates the ODBC system data source that contains the Optim Directory. By default, the utility uses audit_dsn.
-userid=
The parameter -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=
The parameter -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=
The parameter -reqtype= indicates the request types whose audit records you want to unload. By default, all request types are extracted. You can request multiple request types by separating the request types with commas.
-dbaliasname=
The parameter -dbaliasname= indicates the DB alias table qualifier that is associated with the request. By default, the utility extracts audit records without regard to DB alias. Use the percent (%) wildcard to represent one or more characters. For example, if you enter -dbaliasname=d%, the utility extracts audit records with DB aliases that begin with d.
-creatorid=
The parameter -creatorid= indicates the creator ID table qualifier that is associated with the request. By default, the utility extracts audit records without regard to creator ID. Use the percent (%) wildcard to represent one or more characters. For example, if you enter -creatorid=d%, the utility extracts audit records with creator IDs that begin with d.
-starttable=
The parameter -starttable= indicates the name of the start table that is associated with the request. By default, the utility extracts audit records without regard to start table. Use the percent (%) wildcard to represent one or more characters. For example, if you enter -starttable=s%, the utility extracts audit records with start table names that begin with s.
-datefrom= and -dateto=
The parameters -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 extracts audit records without regard to date.
-tablename=
The parameter -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 exist.
-deleterecord=
The parameter -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=
The parameter -generateuniquexmlfiles= indicates whether each audit record is to be saved to a separate XML file on the local file system. When you generate an XML file for each audit record, each XML file name contains the request type, a sequential number, and the suffix .XML. For example, ARCHIVE1.XML.Regardless of how this parameter is set, the utility always saves audit records to a single XML file that is stored in the specified database table.
-location=
The parameter -location= indicates the file system directory to which the audit records are saved. You can save audit records to a file system directory only if a separate XML file is generated for each audit record (-generateuniquexmlfiles=yes). By default, the XML files are saved in the same directory as the optim_audit_report.exe utility.
To see the version number of the utility, enter the following command:
optim_audit_report.exe –version
To see help on the utility parameters, enter the following command:
optim_audit_report.exe –help

Example

When you enter the following command on a single line, the utility completes the following tasks:
  1. The utility unloads the audit document from the Optim Directory in the ora_dsn ODBC system data source, which is an Oracle database.
  2. The utility extracts the audit records for archive, extract, and browse requests that were generated between June 1, 2013 and January 14, 2014.
  3. The utility loads the extracted audit records to the table AuditTable201401 in the ora_dsn ODBC system data source. The utility creates the AuditTable201401 table if the table does not exist. If the AuditTable201401 table exists, the utility deletes all audit records from this table before the utility loads the new audit records to the table.
  4. The utility creates a separate XML document for each audit record and saves each XML document on its own row in the AuditTable201401 table. The utility also saves all XML documents to the c:\temp directory.
optim_audit_report.exe -dbtype=oracle -dsn=ora_dsn -userid=admin -password=opt1234X -reqtype=archive,extract,browse -datefrom=2013-06-01 -dateto=2014-01-14 -tablename=AuditTable201401 -deleterecord=yes -generateuniquexmlfiles=yes -location=c:\temp


Feedback