Preface
Starting Data Archive
- Starting the ILM Application Server
- 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
- 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
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
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.3
- 6.5.1
- 6.5 HotFix 1
- 6.5
- 6.4.4
- 6.4.3 HotFix 1

Back Next

Step 2. Form the URL that Calls JobHandler.jsp

To call

JobHandler.jsp

, form a URL that includes the required parameters. The parameters determine on which Data Archive instance the jobs runs, the job name, the job execution mode, and the required and optional job-specific parameters.

The URL that calls

JobHandler.jsp

has the following general syntax:

http://<host>:<port>/jsp/JobHandler.jsp?&action=<job action>&ProcessName=<process name>&<parameter
 1 name>=<parameter 1 value>&<parameter 2 name>=<parameter 2 value>

The URL syntax includes general and job-specific parameters. The parameters are included in brackets. Some parameters are specific for all standalone jobs, such as the host, port, job action, and process name. The rest of the parameters depend on the standalone job. When you formulate the URL, you insert values for all of the parameters.

The URL syntax includes the following parameters:

Host: Host of the Data Archive instance on which you want to run the standalone job.
Port: Port of the Data Archive instance on which you want to run the standalone job.
Job Action: Execution mode for the standalone job.
JobHandler.jsp
supports the following values for the job action:
START
RESUME
TERMINATE
Process Name: Technical name of the standalone job.; The following table lists the process names for each standalone job:

Standalone Job Name
Process Name

Archive Structured Digital Records
ARC_STRUCTURED_DIGITAL_RECS

Copy Application Version for Retirement
COPY_PFV

Create Archive Folder
CREATE_ARCHIVE_FOLDER

Create Cycle Index
CREATE_CYCLE_INDEX

Create Indexes
CREATE_INDEX

Create Indexes on Data Vault
CREATE_QUICKSEARCH_INDEX_ON_FAS

Create Seamless Data Access
SEAMLESS_DATA_ACCESS

Create Seamless Data Access Script
SEAMLESS_ACCESS_SCRIPT

Create Tables
CREATE_TABLE

Data Vault Loader
ARCHIVE_CRAWLER

DB2 Bind Package
DB2_BIND_PACKAGE

Delete Indexes on Data Vault
DELETE_QUICKSEARCH_INDEX_ON_FAS

DGA Data Collection
DGA_DATA_COLLECTION

Load External Attachments
LOAD_EXTERNAL_ATTACHMENTS

Move External Attachments
MOVE_EXTERNAL_ATTACHMENTS

Purge Expired Records
PURGE_EXPIRED_RECORDS

Restore External Attachments from Archive Folder
RESTORE_EXTERNAL_ATTACHMENTS

Sync with LDAP Server
LDAP_SCRIPT

Test Email Server Configuration
EMAIL_SERVER_TEST

Test JDBC Connectivity
JDBC_TEST
Parameter Name: Job-specific parameters.
Each standalone job requires program-specific parameters as input. Not all of the parameters are required. When you formulate the URL, you must include at least the required parameters.

For more information about the required and optional job parameters, see Job Handler JSP Job Parameters.
Parameter Value: Value for the job parameter name.

Standalone Job Name	Process Name
Archive Structured Digital Records	ARC_STRUCTURED_DIGITAL_RECS
Copy Application Version for Retirement	COPY_PFV
Create Archive Folder	CREATE_ARCHIVE_FOLDER
Create Cycle Index	CREATE_CYCLE_INDEX
Create Indexes	CREATE_INDEX
Create Indexes on Data Vault	CREATE_QUICKSEARCH_INDEX_ON_FAS
Create Seamless Data Access	SEAMLESS_DATA_ACCESS
Create Seamless Data Access Script	SEAMLESS_ACCESS_SCRIPT
Create Tables	CREATE_TABLE
Data Vault Loader	ARCHIVE_CRAWLER
DB2 Bind Package	DB2_BIND_PACKAGE
Delete Indexes on Data Vault	DELETE_QUICKSEARCH_INDEX_ON_FAS
DGA Data Collection	DGA_DATA_COLLECTION
Load External Attachments	LOAD_EXTERNAL_ATTACHMENTS
Move External Attachments	MOVE_EXTERNAL_ATTACHMENTS
Purge Expired Records	PURGE_EXPIRED_RECORDS
Restore External Attachments from Archive Folder	RESTORE_EXTERNAL_ATTACHMENTS
Sync with LDAP Server	LDAP_SCRIPT
Test Email Server Configuration	EMAIL_SERVER_TEST
Test JDBC Connectivity	JDBC_TEST