Policy Server Guides › Policy Server Administration Guide › Configuring Policy Server Data Storage Options › Audit Data Import Tool for ODBC

Audit Data Import Tool for ODBC

The Policy Server can store audit data in an ODBC database or output audit data to a text file. The smauditimport tool reads a CA SiteMinder® audit data text file and imports the data into an ODBC database. The database has been configured as an audit store using 5.x or 6.x schema.

The smauditimport tool imports authentication, authorization, and admin data into the corresponding tables in the ODBC database. The tool logs the number of rows successfully imported into the ODBC database. For each row that cannot be imported into the ODBC database, the tool logs the row number.

The characters '[', ']', or '\' appearing in a field in the policy or user store require a preceding escaping character '\' (backslash). These characters appear because they have been used in fields like username, realm name, and so on.

Set the following registry key, to escape these characters automatically:
[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Netegrity\SiteMinder\CurrentVersion\LogConfig]
Value Type: DWORD VALUE
Value Name: EscapeAuditFields
Value Data: 1

When Value Data is set to 0, or if the key does not exist, there is no escaping, and the operation fails.

Note: In some CA SiteMinder® documentation, the terms audit and logging are used interchangeably.

Log More Audit Data to a Text File

By default, the Policy Server logs less audit data to a text file than to an ODBC database. You can log more audit data to a text file than the default and bring the amount of data in line with an ODBC database. To do so, manually add the following registry key and set its value to one: "Enable Enhance Tracing". To disable "Enable Enhance Tracing", set its value to zero (the default).

To log more audit data to a text file

1. Manually add the registry key "Enable Enhance Tracing":

   Windows

   Add the following key:

   TYPE=DWORD
   \netegrity\SiteMinder\CurrentVersion\Reports
   \"Enable Enhance Tracing"
   

   Solaris

   Follow these steps:

   1. Open the file: .../siteminder/registry/sm.registry.
   2. Locate the line:

      HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Netegrity\SiteMinder
      \CurrentVersion\Reports=25089
      

   3. Below the line, add the following:

      "Enable Enhance Tracing"=0x1;	REG_DWORD
      

   4. Save and close the file.
2. Set "Enable Enhance Tracing" to one.

Note: The value of "Enable Enhance Tracing" does not affect logging of Entitlement Management Services (EMS) events.

Audit Data Import Prerequisites for ODBC

Before you run the tool smauditimport, verify that the following prerequisites have been satisfied:

• The Policy Server is installed on a Windows, Solaris, or Linux operating environment.

  Note: For Solaris and Linux platforms, run nete_ps_env.ksh before running the smauditimport tool.

• The ODBC database is configured as an audit (logging) store with 5.x or 6.x schema.

  Note: For more information about how to configure an ODBC database as an audit (logging) store, see the Policy Server Installation Guide.

• The registry key "Enable Enhance Tracing" is set to one.

Import Audit Data into an ODBC Database

The tool smauditimport reads a CA SiteMinder® audit data text file and imports it into an ODBC database. The tool is located in the \bin directory under the Policy Server installation directory.

Important! Before you import audit data into an ODBC database, configure the database as an audit store with CA SiteMinder® 5.x or 6.x schema. For more information about how to configure an ODBC database with the CA SiteMinder® schema, see the Policy Server Installation Guide.

Important! Before running a CA SiteMinder® utility or executable on Windows Server 2008, open the command-line window with administrator permissions. Open the command-line window this way, even if your account has administrator privileges.

Follow these steps:

1. On the computer where the Policy Server is installed, navigate to siteminder_installation\bin.

   siteminder_installation

   Specifies the Policy Server installation path.

2. Run the following command:

   smauditimport audit_file dsn user_name user_password -f -v -bbulk_load_size -s5 | -s6 -anumber

   audit_file

   Specifies the path and name of the text file containing the audit data.

   Note: The smauditimport tool requires the full path name of the audit data text file.

   dsn

   Specifies the Data Source Name (DSN) of the ODBC database.

   user_name

   Specifies the name of the ODBC database administrator.

   user_password

   Specifies the password of the ODBC database administrator.

   -a

   (Required) Specifies the value of the Enable Enhance Tracing registry setting on the Policy Server. This setting exists under HKEY_LOCAL_MACHINE\Software\Netegrity\SiteMinder\Currentversion\Reports. On Windows operating environments, this setting is in the Windows registry. For the UNIX or the Linux operating environments, this setting is in the sm.registry file. The value of the setting must match the value of used with this option.

   Example: -a2 (Indicates an Enable Enhance Tracing registry setting of 2).

   -f

   (Optional) When an error occurs while importing audit data, smauditimport logs the row number and continues processing.

   Default: Without the -f option, smauditimport logs the row number, but stops processing when an error occurs.

   -v

   (Optional) Validates the number of fields in the text file, validates that the values in numeric fields fall within specified ranges, validates the connection to the database, and outputs errors.

   Note: When the smauditimport tool is run in the validation mode, no data is imported into the database.

   -b bulk_load_size

   (Optional) Specifies the number of rows to read and import into the ODBC database.

   Default: 100

   Note: If using the smauditimport tool to import audit data into an Oracle database using the -b option, do not set the Enable bulk load option in the ODBC Oracle Wire Protocol Driver Setup dialog. If the ODBC Oracle Wire Protocol Driver Setup Enable bulk load option is set, unexpected behavior occurs during the bulk load.

   -s5 | -s6

   (Optional) Supports an ODBC database that is configured as an audit store with either 5.x schema or 6.x schema.

   Default: Supports an ODBC database that is configured as an audit store with 6.x schema.

More information:

Change the Value of the Registry Key

Change the Value of the Line in the Registry File