Preface
Starting Data Archive
- Starting the ILM Application Server
- Configure Proxy Server Settings
- Logging In to Data Archive
System Configuration
- System Configuration Overview
- Conf.properties File
- System Profile
- Email Notification
  - Test Email Server Configuration Job
  - Setting Up Email Notification
- Environment Variables
Database Users and Privileges
- Database Users and Privileges Overview
- Database Users
- IBM DB2 Privileges
- SAP Application Retirement Privileges
  - ZINFA_RETIREMENT_PREPARATION Role
Source Connections
- Source Connections Overview
- Source Database Requirements
- Connection Properties
  - General Connection Properties
- IBM DB2 Source Connections
- Binding Packages on IBM DB2
- Generic JDBC Source Connections
  - Uploading JDBC Driver JAR Files
  - Generic JDBC Connection Properties
- Informix Source Connections
- Legacy Adapter Connection
- Microsoft SQL Server Source Connections
- Netezza Source Connections
- Oracle Source Connections
- PowerExchange ODBC Connections
- Salesforce Source Connections
- Sybase Source Connections
- Teradata Source Connections
- Creating a Source Connection
- Copying a Source Connection
- Database User Password Changes
  - Properties File
  - Changing Database User Passwords
Target Connections
- Target Connections Overview
- Target Database Requirements
- Connection Properties
  - General Connection Properties
- IBM DB2 Target Connections
- Informix Target Connections
- Microsoft SQL Server Target Connections
- Data Vault Target Connections
  - Archive Store Properties
- Oracle Target Connections
- Teradata Target Connections
- Netezza Target Connections
- Creating a Target Connection
- Copying a Target Connection
- Database User Password Changes
  - Properties File
  - Changing Database User Passwords
Archive Store Configuration
- Archive Store Configuration Overview
- EMC Centera and EMC Atmos Configuration
- Hitachi Content Platform Configuration
- Hadoop Distributed File System Configuration
Datatype Mapping
- Datatype Mapping from Source to Archive Overview
- Datatype Mapping Interface
- Data Vault Datatypes
- IBM DB2 Source Databases
- Custom Datatypes
- SAP Datatypes
- Unsupported Datatype Mappings
- Mapping a Custom Datatype to an Archive Datatype
- Out-of-Range Data Replacement
  - Configuration for Out-of-Range Data Replacement
  - Examples for Out-of-Range Data Replacement
Database Optimization
- Database Optimization Overview
- IBM DB2 Native Utilities
- Teradata Native Utilities
SAP Application Retirement
- SAP Application Retirement Overview
- SAP Application Retirement Architecture Options
- Setting Up SAP Application Retirement
- Step 1. Install the SAP Java Connector
- Step 2. Apply the SAP Transports
- Step 3. Assign Roles
- Step 4. Configure Conf.Properties
- Step 5: Set up the FTP or NFS Connection
  - Creating the FTP Connection
  - Creating the NFS Mount
z/OS Source Data Retirement
- z/OS Source Data Retirement Overview
- Implementation Example
- Prerequisites
- Step 2. Create PowerExchange Data Maps
- Step 3. Configure PowerExchange ODBC Data Sources on the Data Archive Server
  - Configure ODBC Data Sources on Linux or UNIX
  - Configure ODBC Data Sources on Windows
- Step 4. Import z/OS Metadata
- Step 5. Define and Run the Retirement Project
Seamless Data Access
- Seamless Data Access Overview
- Seamless Access for IBM DB2
  - Create Seamless Data Access Script Job
    - Create Seamless Data Access Script Job Parameters
  - Configuring Seamless Access for IBM DB2
- Seamless Access for Oracle
- Seamless Access for PeopleSoft
- Seamless Access for PeopleSoft on IBM DB2
Data Discovery Portal
- Data Discovery Portal Overview
- Search Data Vault
  - Setting up Search Data Vault
  - Maintaining Search Indexes
- Search Within an Entity in Data Vault
  - Step 1. Define Search Options
    - Editing Search Options
  - Step 2. Specify Number of Records in Results
    - Editing the Default Maximum Records in Results Value
- Masking Sensitive Information in Data Vault
  - Enabling Dynamic Data Masking
- Integration with E-Discovery Solutions
  - In-Place Preservation for Data Vault Through Exterro Fusion
    - Integrating Data Archive and Exterro Fusion
    - Troubleshooting Legal Holds Applied from the Exterro Fusion Interface
- Accessing Archive Data from an External Application
Security
- Security Overview
- Users
  - User Properties
  - Password Management
- User Management
- System-Defined Roles
  - System-Defined Roles and Privileges
  - User Reports for System-Defined Roles
- Data Vault Access Roles
- Security Groups
  - Security Group Properties
  - Creating Security Groups
