Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Overview

• Overview of the Oracle DataLens Server APIs
  • APIs
  • Platforms
  • Pre-Installation Requirements
• Oracle DataLens Server Java Libraries

2 DSA API to the Oracle DataLens Server

• WfgClient
  • Updating Individual Records and Data Lines
  • Transforming Data
    • Import
    • Initialize the Client
    • Create the List of Input Data
    • Transform a List of Data
    • Alternative Method of Transforming Data
  • Retrieve Results from the Server for Jobs with a Single Output Step
    • Synchronous Method
    • Asynchronous Method
  • Retrieve Results from the Server for Jobs with Multiple Output Steps
  • Pulling the Result Data from the List
    • List Data
    • Tab-Separated Data
  • Listing Multiple DSA Jobs
  • Listing a Single DSA Job
  • Using File Input and Output
• Miscellaneous Settings for the WfgClient
  • Retry Count
  • Filter Data
  • Job Priority
  • Run-Time Locale
  • Separator Character
  • Client-Side Debugging Toggle
  • E-mail Output
  • FTP Output
  • Database Parameters

3 Server Information API to the Oracle DataLens Server

• InfoClient
  • Getting Transform Map and Data Lens Information
  • Import
  • Initialize the Client
  • Get a List of Deployed Data Lenses
    • Lists of Schemas and Translations
  • Get a List of Deployed DSAs

4 Server Availability API to the Oracle DataLens Server

• PingClient
  • Import
  • Simple Server Check
  • Round-Robin Server Check

5 Error Handling

• Client-Side Exceptions
• Client-Side Log Messages
• Log4j to Standard Output
  • Log4J to a File
• Server-Side Faults
• Server-Side Exceptions
• Server-Side Log Messages
• Debugging Client Requests and Responses

6 Compiling and Running with the API

• Compile the Application with the Oracle DataLens Libraries
• Run the Application with the Oracle DataLens Libraries

7 Web Service Access to the Oracle DataLens Server Using Doc-Lit

• Generating a WSDL Document on Demand
• Client Web Service Software
• Overview of the DSA Interface
  • processListRequest and processOneLineRequest Operations
  • processDBRequest
  • SOAP Document-Literal One Line Request Example
  • SOAP Document-Literal One Line Response Example
  • SOAP Doc-Lit Multi-Line ProcessList Request Example
  • SOAP Doc-Lit Multi-Line ProcessList Response Example
  • SOAP Document-Literal ProcessDb Request Example
  • SOAP Document-Literal processDb Response Example

8 Customizing DSA Maps with Java Add-Ins and Algorithms

• TMap Algorithms
  • Initial Configuration
    • Client Startup Changes
  • Creating a New TMap Algorithm
  • TMap Algorithm Debugging
    • Server
    • Client
• Transform Map Add-In Transforms
  • Writing a TMap Add-In Transform
  • Defining the Transform Map Add-In Transform
    • Server
  • Defining the Input Parameters to the Transform Map Add-In Transform
  • Using the Transform Map Add-In Transform in the Client
  • Using TMap Add-in Transforms to Process Exception Data
• DSA Add-In Outputters
  • Writing a DSA Add-In Outputter
  • Defining the DSA Add-In Outputter
    • Server
  • Defining the Input Parameters to the Transform Map Add-In Transform
  • Using the DSA Add-In Outputter in the Client
  • Use in the Application Studio

A Working Through a Proxy Server

• Run-Time Java Proxy Parameters
  • RtClient Java Proxy Parameters

B Installing the Client Software