Client Application Developer's Guide

Introducing Data Services for Client Applications

Simplifying Application Data Programming

What is a Data Services Client?

Data Your Way

The Role of WebLogic Server and WebLogic Workshop

What Is a Data Service?

What is a AquaLogic Data Services Platform Client Application?

Security Considerations in Client Applications

Choosing a Data Services Programming Model

Introducing Service Data Objects (SDO)

Update Frameworks and the Data Service Mediator

Typical Client Application Development Process

Development Resources

Runtime Client JAR Files

AquaLogic Data Services Platform Mediator API Javadoc

Performance Considerations

Data Programming Model and Update Framework

Data Services Platform and Service Data Objects (SDOs)

Static and Dynamic Data APIs

Static Data API

XML Schema-to-Java Type Mapping Reference

Dynamic Data API

XPath Support in the Dynamic Data API

Obtaining Type Information about Data Objects

Role of the Mediator and SDOs

Accessing Data Services from Java Clients

Overview of the AquaLogic Data Services Platform Mediator API

Setting the Classpath

Mediator API Summary and Reference

Generating a Static Mediator API JAR File

Building the Client JAR

Using the Data Service Mediator API

Obtaining a WebLogic JNDI Context for AquaLogic Data Services Platform

Invoking Functions and AquaLogic Data Services Platform Procedures

Static and Dynamic Mediator APIs

Using a Static Data Service Mediator API

Using a Dynamic Mediator API

Static and Dynamic SDO APIs

Using the Static SDO API

Using the Dynamic SDO API

How XML Schemas Are Made Available to Dynamic SDO Operations

Schema Type Caching

Bypassing the Data Cache When Using the Mediator API

Client Management of the Data Cache

Setting the GET_CURRENT_DATA Attribute

SETTING the REFRESH_CACHE_EARLY Attribute

Accessing Data Services Via WebLogic Server 9.2 Clients

Interoperability Steps

Step-by-Step: A Java Client Programming Example

Step 1. Instantiating and Populating Data Objects

Step 2: Accessing Data Object Properties

Quantifying Return Types

Step 3: Modifying, Inserting, and Deleting Data Objects and Properties

Modifying Data Object Properties

Inserting New Data Objects

Inserting a New Data Object

RDBMS Considerations

Deleting Data Objects

Step 4: Submitting Changes to the Data Service

Examining a Java Client Application

Enabling AquaLogic Data Services Applications for Web Service Clients

Overview of Web Services and AquaLogic Data Services Platform

Different Styles of Web Services Integration for AquaLogic Data Services Platform

Server-Side AquaLogic Data Services Platform-Enabled Web Service Development

Developing AquaLogic Data Services Platform-Enabled Read-Only Web Services

Adding a Data Service Control to a Web Service

Generating a Web Service from a Data Service Control

Developing AquaLogic Data Services Platform-Enabled Read-Write Web Services

Testing a Web Service in WebLogic Workshop

Client-Side AquaLogic Data Services Platform-Enabled Web Service Development

Static Web Service Clients

Dynamic Web Service Clients

Developing Static Web Service Clients

Generating SDO Classes for the Web Service Proxy

Generating SDO Classes Using Ant

Generating SDO Classes Using Java

Generating the SDO Web Service Client Proxy

Ant Script Attributes

Sample Script for Creating Static Web Service Client

Environmental Settings

Syntax

Usage Examples

Using Java to Generate the Client Proxy

Usage Examples

Using the SDO Web Service Client Gen Utility

Developing Static Web Service Clients

How To Set Up a Web Service Client Environment for AquaLogic Data Services Platform

Steps Involved in Developing Your Web Service Client

Sample Java Static Web Service Client

Developing Dynamic Web Service Clients

Setting Up a Dynamic Web Service Environment

Developing the Dynamic Web Service Client

Initiating Dynamic Web Service Client Development

Steps Specific to AquaLogic Data Services Platform

Completing Dynamic Web Service Client Development

Sample Java Dynamic Web Service Client

Using SQL to Access Data Services

Publishing Data Service Functions As SQL

Using Custom Database Functions through AquaLogic Data Services Platform

SQL Support in AquaLogic Data Services Platform

Supported Features

Additional Details

Table Parameter Support

Use Case for Table Parameters

Setting Table Parameters Using JDBC

Creating Table Parameters

JDBC Usage

Table Parameter Example

XML and SQL Type Mappings

Accessing Data Services Functions Through JDBC

About the AquaLogic Data Services Platform JDBC Driver

Data Service Functions and Corresponding JDBC Artifacts

Supported Functions

Numeric Functions

String Functions

Datetime Functions

Aggregate Functions

JDBC Metadata Search Patterns

Configuring the AquaLogic Data Services Platform JDBC Driver

Configuring the Connection Using the Properties Object:

Configuring the Connection in the JDBC URL:

Accessing AquaLogic Data Services Platform JDBC Driver Using a Java Application

Obtaining a Connection

Using the preparedStatement Interface

Using the CallableStatement Interface

Accessing Data Service Functions from DbVisualizer

Connecting to AquaLogic Data Services Platform Client Using ODBC-JDBC Bridge from Non-Java Applications

Using OpenLink ODBC-JDBC Bridge

Using the EasySoft ODBC-JDBC Bridge

Accessing Data Services Data from Reporting Tools

Crystal Reports XI

Crystal Reports Configuration File Support

Limitations

Connecting to Crystal Reports Using JDBC

Business Objects XI-Release 2 (ODBC)

Business Objects Configuration File Support

Prerequisites and Limitations

Generating a Business Objects Report

Hyperion-ODBC

Limitations

Using Hyperion Production Reporting Studio