SSL Communication with Data Vault
- SSL Communication with Data Vault Overview
- Creating a Certificate and TrustStore
- Updating Conf.Properties
- Modifying the StartApplimation File
- Creating a Generic JDBC Source Connection
- Importing Data Vault Table Metadata with SSL Enabled
- Updating JReport Designer
LDAP User Authentication
- LDAP User Authentication Overview
- User Synchronization
  - Nested Group Synchronization for Users
- Data Archive Roles and LDAP Security Groups
  - Technical Names for System-Defined Roles
- Role Assignments
- Role Assignment Synchronization
  - Nested Group Synchronization for Role Assignments
- Sync with LDAP Server Job
  - Sync with LDAP Server Job Parameters
- Troubleshooting the Sync with LDAP Server Job
- Setting Up LDAP User Authentication
- LDAP User Authentication Maintenance
- Single Sign-On
Auditing
- Auditing Overview
- Audit Levels
- Configuring Audit Logs
- Archiving Audit Logs
- Viewing Audit Logs
- Exporting Audit Logs
- Purging Audit Logs
Running Jobs from External Applications
- Running Jobs from an External Application Overview
- Job Handler JSP
- Job Handler JSP Job Parameters
- Run Update Retention JSP
- Run Definition JSP
- Legal Hold API
- Step 1. Configure Security
- Step 2. Form the Legal Hold URL
- Step 3. Add the URL to the External Application Code
- Step 4. Form the URL that Calls GetJobStatus.jsp
  - Forming the URL that Calls GetJobStatus.jsp
  - Example
- Step 5. Add the URL to the External Application Code
- File Archive Transaction Restore API
- Step 1. Configure Security
- Step 2. Create the File Archive Transaction Restore API Definition
- Step 3. Form the File Archive Transaction Restore URL
  - File Archive Transaction Restore URL Syntax
  - Forming the URL for the File Archive Transaction Restore API
- Step 4. Add the URL to the External Application Code
- API Authentication
Salesforce Archiving Administrator Tasks
- Salesforce Archiving Administrator Tasks Overview
- Configure Salesforce Permissions
Upgrading Oracle History Data
- Upgrading Oracle History Data Overview
- Upgrading Oracle History Data Prerequisites
- Steps to Upgrade the History Data
- Step 1. Run the History Upgrade Scripts
  - History Upgrade Scripts Parameters
  - Running the History Upgrade Scripts
- Step 2. Run the Create History Table Job with the Original Source
  - Running the Create History Table Job
- Step 3. Update the Application Version for Source and Target Connections
  - Updating the Application Version for Source and Target Connections
- Step 4. Run the Create History Table Job with the Updated Source
  - Running the Create History Table Job
- Step 5. Run the Seamless Data Access Job for the Updated Source
  - Running the Seamless Data Access Job
- Step 6. Run the Create Indexes Job
  - Running the Create Indexes Job
- Step 7. Gather Database Statistics
Upgrading PeopleSoft History Data
- Upgrading PeopleSoft History Data Overview
- Upgrading PeopleSoft History Data Prerequisites
- Steps to Upgrade the History Data
- Step 1. Run the History Upgrade Scripts
  - Running the History Upgrade Scripts
    - Original Application Changes Script Example
    - Updated Application Changes Script Example
- Step 2. Run the Create History Table Job with the Original Source
  - Running the Create History Table Job
- Step 3. Update the Application Version for Source and Target Connections
  - Updating the Application Version for Source and Target Connections
- Step 4. Run the Create History Table Job with the Updated Source
  - Running the Create History Table Job
- Step 5. Run the Seamless Data Access Job for the Updated Source
  - Running the Seamless Data Access Job
- Step 6. Run the Create Indexes Job
  - Running the Create Indexes Job
- Step 7. Gather Database Statistics
Data Archive Maintenance
- Data Archive Maintenance Overview
  - Data Archive Component Integration
- Backing up Data Archive Components
- Maintaining the Data Vault Repository
Storage Classifications
- Storage Classifications Overview
- Storage Classification Configuration
- Creating Storage Classifications
- Storage Classification Management
Appendix A: Datetime and Numeric Formatting
- Datetime and Numeric Formatting Overview
- Datetime Format Strings
  - Datetime Format String Examples
- Numeric Format Strings
  - Numeric Format String Examples
Appendix B: Data Archive Connectivity
- Data Archive Connectivity Overview
- Native Connectivity
- DataDirect Connect JDBC Connectivity
- PowerExchange Connectivity
- Third-Party JDBC Connectivity

Administrator Guide

6.4.4
- 6.5.1
- 6.5 HotFix 1
- 6.5
- 6.4.3 HotFix 1
- 6.4.3

Back Next

IBM DB2 Native Utilities Properties

Before you use IBM DB2 native utilities for data movement, configure properties for Data Archive to use IBM DB2 native utilities. Optionally, you can configure additional command parameters to use in the import and export commands. Uncomment the properties to enable them.

