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
- Updating the Password Encryption Algorithm
- System Profile
- Email Notification
  - Test Email Server Configuration Job
  - Setting Up Email Notification
- Environment Variables
- Importing SSL Certificates to the Enterprise Data Manager Keystore
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
  - Adding JDBC Driver JAR Files
  - Generic JDBC Connection Properties
- Informix Source Connections
- Legacy Adapter Connection
- Microsoft SQL Server Source Connections
  - Creating an SSL Connection
- MongoDB 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
  - Creating an SSL Connection
- 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
- Microsoft Azure Storage 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
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.5.1
- 6.5 HotFix 1
- 6.5
- 6.4.4
- 6.4.3 HotFix 1
- 6.4.3

Back Next

Forming the URL for the File Archive Transaction Restore API

To restore a file archive transaction or transactions through the API, form a URL that contains the required parameters.

Use the following format to form the URL:

http://<host>:<port>/API/fileArchiveTxnRestore.htm?definitionId=<definitionId>& whereClause=<whereClase>& username=<username>& password=<encryptedPassword>

Replace the text in brackets with the appropriate parameter values.

Use the following values to create the WHERE clause that identifies the records that you want to restore:

Brace

NOBrace

to indicate the presence or absence of the left brace.

Use the

Brace

NOBrace

signifiers to indicate whether or not the search criteria contains a bracket.

For example, the following type of search criteria does not require brackets:

First_Name EQ John and middle_name EQ rob OR last_name EQ smith

However, you can also create search criteria that contains brackets. For example:

(First_Name EQ John and middle_name EQ rob) OR last_name EQ smith

Or,

First_Name EQ John and (middle_name EQ Rob OR last_name EQ smith)

The URL requires the use of

NOBrace

if the search criteria does not contain brackets.

Table name and column name separate by a period. For example,

CUSTOMERS.CUSTOMER_ID

Operator

Column value or, if the operator is

IS NULL

NOT NULL

, use

NOValue

Brace

NOBrace

to indicate the presence or absence of the right brace.

AND

, or

NOCondition

for condition.

Each criteria should be separated by four hash (#) symbols. Each value in a criteria should be separated by three hash (#) symbols.

Form the URL.

Replace the following in the WHERE clause:

Replace all hash (#) symbols with %23. For example, change

###EQ###

%23%23%23EQ%23%23%23

Replace all left parentheses with %28.

Replace all left parentheses with %29.

Example

You have created one file archive transaction restore definition on the entity "XYZ_001." The definition ID is 10. The entity driving table is "XYZ" and the table has 2 columns, "ID" (integer) and "Name"(varchar). The WHERE clause is "ID<10." You want to use the API to create and schedule the job with the following job parameters:

Parameter	Value	Description
Host	10.74.0.233	Must be configured as a valid host in the conf.properties file.
Port	8080	Port number.
Definition ID	10	ID for the definition created in the Data Archive user interface. After you create the restore definition from the Data Archive user interface, run the following query to return the definition ID: SELECT MAX(DEFN_ID) from AM_DEFN
Username	User1	Data Archive username.
Password	adscsadnacasdad	Encrypted password returned by the encryptPassword.bat or encryptPassword.sh utilities.
WhereClause	ID >= 10	WHERE clause to filter records for the transaction restore.

The following URL runs the file archive transaction restore with the specified job parameters:

http://10.74.0.233:8080/API/fileArchiveTxnRestore.htm?definitionId=10&username=User1&password=adscsadnacasdad&whereClause=%23%23%23XYZ.ID%23%23%23GTEQ%23%23%2310%23%23%23NoBrace%23%23%23false%23%23%23NOCondition

Rename Saved Search

Table of Contents

Administrator Guide

Administrator Guide

Forming the URL for the File Archive Transaction Restore API

Forming the URL for the File Archive Transaction Restore API