Using Hyperion Interactive Reporting Studio

Microsoft Access 2003-ODBC

Limitations and Usage Notes

Generating Reports Using MS Access

Microsoft Excel 2003-ODBC

Limitations

Using the Query Plan Viewer Utility

Installing Query Plan Utility Components

Command Line Syntax

Invoking the Query Plan Viewer Utility

Query Plan Viewer Login Dialog

Entering an SQL Query or XQuery

Additional Query Plan Viewer Utility Options

Using Excel to Access Data Services

Installing the Excel Add-in

System Requirements

Installation Instructions

Preparing To Install

Accessing Excel Add-in Documentation

Generating WSDL Files for the Excel Add-in

Creating a WSDL File from a Data Service

Obtaining a Valid WSDL URL for Use with the Excel Add-in

Using the Excel Add-in with a Remote or Deployed Server

Example Showing Data Service-Generated Web Service Use in Excel

Accessing Your Data Service Through Excel

Accessing Data Services from WebLogic Workshop Applications

Introduction to Data Service Controls

Data Service Controls Defined

Page Flow, Web Services, Portals, Business Processes

Description of the Data Service Control (JCX) File

Design View

Source View

Using Data Service Controls for Ad Hoc Queries

Creating Data Service Controls

Step 1: Create a Project in an Application

Step 2: Start WebLogic Server

Step 3: Create a Folder in a Project

Step 4: Create the Data Service Control

Step 5: Enter Connection Information for WebLogic Server

Step 6: Select Data Service Functions to Add to Your Control

Modifying Existing Data Service Controls

Changing a Method Used by a Control

Adding a New Method to a Control

Updating an Existing Control When Schemas Change

Caching Considerations When Using Data Service Controls

Bypassing the Cache When Using a Data Service Control

Cache Bypass Example When Using a Data Service Control

Security Considerations When Using Data Service Controls

Security Credentials Used to Create Data Service Controls

Testing Controls With the Run-As Property in the JWS File

Trusted Domains

Configuring Trusted Domains

Using Data Services Platform with NetUI

Generating a Page Flow From a Control

To Generate a Page Flow From a Data Service Control

Adding a Data Service Control to an Existing Page Flow

Adding Service Data Objects (SDO) Variables to the Page Flow

Adding a Variable to a Page Flow

Initializing a Variable in the Page Flow

Working with Data Objects

Displaying Array Values in a Table or List

Adding a Repeater to a JSP File

Adding a Nested Level to an Existing Repeater

Adding Code to Handle Null Values

Using Data Service Control 9.2

Differences Between the 9.2 and 8.1 Data Service Control

Installing the Data Service Control 9.2 Plug-In

Setting Up WebLogic Server 8.1 to Use Data Service Control 9.2

Using Data Service Control 9.2 from Workshop for WebLogic Platform

Creating and Using the Data Service Control

Creating a Web Service Project

Creating Data Service Control

Creating the JWS and Using the Data Service Control

Modifying and Uninstalling the Control

Editing and Deleting the Data Service Control

Uninstalling the Control

Accessing Data Services Through AquaLogic Service Bus

Accessing AquaLogic Data Services Platform from AquaLogic Service Bus

Step 1: Start Your Servers

Step 2: Generate the WSDL for the Data Service

Generate the WSDL Through WebLogic Workshop 8.1

Export the WSDL with the AquaLogic Data Service Console

Step 3: Deploy the Data Services Transport

Step 4: Import the WSDL for the Data Service

Step 5: Create the Business Service

Step 6: Create the Proxy Service

Step 7: Test Your Setup

Additional Information

Supporting ADO.NET Clients

Overview of ADO.NET Integration in Data Services Platform

Understanding ADO.NET

ADO.NET Client Application Development Tools

Understanding How AquaLogic Data Services Platform Supports ADO.NET Clients

Supporting Java Clients

Enabling AquaLogic Data Services Platform Support for ADO.NET Clients

Creating a New Web Service Project

Creating an ADO.NET-Enabled Data Service Control

Generating a Web Service for ADO.NET Clients

Generating an ADO.NET-Enabled WSDL

Adapting AquaLogic Data Services Platform XML Types (Schemas) for ADO.NET Clients

Approaches to Adapting XML Types for ADO.NET

XML Type Requirements for Working With ADO.NET DataSets

Requirements for Complex Types

Requirements for Recurring References

Requirements for Simple Types

Requirements for Target Namespace and Namespace Qualification

References

Generated Artifacts Reference

XML Schema Definition for ADO.NET Typed DataSet

Web Services Description Language (WSDL) File for Microsoft ADO.NET Clients

Using Workflow with AquaLogic Data Services Platform-Based Applications

Brief Overview of WebLogic Integration JPDs

How SDO's Handling of XMLObjects Differs from JPD

Adding a Data Service Control to a Process

Creating a Data Service Control

Adding a Data Service Control to a JPD File

Setting Up the Data Service Control in the Business Process

Submitting Changes from a Business Process

Updating Multiple Data Services Using Workflows

Advanced Topics

Accessing Metadata Using Catalog Services

Installing Catalog Services

Using Catalog Services

Application (application.ds)

DataService (DataService.ds)

DataServiceRef (DataServiceRef.ds)

Folder (folder.ds)

Function (Function.ds)

Relationship (Relationship.ds)

Schema (Schema.ds)

SchemaRef (SchemaRef.ds)

Filtering, Sorting, and Fine-tuning Query Results

Using Filters

Specifying Filter Effects

Ordering and Truncating Data Service Results

Using Ad Hoc Queries to Fine-tune Results from the Client

Handling Large Result Sets with Streaming APIs

Using the Streaming Interface

Writing Data Service Function Results to a File