General Properties

The

conf.properties

file includes the following properties for IBM DB2 native utilities:

informia.db2ClientPath: Location of the IBM DB2 Connect client root directory. Required to use any of the IBM DB2 native utilities for data movement. The IBM DB2 Connect installation must be on the same machine that hosts the ILM application server.

If you do not configure this property, Data Archive uses JDBC for data movement.
informia.db2HPUPath: Location of the IBM DB2 HPU utility root directory. Enter the full path to the main directory of the IBM DB2 HPU utility installation. Required to use the IBM DB2 HPU utility to export data. The IBM DB2 HPU utility installation must be on the same machine that hosts the ILM application server.

If you do not configure this property, Data Archive uses the export utility to export data.
informia.exportLobLocation: Location on the IBM DB2 database that temporarily stores LOB data. Required for the load client utility to process tables that have LOB datatypes. The location must be on the same machine that hosts the ILM application server.

If you do not configure this property, the archive job uses the import utility to process tables with LOB datatypes. The import performance might be impacted if the archive job uses the import utility.
informia.exportUtilName: IBM DB2 utility that Data Archive uses to export data. Required if you want to use the IBM DB2 HPU utility to export data.
If enabled, default value is
HPU
. Data Archive uses the IBM DB2 HPU utility to export data.

If disabled, Data Archive uses the export utility to export data.

Default is disabled. By default, if you configure the informia.db2ClientPath property, Data Archive uses the export utility unless you specify another utility in this property.
informia.hpu.columnSeparator: Optional. Character that identifies the column separator for the IBM DB2 HPU utility to export data.

If enabled, the archive job passes the value to the control file that the IBM DB2 HPU utility uses to export data. The job uses this value to create export files. Configure to one byte length. The IBM DB2 HPU utility does not support multibyte length separators.

If disabled, the IBM DB2 HPU utility default separator is used to export data.
informia.hpu.rowSeparator: Optional. Character that identifies the row separator for the IBM DB2 HPU utility to export data.

If enabled, the archive job passes the value to the control file that the IBM DB2 HPU utility uses to export data. The job uses this value to export files. Configure to one byte length. The IBM DB2 HPU utility does not support multi-byte length separators.

If disabled, the IBM DB2 HPU utility default separator is used to export data.
informia.importUtilName: IBM DB2 native utility that Data Archive uses to import data.

If enabled, default is IMPORT. Data Archive uses the import utility. For IBM DB2 on AS/400 and z/OS, you must enable the property to use the import utility.

If disabled, default is LOAD_CLIENT. Data Archive uses the load client utility. The load client utility is available for IBM DB2 on AIX, Linux, UNIX, or Windows.

By default, if you configure the informia.db2ClientPath property, Data Archive uses the load client utility unless you specify another utility in this property.
informia.TempDirectory: Temporary directory that stores the import and export files for the IBM DB2 native utilities. Each table has a separate import and export file. Data Archive deletes the corresponding import and export files after it processes the table. The location must be on the same machine that hosts the ILM application server.

At a minimum, the size of the temporary directory should equal the size of the tables that you run in parallel. For example, you need at least 10 GB temporary storage if your average table size is 1 GB and you use 10 threads for parallel processing.

For the IBM DB2 HPU utility, location that temporarily stores the control file that Data Archive generates when the job copies data to the destination. The IBM DB2 HPU utility uses parameters in the file for the export process. After the job completes, the job deletes the control file.

Import and Export Command Parameter Properties

You can add IBM DB2 command parameters to the script that the export or import utility uses to import or export data. By default, no additional command parameters are required.

Add command parameters to the property that corresponds to the location in which you want to insert the statement. You can use any command parameters that the import and export commands support in that location. Enter the property values in the supported IBM DB2 syntax for the import and export commands.

You can add the following optional properties to the

conf.properties

file:

informia.db2ImpStart: Statement that is inserted after the load file name of the import command. If you configure separators for the HPU utility, you must add a statement for the import utility to use the same separators.

The following value is an example of a statement that creates a dump file:
MODIFIED BY chardel@ coldel% delprioritychar DUMPFILE=/u01/db2/Dump.dmp FASTPARSE ANYORDER warningcount 10000
informia.db2ImpMiddle: Statement that is inserted before the insert statement of the import command.
informia.db2ImpLast: Statement that is inserted after the insert statement of the import command.
informia.db2ExpStart: Statement that is inserted after the unload file name of the export command.
informia.db2ExpLast: Statement that is inserted after the select statement of the export command.

Rename Saved Search

Table of Contents

Administrator Guide

Administrator Guide

IBM DB2 Native Utilities Properties

IBM DB2 Native Utilities Properties

General Properties

Import and Export Command Parameter Properties