English Wsa 20060407 JDBC
English Wsa 20060407 JDBC
7April2006
This edition of this document applies to IBM WebSphere Adapter for JDBC (5724L77), Version 6.0, and to all
subsequent releases and modifications until otherwise indicated in new editions.
To send us your comments about this document, email [email protected]. We look forward to hearing
from you.
When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any
way it believes appropriate without incurring any obligation to you.
© Copyright International Business Machines Corporation 2005, 2006. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
WebSphere Adapter for JDBC Version 6.0 User Guide . . . . . . . . . . . . . . . . 1
Product overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
IBM WebSphere Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
Task roadmap: IBM WebSphere Adapter for JDBC . . . . . . . . . . . . . . . . . . . . . .3
Enterprise service discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
Locale and globalization support . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Business objects overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Business object structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Business object attribute properties . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Supported operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Transaction management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Inbound support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Business object processing for outbound operations . . . . . . . . . . . . . . . . . . . . . 16
Application-specific information . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Installing the adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Adapter environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Installation information specific to the Adapter for JDBC . . . . . . . . . . . . . . . . . . . 30
Installed file structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Creating the adapter project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Creating a project for the adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Adding vendor libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Generating business objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Generating reference bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Deploying the adapter project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Configuring the adapter on the server . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Contacting IBM Software Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Enabling logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Enabling tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Enabling the Common Event Infrastructure (CEI) . . . . . . . . . . . . . . . . . . . . . . 55
Mainframe data access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Using the example files and sample application . . . . . . . . . . . . . . . . . . . . . . . 56
Example import, export, and WSDL files . . . . . . . . . . . . . . . . . . . . . . . . 56
Sample: Updating a database application . . . . . . . . . . . . . . . . . . . . . . . . 58
Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Configuration properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Connection properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Object selection properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Programming interface information . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Trademarks and service marks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Product overview
This topic introduces basic concepts about the WebSphere(R) Adapter for JDBC, its
architecture and its environmental requirements.
A WebSphere Adapter
J2EE WebSphere
Component Adapter EIS
The IBM(R) WebSphere (R) Adapter portfolio is a new generation of adapters based
on the Java 2 Platform, Enterprise Edition (J2EE) standard. JCA is a standard
architecture for integrating J2EE applications with enterprise information systems.
Each of these systems provides native APIs for identifying a function to call,
specifying its input data, and processing its output data. The goal of the JCA is to
provide an independent API for coding these functions, to facilitate data sharing,
and to integrate J2EE applications with existing and other EISs. The JCA standard
accomplishes this by defining a series of contracts that govern interactions between
an EIS and J2EE components within an application server.
Fully compliant with the JCA standard, WebSphere Adapters have been developed
to run on WebSphere Process Server. A WebSphere Adapter does the following:
v Integrates with WebSphere Process Server.
v Connects an application running on WebSphere Process Server with an EIS.
v Enables data exchange between the application and the EIS.
WebSphere WebSphere
Integration Business
EIS
Broker Integration EIS
Adapter
Audience
The information in this topic defines the users of the WebSphere Adapter products
and details the skills they require.
The audience for the adapter user guide includes data and application integrators
who are responsible for assembling application components into a complete
solution and preparing this solution for testing and deployment. These users
require the following general skills:
v A good understanding of the business solution and the business environment
v Knowledge of application and solution components, to enable their efficient
collaboration at run-time
v A detailed understanding of databases, data access issues, transactional models
and connections across heterogeneous relational databases, queues, and web
services
v Familiarity with integration tools
The data integrator is also responsible for enabling access to a range of data
sources for the application developers. The required skills include:
v Installing and configuring integration capabilities or point-to-point gateways
v Writing procedures to use database access logic efficiently
v Building data models for external data access tools
v Implementing security measures
Related concepts
“Sample: Updating a database application” on page 58
Sample files are provided with the IBM(R) WebSphere(R) Adapter for JDBC so
that you can use them to practice updating specific tables in a database
application. Two step-by-step scenarios are provided; one is targeted to the
application integrator and the other is for the data integrator. Depending on
your role, you can practice generating business objects, deploying the adapter,
and configuring the adapter to communicate between J2EE(TM) applications and
enterprise information systems.
Task Description
Installing the adapter Information describing installation
considerations specific to the Adapter for
JDBC, with a link to the installation
instructions.
Creating the adapter project You will create an adapter project, then
generate business objects and service
constructs, set configuration properties and,
finally, deploy the adapter project to the
application server.
Deploying the adapter project You will export the project to an enterprise
application archive (EAR) file and install this
file on the application server.
Configuring the adapter on the server You can reconfigure properties that the
adapter uses to set up a communication
channel to a specific database application.
Troubleshooting You will set up a log file to track the status
of event processing, and determine the level
of errors or warnings to be captured in the
log file.
The enterprise service discovery wizard provides a blue print for business objects.
It allows you to browse the metadata information of an EIS or database, enables
selection of the artifacts of interest, and generates deployable service objects and
descriptions. By selecting meta-object nodes from the metadata tree structure, you
can generate business objects for EIS or database entities. The metadata is
transformed into service data objects consisting business graphs and business
objects.
The enterprise service discovery wizard allows you to perform the following
actions:
v Generate business objects
v Set application-specific information on the business objects
v Set application-specific information on properties
v Provide service descriptions for inbound and outbound events
v Provide connection descriptions for inbound and outbound events
Architecture
The WebSphere(R) Adapter for JDBC is a resource adapter that provides
bidirectional connectivity between J2EE(TM) applications and enterprise information
systems (EISs). For such applications, the exchange of data, which is in the form of
business objects, happens at the database level.
The adapter for JDBC communicates with an EIS which is a database provider.
Updates to a database might need to be applied to another enterprise information
system, and changes to data in an EIS might need to be applied to a database. The
resource adapter can integrate with any application built on a database having a
JDBC driver that supports the JDBC 2.0 or later specification. Examples include
IBM(R) DB2(R), Oracle, Microsoft(TM) SQLServer, Sybase, and Informix databases.
To support integration, the resource adapter processes requests received from any
EIS and processes events generated as a result of database updates. The adapter
transmits these events to various predefined endpoints in the application server.
Endpoints are J2EE applications or other client consumers of the event. Data
updates that are made to tables in a database can be automatically propagated to
other applications connected to the application server, such as Siebel, PeopleSoft,
and Oracle applications, through event notifications posted in an event store. The
adapter updates the database tables using SQL queries or stored procedures, as
specified in the business objects.
The figure titled “Processing within the JDBC adapter” shows inbound and
outbound operations.
Application built on DB
Application Server
EndPoint A
Inbound
Event
Database Processing
Table
(Events)
Outbound
Application Tables Processing
(Requests)
J2EE Client
This adapter supports the processing of bidirectional script data for Arabic and
Hebrew languages. To use the bidirectional capacity, you must configure the
bidirectional properties. In this user guide, the term bidirectional properties refers to
the properties that control invocation of bidirectional support.
If your enterprise information system (EIS) uses a bidirectional format that differs
from the Windows standard format, all properties with bidirectional support are
transformed from the Windows standard format to the bidirectional format of the
The Java(TM) runtime environment within the Java Virtual Machine (JVM)
represents data in the Unicode character code set. Unicode contains encodings for
characters in most known character code sets (both single- and multi-byte). Most
components in the WebSphere Business Integration system are written in Java.
Therefore, when data is transferred between most WebSphere Business Integration
system components, there is no need for character conversion.
To log error and informational messages in the appropriate language and for the
appropriate country or territory, the adapter uses the locale of the system on which
it is running.
Five attributes must be set for the proper bidirectional language format. The
attributes and settings are listed in the table titled “Bidirectional attributes.”
Bidirectional attributes
Letter Default
position Purpose Values Description setting
1 Order Schema I or V Implicit (Logical) or Visual I
2 Direction L Left-to-Right L
R Right-to-Left
C Contextual Left-to-Right
D Contextual Right-to-Left
3 Symmetric Swapping Y or N Symmetric Swapping is on Y
or off
4 Shaping S Text is shaped N
N Text is not shaped
I Initial shaping
M Middle shaping
F Final shaping
B Isolated shaping
5 Numeric Shaping H, C, or N Hindi, Contextual, or N
Nominal
Note: The locale setting of the user interface (browser) defines the bidirectional
language display and edit format. WebSphere Process Server user interfaces
must convert locale-specific formats to the WebSphere Process Server default
format.
You can edit the bidirectional properties for business objects and business object
attributes using annotations in the Business Object Editor in WebSphere Integration
Developer. The annotations are stored in the business object (the *.xsd file). For
more information, refer to the Business Object Editor documentation on the
WebSphere Integration Developer website at http://www.ibm.com/software/
integration/wid.
You can also edit certain bidirectional properties once they have been defined by
using the assembly editor in WebSphere Integration Developer. For more
information on using bidirectional properties at run time, refer to the general
technical paper and the adapter technical paper regarding bidirectional support.
For more information on the assembly editor, refer to the assembly editor
documentation on the WebSphere Integration Developer website at
http://www.ibm.com/software/integration/wid.
A hierarchical business object has attributes that represent a child business object,
an array of child business objects, or a combination of the two. In turn, each child
business object can contain a child business object or an array of business objects,
and so on. A single-cardinality relationship occurs when an attribute in a parent
business object represents one child business object. In this case, the attribute is of
the same type as the child business object.
In each type of cardinality, the relationship between the parent and child business
objects is described by the application-specific information of the key attribute in
the business object storing the relationship. For more information on this
application-specific information, see “ForeignKey.”
Related reference
“Stored procedure definition” on page 25
Stored procedures are defined at the verb level. Each stored procedure
definition consists of the following elements: StoredProcedureType,
StoredProcedureName, ResultSet, and Parameters.
“Business object attribute properties” on page 11
Business object architecture defines various properties that apply to attributes.
This section describes how the adapter interprets these properties.
Single-cardinality relationships
Because the foreign keys that establish the relationship are stored in the parent,
each parent can contain only one child business object of a given type.
ParentBOName
PKey
ChildBOName
FKey
ChildPKey
Child(1)
Typically, each parent business object owns the data within the child business
object that it contains. For example, if each Customer business object contains one
Address business object, when a new customer is created, a new row is inserted
into both the customer and address tables. The new address is unique to the new
customer. Likewise, when deleting a customer from the customer table, the
customer’s address is also deleted from the address table.
When multiple business objects contain the same single-cardinality child business
object, the foreign key attribute in each parent business object must specify the
relationship as NOOWNERSHIP. When an application server sends the adapter a
hierarchical business object with a Create, Delete, or Update request, the adapter
ignores single-cardinality children contained without ownership. The adapter
performs only retrieve operations on these business objects. If the adapter fails to
retrieve such a single-cardinality business object, it returns an error and stops
processing.
Note: When making updates to denormalized tables, ensure that each record has a
unique key so that multiple rows are not modified as a result of one update.
If such a key does not exist, the Adapter for JDBC provides an error stating
that multiple records have been updated.
Typically, a business object that contains an array of child business objects has only
one attribute that represents the relationship. The type of the attribute is an array
of the same type as the child business objects. For a parent to contain more than
one child, the foreign keys that establish the relationship are stored in the child.
Therefore, each child has at least one simple attribute that contains the parent’s
primary key as a foreign key. The child has as many foreign key attributes as the
parent has primary key attributes.
Because the foreign keys that establish the relationship are stored in the child, each
parent can have zero or more children.
ChildBOName
ParentBOName
ParentID
ID
Child(1) ChildBOName
ParentID
ChildBOName
ParentID
Applications use this type of relationship when child data does not exist
independently of its parent and can be accessed only through its parent. Such child
data requires that the parent and its primary key value exist before the child and
its foreign key value can be created. The figure titled “Multiple cardinality
relationship with N=1” shows this type of relationship.
ParentBOName
ID
ChildBOName
Child(1)
ParentID
The following table titled ″Attribute properties″ gives the interpretation and
settings for these properties.
Attribute properties
Related concepts
“Business object structure” on page 7
Each business object corresponds to a database table or view, and each simple
attribute within the object corresponds to a column in that table or view.
Supported operations
The adapter performs inbound and outbound operations. After-image and delta
support are provided for outbound operations. The adapter provides only
after-image support for inbound operations. The supported operations are listed
here.
The adapter supports two business object styles that relate to the amount and
purpose of information conveyed by the business object: after-image and delta. An
after-image is the state of a business object after all changes have been made to it. A
delta is a business object used in an update operation that contains only key values
and the data to be changed. The adapter provides both after-image and delta
support for the following operations:
v Create
v Update
v Delete
v ApplyChanges
v Retrieve
v RetrieveAll
Verbs are definable only for after-image business objects. A verb reflects the state of
the business object, whereas an operation reflects the operation to be performed by
the adapter. The top-level verbs supported for after-image are:
v Create
v Update
v Delete
v UpdateWithDelete
Inbound operations
The adapter provides only after-image support for inbound operations. When the
adapter receives a business object for updating, it assumes that the business object
represents the desired state of the data after the update. These are the supported
operations:
v Create
v Update
v Delete
Transaction management
The Adapter for JDBC supports both local and XA transactions.
The Adapter for JDBC supports transactions only if the back-end database supports
transactions. The types of transactions that are supported are local and XA
transactions:
v In a local transaction, a given client application defines the start and end of the
transaction with the database. It uses a one-phase-commit protocol.
v In an XA transaction, the transaction spans multiple heterogeneous databases. It
uses global or two-phase-commit protocol.
The adapter supports XA transactions for IBM(R) DB2(R) and Oracle databases.
Note: If you are using a DB2 database, you must configure the XADatabaseName
property.
The “Reference” section has example values for properties used with local and XA
transactions.
Related reference
“J2C connection factory properties” on page 72
J2C connection factory properties are used to configure a target enterprise
information system (EIS) instance. These properties affect outbound processing
and correspond to the ManagedConnectionFactory interface of the J2EE(TM)
Connector Architecture Specification.
“Reference” on page 68
The section describes the properties for configuration, connection, and object
selection.
Inbound support
The Adapter for JDBC supports inbound event management with asynchronous
event delivery.
Event table
The complete flow of event processing by the Adapter for JDBC is depicted in four
steps that are shown in the following four figures.
The first figure shows the first step, in which the event has been detected in the
EIS and the record has been added to the staging table for each active endpoint.
EIS
poll
event EventStore
- id=1 (EIS-specific)
- status=new
EventManager
JDBC active
Resource
EndPoint A
Adapter
XA DataSource
EventDistribution
write
Table
event id=1, endpoint=A
(Staging Table)
The next figure shows the second step, in which the event in the EIS is marked
in-progress.
EIS
update
event EventStore
- id=1 (EIS-specific)
- status=in progress
EventManager
JDBC active
Resource
EndPoint A
Adapter
XA DataSource
EventDistribution
Table
event id=1, endpoint=A
(Staging Table)
EIS
event EventStore
- id=1 (EIS-specific)
- status=in progress
deliver
EventManager JDBC
Resource
EndPoint A
Adapter
XA DataSource
EventDistribution
Table
event id=1, endpoint=A
(Staging Table)
In the fourth step, once all endpoints have received the event, as determined by a
lack of remaining references in the staging table, the original event is deleted from
the EIS. Steps 1 through 4 repeat for every event.
EIS
(event deleted) delete EventStore
(EIS-specific)
EventManager JDBC
Resource
EndPoint A
Adapter
XA DataSource
EventDistribution
Table
(Staging Table)
At various points in the business object verb operations, the adapter compares two
business objects to see if they are the same. For example, during an update
operation, the adapter determines whether a particular business object exists in an
array of business objects. To perform the check, the adapter compares the business
object to each business object within the array. For two business objects to be
identical, the following two conditions must be satisfied:
v The type of the business objects being compared must be the same. For example,
a Customer business object is never considered identical to a Contact business
object, even if all of their attributes are exactly the same.
v All corresponding key attributes in the two business objects must contain
identical values. If a key attribute is not set in both business objects, the adapter
considers them identical, However, if a key attribute is set in one business object,
but not in the other, the business objects are not identical.
Create operation
When given a hierarchical business object, the create operation recursively
traverses the business object, creating rows corresponding to each table.
Note: For this approach to work correctly when the child business object exists
in the application database, primary key attributes in child business
objects must be cross-referenced correctly on create operations. If the
child business object does not exist in the application database, the
primary key attributes must not be set.
3. It inserts the top-level business object in the database as follows:
a. It sets each of its foreign key values to the primary key values of the
corresponding child business object represented with single cardinality.
Because values in child business objects can be set by database sequences or
counters or by the database itself during the creation of the child, this step
ensures that the foreign key values in the parent are correct before the
adapter inserts the parent in the database.
b. It generates a new, unique ID value for each attribute that is set
automatically by the database. The name of the database sequence or
Retrieve operation
This topic describes the steps the adapter takes to retrieve a hierarchical business
object.
Note: The adapter does not enforce uniqueness when populating an array of
business objects. It is the database’s responsibility to ensure uniqueness.
If the database returns duplicate child business objects, the adapter
returns duplicate children.
4. It recursively retrieves each of the single-cardinality children, regardless
whether the child business object is contained with or without ownership.
Note: All single-cardinality child business objects are processed based on their
occurrence in the business object and before the parent business object is
processed. Child object ownership and non-ownership do not determine
the processing sequence, but they do determine the type of processing.
RetrieveAll operation
This operation enables the adapter to retrieve an array of business objects from the
database.
All of the key and non-key attributes populated in the incoming business object
determine the selection criteria. The adapter may retrieve multiple rows for the
top-level business object from the database, depending on the attributes selected. If
no attributes are populated in the incoming business object, all the rows are
retrieved from the respective table in the database.
The following figure describes the structure of the business object that is returned
in a RetrieveAll operation.
CustomerContainerBO
CustomerBG Customer
Address BO
CustomerBG Customer
Address BO
Update operation
The update operation is done by comparing the incoming business object with a
business object that is retrieved from the database using the primary keys specified
in the top-level, incoming business object.
The adapter performs the following steps when updating a hierarchical business
object:
1. It uses the primary key values of the source business object to retrieve the
corresponding entity from the database. The retrieved business object is an
accurate representation of the current state of the data in the database.
If the retrieval fails, indicating that the top-level business object does not exist
in the database, the adapter returns a RecordNotFoundException error, and the
update fails.
If the retrieval succeeds, the adapter compares the retrieved business object to
the source business object to determine which child business objects require
changes in the database. The adapter does not, however, compare values in the
UpdateWithDelete operation
This is a special form of the Update operation that can be used to provide better
performance than the Update operation.
DeltaUpdate operation
If the operation in the InteractionSpec is ApplyChanges, and the verb does not
exist in the business graph, the adapter performs the DeltaUpdate operation. The
adapter inspects the ChangeSummary to identify the operation for each business
object in the input hierarchy and performs the operation that was identified.
The adapter performs the following steps when updating a hierarchical business
object with DeltaUpdate. It processes only object changes from the
ChangeSummary:
1. It recursively processes all single-cardinality children of the parent object. If a
child is marked required in the business object specification, it must be present
in the inbound object. If it is not, the DeltaUpdate operation fails, and the
adapter returns an error.
2. It sets all foreign key values in the parent that reference attributes in
single-cardinality children to their corresponding child values. This is necessary
because single-cardinality children might have been added to the database
during the previous steps, resulting in the generation of new sequence values.
3. It updates the current object being processed using an SQL Update statement or
a stored procedure. All simple attributes of the individual business object are
updated. The adapter does not use property level changes to determine which
attributes need to be added to the update statement; they are all updated.
Because the object being updated should be unique, the adapter checks to
ensure that only one row is processed as a result. An error is returned if more
than one row is processed.
4. It sets all foreign key values in all cardinality N children of the current object
that reference parent attributes to the corresponding parent values. Usually
these values are already cross-referenced during data mapping; however, this
might not be the case for new children in cardinality N containers. This step
ensures that the foreign-key values in all cardinality N children are correct
before those children are updated.
5. It updates all cardinality N containers of the current object.
When the child objects are processed, each child’s verb is taken and the
appropriate operation is performed. The allowed operations on a child in
DeltaUpdate are create, delete, and update:
v If a Create verb is found in the child, the child is created in the database if it
is an ownership child. Non-ownership children are retrieved to validate their
existence in the database.
v If a Delete verb is found in the child, that child is deleted.
v If an Update verb is found in the child, the child gets updated in the
database.
The delete operation supports physical and logical deletes, depending on the
StatusColumnName value in the object’s application-specific information. If the
StatusColumnName value is defined, the adapter performs a logical delete
operation. If the StatusColumnName value is not defined, the adapter performs a
physical delete operation.
ApplyChanges operation
The ApplyChanges operation covers a variety of things. It enables any business
object requiring a create, update, or delete operation to be processed accordingly
by the adapter.
If the top-level verb exists in the business object, then the business object is
processed as an after-image. If no top-level verb exists in the business object, then
the ChangeSummary is processed.
Application-specific information
Application-specific information in business object definitions provides the adapter
with application-dependent instructions on how to process business objects. The
adapter parses the application-specific information from the attributes or verb of a
business object or from the business object itself to generate queries for create,
update, retrieve, and delete operations.
Business object names should be converted to camel case, in which separators like
spaces and underscores are removed, and the first letter of each word is
capitalized; for example, ORDER_LINE_ITEM would be converted to
OrderLineItem.
The parent business object graph should be named for the contained business
object, followed by BG; for example, CustomerBG for a Customer business object.
Business object names have no semantic value to the adapter or the database.
Business objects carry database-specific metadata. They can have a string like JDBC
or %AppName% as a prefix to help distinguish between the two types of business
objects: application-specific and generic. The remainder of the name can describe
the table or stored procedure that the business object represents. For example, if
the business object definition is generated for the Employee Table in a database
application, such as Human Resources (HR), the respective business object name
will be HREmployee.
For example, assume that a Customer business object has the following value
specified for its business object application-specific information:
<jdbcasi:TableName>customer</jdbcasi:TableName>
<jdbcasi:StatusColumnName>status</jdbcasi:StatusColumnName>
<jdbcasi::StatusValue>deleted</jdbcasi:StatusValue>
Assume that the adapter receives a request to delete a customer. Such a request
causes the adapter to issue the following SQL statement:
UPDATE customer set status = ’deleted’ where pkey = . . . .
Both update and delete operations can use the value of the StatusColumnName
property:
Parameters of the ASI that are enabled for use with bidirectional languages are
TableName and StatusColumnName. The format for these parameters are
transformed based on the attributes set for the BiDi.Metadata property. For more
information on this property, see “Configuration properties” on page 68.
A stored procedure is a group of SQL statements that form a logical unit and
perform a particular task. A stored procedure encapsulates a set of operations or
queries for the adapter to run on an object in a database server.
The adapter can use simple SQL statements for select, update, retrieve, delete or
retrievall operations. The column names for SQL statements are derived from an
attribute’s AppSpecificInfo property. The WHERE clause is constructed using key
values specified in the business object. Each query spans one table only, unless
posted to a view.
Stored procedures are defined at the verb level. Each stored procedure definition
consists of the following elements: StoredProcedureType, StoredProcedureName,
ResultSet, and Parameters.
Parameters can be a combination of input only (IP), output only (OP), and input
and output (IO). In the case of Oracle stored procedures, a result set can be
returned only as an output parameter. In that case, one of the values in the list of
parameters is result set (RS). Parameters are enabled for use with bidirectional
languages.
The attribute ASI parameters that are enabled for use with bidirectional languages
are ColumnName and ForeignKey. The format of these parameters is transformed
based on the attributes set for the BiDi.Metadata property. For more information on
this property, see ″Configuration properties″ in the ″Reference″ section. For more
information on bidirectional properties, see the bidirectional support general
technical paper and the adapter technical paper on the IBM developerWorks(R)
Web site.
Parameter Description
ByteArray If true, the adapter reads and writes binary
data to the database and sends that data as a
string to the application server. By default
the value is false. For more information, see
“Working with binary data.”
ColumnName The value of this parameter is the name of
the database column for this attribute. This
is enabled for use with bidirectional
languages.
FixedChar This parameter specifies whether the
attribute is of fixed length when the
columns in the table are of type CHAR, not
VARCHAR. For example, if a particular
attribute is linked to a column that is of type
CHAR, the adapter pads the attribute value
with blanks to the maximum length of the
attribute when querying the database. By
default the value is false.
For information on how to install the adapter, see Installing IBM WebSphere
Adapters.
Adapter environment
Hardware and software requirements of the adapter environment are available
online.
To find the requirements for this adapter, refer to “IBM WebSphere Adapters and
IBM WebSphere Business Integration Adapters: software requirements” at
http://www-1.ibm.com/support/docview.wss?uid=swg27006249. Select your
adapter from the list of WebSphere adapters.
You need to set up the JDBC driver so that the JDBC driver JAR file is in the class
path.
JDBC enterprise service discovery exists within a project in the enterprise service
discovery wizard. The JDBC driver JAR file needs to be in the class path of the
JDBC project in this tool to enable you to run the JDBC enterprise service
discovery process.
You need to set up the event store in the database before inbound processing can
be done. Sample scripts are provided to set up the event store for the IBMR DB2R,
Oracle, or MicrosoftTM SQLServer database, as follows:
v WBIA_JDBC_EventStore_DB2.sql
v WBIA_JDBC_EventStore_Oracle.sql
v WBIA_JDBC_EventStore_MSSQL.sql
You should set up triggers on user tables as needed so that changes to the user
tables can automatically generate events that are stored in the event store.
The resource adapter archive (RAR) file contains both the adapter and the
enterprise service discovery tool files.
UNIX(R) and Windows(TM) platforms share the same installed directory and file
structure, with the only difference being the directory path designation (forward
slash / for UNIX, backslash \ for Windows).
The following table lists the UNIX/Linux(TM) directories and files for the
WebSphere Adapter for JDBC. Directories and files are grouped into categories.
The following table lists the Windows directories and files for the WebSphere
Adapter for JDBC. Directories and files are grouped into categories.
Before you deploy the adapter, you must install these products:
v WebSphere Integration Developer, Version 6.0
v WebSphere Process Server--You will use the WebSphere Process Server
administrative console to deploy the adapter project on the application server
and to reconfigure property values.
Refer to the IBM(R) WebSphere Process Server installation instructions at
http://www.ibm.com/software/integration/wps.
Creating the adapter project requires that you perform the following tasks:
v Create a project for the adapter
v Add vendor libraries
v Generate business objects and service constructs
v Set configuration property values, and save the values and artifacts in a new
business integration module
v Deploy the adapter project to the server, and start the application
To add the external JAR file, click Java Build Path. Select the Libraries tab and
click Add External Jars. In the File System window, navigate to the JDBC Driver
and select the JAR file.
Before beginning the tasks to generate business objects, you can read details about
the process in the sections about metadata import, discovery of system capabilities,
and data descriptions.
Metadata import
You use the enterprise service discovery wizard in the WebSphere(R) Adapter for
JDBC to discover objects in a database and to generate business objects from the
selected objects. Enterprise service discovery support also generates the service
constructs that enable the adapter to run as a Service Component Architecture
(SCA) component.
Objects from which business objects can be created include tables, views, stored
procedures, and synonyms/nicknames. The adapter enables you to discover the
objects by generating a list of all the schemas in the database. Within each schema
Connect/browse
EIS metadata Adapter
Enterprise JDBC
Service Metadata EIS
Discover Import
Discovery Discovery
Service
Service metadata
Import/Build
The schemas are displayed as the top-level nodes in the tree. The schema nodes
are not selectable for generation.
Under each schema are nodes labeled Tables, Views, Stored Procedures, and
Synonyms/Nicknames. These nodes are not selectable for generation. The objects
listed under these nodes are the names of the tables, views, stored procedures, and
synonyms/nicknames. These nodes are marked as selectable for generation. If no
tables, views, stored procedures, or synonyms exist for a particular schema, none
are listed.
You can specify filter properties if you want to narrow the list of schemas
displayed in the tree; otherwise, all schemas are displayed. “Filter and node
properties” in the “Reference” section describes the properties you need to
provide.
To generate business objects, you select database object nodes. Then the enterprise
service discovery wizard generates business objects for the objects of the selected
nodes.
You can select multiple database object nodes. When you specify filter properties, if
you check Add business object ASI, then for each node that you select, the
enterprise service discovery wizard requests the object-level parameters for
StatusColumnName, StatusValue, and stored procedure association.
For StatusColumnName, you are presented with a list of the actual column names
for the particular object from which to set the StatusColumnName. You need to
type the StatusValue. These values are set in the business object level
application-specific information (ASI).
You can choose to associate stored procedures to the business objects. A list of all
the supported stored procedure types is presented. Each stored procedure type has
a list of stored procedures available in the database. One stored procedure can be
assigned to a particular stored procedure type.
For each stored procedure assigned, a list of the stored procedure’s input and
output parameters is presented. Each parameter has a list of the business object’s
attributes. The parameter’s type is listed in the property’s description. You may
select one business object attribute for each stored procedure parameter. All of the
stored procedure types that have a stored procedure assigned are added to the
verb application-specific information of the business object. See “Verb
application-specific information.”
After you have selected database objects, you need to set values for the Selection
properties. The enterprise service discovery wizard queries for the Selection
properties. For details about these properties, see “Selection properties” in the
“Reference” section.
Related tasks
“Selection properties” on page 80
After you have selected database objects, you need to set values for the
Selection properties.
Related reference
“Verb application-specific information” on page 24
The adapter updates database tables using SQL queries or stored procedures,
which are groups of SQL statements, as specified in the business objects. Stored
procedures and the elements of a stored procedure definition are described in
this section. A sample of a stored procedure definition is included.
Data descriptions
Data descriptions are some of the service constructs that the enterprise service
discovery process generates to enable the adapter to run as a Service Component
Architecture (SCA) component.
The data description includes a definition of the structure and content of adapter
business objects that is passed between the client application and the adapter at
run time. The data description enables the client application to create the proper
data objects for requests, and to interpret the data objects returned as responses.
The data description generated from the database components is represented as an
XML schema.
Note: The template for the application-specific properties for the business object
and the attribute level are defined in the metadata schema for the JDBC
adapter. The name of the schema file is JDBCASI.xsd. The generated schema
file has a reference to this template in its annotations.
The business object schema is built out of database components that you select.
Each component translates into a top-level business object.
The enterprise service discovery wizard generates the name of the business object
in the form of PrefixSchemaNameObjectName, where
v Prefix is the value as specified in the connection property named Prefix. Prefix is
not required, and if not specified, no prefix will be added to the business object
name.
v SchemaName is the name of the schema to which the object belongs.
v ObjectName is the name of the table, view, stored procedure, or
synonym/nickname.
Globalized characters are supported in the business object name.
All business objects created are top-level. The enterprise service discovery wizard
will not create any recursive (child) business objects. The enterprise service
discovery wizard also generates business graphs for all business objects, because
all are top-level. The name of the business graph will be the business object name
followed by “BG.” For example, a business object with the name
The attributes of a business object are built from the list of columns in the database
object. The enterprise service discovery wizard sets the attribute name to the name
of the column. Globalized characters are supported in the attribute names. The
adapter adds the attribute name, type, and application-specific information.
The types returned by the JDBC metadata are mapped to the business object
attribute types as listed in the table “JDBC metadata column and business object
attribute types.” Only the JDBC types listed are supported by the adapter. Any
columns with types not listed are not added to the business object. An
informational message is produced stating, for example, The column named xxxx in
the table named yyyy is not of a supported type and will not be added to
the business object.
The table titled “Attribute information” lists the attribute information set by the
enterprise service discovery wizard and describes how it is set.
Attribute information
If you choose to add stored procedures to the business objects, the verb
application-specific information (ASI) is set as specified in the table titled “Verb
application-specific information.” For information on valid stored procedure types,
see the section “Verb application-specific information.”
The enterprise service discovery wizard generates flat business objects. It does not
use the foreign key constraints that are defined in the database between different
tables to build relationships automatically. These need to be linked manually. You
can update the business object definitions either in text mode or by using the
business object editor.
An example of the .xsd definition file for single- and multiple-cardinality child
business objects is provided here. The element custInfoObj is a single-cardinality
child business object, and addressObj is a multiple-cardinality child business object.
<element name="addressObj" minOccurs="1" type="Address:Address"
maxOccurs="unbounded">
<annotation>
<appinfo source="WBI">
<pasi:JDBCAttributeTypeMetadata xmlns:pasi=
"urn:app:jdbc:asi">
<pasi:Ownership>true</pasi:Ownership>
</pasi:JDBCAttributeTypeMetadata>
</appinfo>
</annotation>
</element>
<element name="custInfoObj" minOccurs="0" type=
"CustInfo:CustInfo" maxOccurs="1">
<annotation>
<appinfo source="WBI">
<pasi:JDBCAttributeTypeMetadata xmlns:pasi=
"urn:app:jdbc:asi">
<pasi:Ownership>false</pasi:Ownership>
</pasi:JDBCAttributeTypeMetadata>
</appinfo>
</annotation>
</element>
The discovery service uses the connection properties to prepare a metadata tree
that is displayed for object selection and navigation.
Related tasks
“Enabling logging” on page 52
The WebSphere(R) Adapter for JDBC maintains a log file that you can view to
determine the status of event processing. All events and errors that relate to the
adapter are tracked by the log file, along with the date, time, and event for each
log entry. Because the adapter logs an error message when it encounters an
error or warning condition, the log file is a good source to start troubleshooting
problems.
“Enabling tracing” on page 54
Tracing determines what level of errors or warnings are captured in the adapter
log file. You can trace messages regarding adapter processing by defining a
tracing level.
Related reference
Before running the query, you can specify Filter Properties if you want to narrow
the list of schemas, nodes, or objects displayed in the tree structure.
1. Specify Filter Properties
In the window Find and Discover Enterprise Services, click Edit Query. In the
pop-up window Query Filter Properties, enter text in the Schema Name Filter
property field. The schemas that start with the specified string are displayed.
Select the schemas that you want to use.
The Types property field lists the entries: tables, views, stored procedures, and
synonyms/nicknames. You can add or remove nodes from that list.
In the Query Filter Properties window, you can check Add Business Object
ASI. Then whenever you add an object when you run the metadata query in
Step 2, a window called Configuration Parameters for (name of object) appears
for entering application-specific information.
Note: The Deploy connector with module check box must be checked to
ensure that the connector project RAR file is included in the EAR file
that you deploy to the application server.
3. Set configuration property values
The option Use connection properties specified on server can be used in the
future after you deploy the project, whenever you need to create new business
objects. It indicates that you want to use the properties already on the
application server. The J2C Authentication Data Entry field is used to specify
Normally, the configuration properties are set using the enterprise service
discovery wizard when you create your adapter project. You can reset the
properties using the WebSphere(R) Process Server administrative console, or you
can just note whether the properties are populated according to the values you set
in the enterprise service discovery wizard.
1. Open the adapter project
In the WebSphere Process Server administrative console, in the Configuration
pane, the name of your adapter project appears. Under the Related Items
heading, select Connector Modules. The project RAR file name is displayed.
Click the check box next to the file name.
Under Additional Properties, select Resource Adapter.
2. Reconfigure properties
a. Edit J2C connection factory property values
In the administrative console, your adapter project is displayed under
General Properties > Name. On the right side of the window under
Additional Properties, click J2C connection factories.
The adapter project name is displayed along with the JNDI name specified
in the EJB project. Click the check box next to your adapter’s factory
connection.
The J2C connection factory properties and values appear. Edit the values for
the properties as needed. For details about these properties see “J2C
connection factory properties.”
b. Set values for J2C activation specification properties
Note: In the Custom properties list, at the adapter level, find the
DatabaseVendor property. This property is required for starting the
application. Enter a value for this property if it is blank, and save it.
3. Start the adapter application
In the administrative console, in the panel on the left side, click Applications >
Enterprise Applications. In the Enterprise Applications pane, click the check
box next to your application’s name and click Start. A message will indicate
that the application started successfully. If problems occur when you try to start
the application, check the adapter log file for error descriptions.
For information on specific messages, see Messages in the IBM WebSphere
Adapters Information Center. For details on logging and tracing, see
“Troubleshooting.”
Related tasks
“Troubleshooting” on page 51
You can contact IBM(R) Software Support when you need to report a problem,
following the instructions in this section. You can determine the status of event
processing by enabling logging for the adapter. You can set tracing levels to
determine the level of errors or warnings captured in the adapter log file. The
instructions in this section describe how to enable the Common Event
Infrastructure for your adapter. And this section describes mainframe data
access.
Related reference
“J2C connection factory properties” on page 72
J2C connection factory properties are used to configure a target enterprise
information system (EIS) instance. These properties affect outbound processing
and correspond to the ManagedConnectionFactory interface of the J2EE(TM)
Connector Architecture Specification.
“J2C activation specification properties” on page 74
J2C activation specification properties activate message endpoints. These
properties correspond to the ActivationSpec Interface of the J2EE(TM) Connector
Architecture Specification.
Troubleshooting
You can contact IBM(R) Software Support when you need to report a problem,
following the instructions in this section. You can determine the status of event
processing by enabling logging for the adapter. You can set tracing levels to
determine the level of errors or warnings captured in the adapter log file. The
instructions in this section describe how to enable the Common Event
Infrastructure for your adapter. And this section describes mainframe data access.
Related tasks
“Configuring the adapter on the server” on page 49
Once the project enterprise application archive (EAR) file for the adapter project
has been installed on the application server, if you want you can reconfigure
properties that the adapter uses to set up a communication channel to a specific
database application. Then you can start the configured adapter application.
Before contacting IBM Software Support, your company must have an active IBM
software maintenance contract, and you must be authorized to submit problems to
IBM. The type of software maintenance contract that you need depends on the
type of product you have:
v For IBM distributed software products (including, but not limited to, Tivoli®,
Lotus®, and Rational® products, as well as DB2® and WebSphere® products that
run on Windows® or UNIX® operating systems), enroll in Passport Advantage®
in one of the following ways:
– Online: Go to the Passport Advantage Web page and click How to Enroll.
– By phone: For the phone number to call in your country, go to the contacts
page of the IBM Software Support Handbook on the Web and click the name
of your geographic region.
v For IBM eServer™ software products (including, but not limited to, DB2 and
WebSphere products that run in zSeries®, pSeries®, and iSeries™ environments),
you can purchase a software maintenance agreement by working directly with
an IBM sales representative or an IBM Business Partner. For more information
about support for eServer software products, go to the IBM Technical Support
Advantage Web page.
If you are not sure what type of software maintenance contract you need, call
1-800-IBMSERV (1-800-426-7378) in the United States or, from other countries, go to
the contacts page of the IBM Software Support Handbook on the Web and click the
name of your geographic region for phone numbers of people who provide
support for your location.
If the problem you submit is for a software defect or for missing or inaccurate
documentation, IBM Software Support will create an Authorized Program Analysis
Report (APAR). The APAR describes the problem in detail.
Whenever possible, IBM Software Support will provide a workaround for you to
implement until the APAR is resolved and a fix is delivered. IBM publishes
resolved APARs on the IBM product support Web pages daily, so that other users
who experience the same problem can benefit from the same resolutions.
Enabling logging
The WebSphere(R) Adapter for JDBC maintains a log file that you can view to
determine the status of event processing. All events and errors that relate to the
adapter are tracked by the log file, along with the date, time, and event for each
log entry. Because the adapter logs an error message when it encounters an error
or warning condition, the log file is a good source to start troubleshooting
problems.
The adapter communicates with the database through a JDBC driver, and the SQL
queries or stored procedure calls could result in an SQLException message. These
are captured and logged and a ResourceException message is produced. Messages
Note: When you create and bind both an inbound and outbound operation to the
same adapter instance with the same AdapterID property, you need to use
the same log name, because only one log file will be created once you
deploy the adapter to WebSphere Process Server. If the inbound and
outbound operations belong to different adapters, each with a different
AdapterID, then a separate log file will be created for each operation.
Logging for the adapter is enabled through the WebSphere Process Server
administrative console. Follow the steps below to enable logging.
1. Start logging and tracing
Start the WebSphere Process Server administrative console. From the
administrative console, select Troubleshooting → Logs and Trace.
2. Specify log detail level
Click either Component to specify a log detail level for individual components,
or click Groups to specify a log detail for a predefined group of components.
3. Select the logging level
The ″Logging levels″ table describes the different logging levels that you can
set through the administrative console.
Note: To view log events that are below the Detail level, you must enable the
Diagnostic Trace Service. Log events that are at Detail level or above can
be viewed in the SystemOut log, the IBM(R) Service log (when enabled),
or the Diagnostic Trace Service (when enabled).
Logging levels
Enabling tracing
Tracing determines what level of errors or warnings are captured in the adapter
log file. You can trace messages regarding adapter processing by defining a tracing
level.
You can configure the tracing levels through the WebSphere(R) Process Server
administrative console. Follow the steps below to enable and set tracing levels.
1. Start tracing
Start the WebSphere Process Server administrative console. Select
Troubleshooting → Logs and Trace.
2. Select the tracing level
The ″Tracing levels″ table describes the different tracing levels that you can set
through the administrative console.
Tracing levels
You must publish the IBM WebSphere Adapters Event Definitions file to the CEI
catalog before you can set these event definitions. For instruction on how to do
this, refer to the CEI documentation found on the WebSphere Process Server web
site at http://www.ibm.com/software/integration/wps.
1. Start the WebSphere administrative console.
2. Go to Troubleshooting → Log and Trace and select <your server name>.
3. There are many options for the General Properties. Select Change Log Detail
Level, and then select com.ibm.j2ca.* for JCA components. Under this section
there is a subcomponent for each adapter type:
v com.ibm.j2ca.flatfile.* (WebSphere Adapter for Flat Files)
v com.ibm.j2ca.jdbc.* (WebSphere Adapter for JDBC)
v com.ibm.j2ca.peoplesoft.* (WebSphere Adapter for PeopleSoft)
v com.ibm.j2ca.sap.* (WebSphere Adapter for SAP)
v com.ibm.j2ca.siebel.* (WebSphere Adapter for Siebel)
4. Select the component that matches your adapter. Each adapter component has
two subcomponents, one for logging and one for CEI. They are:
v subcomponent name.log.adapter id
v subcomponent name.cei.adapter id
For example, com.ibm.j2ca.siebel.cei.<AdapterID1>. For each instance of a
deployed adapter, the system will show a separate ID.
5. Select the CEI adapter ID that you want to enable.
6. From the drop-down menu, you can choose from the following:
v off - turn CEI off
v fine- turn CEI on with Event Content set to Empty
v finer- turn CEI on with Event Content set to Digest
v finest- turn CEI on with Event Content set to Full
v all - same as finest
For information on what each Event Content level means (Empty, Digest and Full),
and for more information on using the Common Base Event model and the
Common Event Infrastructure, refer to the documentation on the WebSphere
Process Server web site at http://www.ibm.com/software/integration/wps
If you have problems using the Adapter for JDBC with IBM WebSphere
Information Integrator Classic Federation on the IBM z/OS platform, refer to
technotes describing configuration requirements on the IBM product support Web
pages at http://www-306.ibm.com/software/integration/wbiadapters/support.
For more details on the roles of application integrator and data integrator, see the
“Audience” topic in the “Product Overview.”
Related concepts
“Audience” on page 2
The information in this topic defines the users of the WebSphere Adapter
products and details the skills they require.
Before using the scenarios, you need to install the adapter and extract the samples
package from the folder called “Sample.”
For information about installing the adapter, refer to Installing IBM WebSphere
Adapters.
The enterprise application archive (EAR) file for this project contains the following
files:
v A configured instance of the adapter that is deployed by default to the local host
application server: CWYBC_JDBC.rar
v A service component architecture (SCA) module with various SCA artifacts:
– JDBCInboundInterface.export
– JDBCInboundInterface.wsdl
– JDBCOutboundInterface.import
Before using one of the scenarios, you need to install the adapter and extract the
samples package from the folder called “Sample.”
For information about installing the adapter, refer to Installing IBM WebSphere
Adapters.
The enterprise application archive (EAR) file for this project contains the files listed
below. These files are examples of the artifacts you will create in this scenario
when you use the enterprise service discovery wizard to generate artifacts and
configure the adapter for deployment and use. When you complete the scenario,
you can view the files to compare them with your output. The files include sample
import, export, WSDL and business object files, as follows:
v JDBCOutboundInterface.import
The sample provides an instance of the adapter that is already configured. In the
following procedure, you need to update the business object application-specific
information (ASI) to match your environment. And you need to change the values
of the configuration properties to match the database instance in your enterprise
information system (EIS).
1. Start WebSphere(R) Integration Developer
For details, refer to the WebSphere Integration Developer user guide at
http://www.ibm.com/software/integration/wid.
2. Create the business integration module
In WebSphere Integration Developer, go to the Business Integration perspective.
Right click in the Business Integration pane. Click New > Module. In the New
Module window, enter JDBC for the Module Name. Click Finish.
3. Import the Resource Adapter Archive (RAR) file
a. Click File > Import. In the Select window, select RAR file as the import
source and click Next. This imports CWYBC_JDBC.rar into WebSphere
Integration Developer.
b. In the Connector Import window, at the Connector file field, browse to the
path and name of the module created in the previous step, for example,
Click Next.
7. Query for database objects.
After configuring the connection properties, you can run a query for database
objects. You can browse the metadata tree structure to understand the
structure of objects in the enterprise information system (EIS), and make
selections of objects needed for the service description.
You will run the sample using the WebSphere(R) Integration Developer test client.
1. Select the Business Integration module and server
Click the Events tab on the bottom left side and then click Continue. From the
Select Deployment Location pop-up window, select the application server to
run the application. Select WebSphere Process Server v6.0 and click Finish.
The pop-up window Starting the integration test client appears.
2. Test event processing
To test event processing, you can insert an event manually into the sample
application event table. Use the following example as a guide for inserting the
event into the event store with a SQL statement:
INSERT INTO wbia_jdbc_eventstore (object_key, object_name, object_function,
event_priority, event_status)
VALUES (’11234’, ’InboundRtasserCustomerBG’, ’Create’, 1, 0)
When the monitored component receives the event, an entry appears in the
Events window. See the following example Events window.
Configuration properties
This group of properties contains attributes used by the adapter to set up a
communication channel to a specific database application.
The table titled “J2C connection factory properties” defines the JDBC configuration
properties that pertain to a J2C connection factory. Two additional tables in this
section define the bidirectional J2C connection factory properties that need to be
configured only when bidirectional text transformation has been activated.
Related concepts
“Transaction management” on page 13
The Adapter for JDBC supports both local and XA transactions.
Related tasks
“Configuring the adapter on the server” on page 49
Once the project enterprise application archive (EAR) file for the adapter project
has been installed on the application server, if you want you can reconfigure
properties that the adapter uses to set up a communication channel to a specific
database application. Then you can start the configured adapter application.
The table titled, “J2C activation specification properties” describes the JDBC
adapter-specific configuration properties that pertain to activating message
endpoints. A separate table in this section describes the bidirectional J2C activation
specification properties that need to be configured only if bidirectional text
transformation has been activated.
Related tasks
“Configuring the adapter on the server” on page 49
Once the project enterprise application archive (EAR) file for the adapter project
has been installed on the application server, if you want you can reconfigure
properties that the adapter uses to set up a communication channel to a specific
database application. Then you can start the configured adapter application.
Connection properties
Connection properties are used by the enterprise service discovery wizard for
connecting to the target enterprise information system (EIS) instance.
Related tasks
“Deploying and configuring for Scenario 2” on page 63
In Scenario 2, you will set adapter connection properties and generate business
objects. You will export your project to an enterprise application archive (EAR)
file, deploy the project on the application server, and reset configuration
properties.
Related tasks
“Setting connection properties” on page 40
After you have created the adapter project, you need to initialize the enterprise
service discovery wizard for the Adapter for JDBC and set the values of the
connection properties for your database instance.
Letter
Property Value Position Description
BiDi OrderingSchema Implicit 1 Logical (Implicit). Implicit is
Visual the default.
Visual
BiDi Direction LTR 2 Left to Right. LTR (L) is the
RTL default.
contextual_LTR Right to Left
contextual_RTL Contextual Left to Right
Contextual Right to Left
BiDi Yes 3 Symmetric swapping is on. Yes
SymmetricSwapping No (Y) is the default.
Symmetric swapping is off
BiDi Shaping nominal 4 Nominal (N). This is the default.
shaped Letter shaped according to its
initial position.
middle Letter is in its initial shape.
final Letter is in its middle shape.
isolated Letter is in its final shape.
Letter is in its isolated shape.
BiDi NumericShaping nominal 5 Nominal (N). This is the default.
national Hindi (National)
contextual Contextual
Related tasks
“Setting connection properties” on page 40
After you have created the adapter project, you need to initialize the enterprise
service discovery wizard for the Adapter for JDBC and set the values of the
connection properties for your database instance.
The table titled “Filter properties” describes the properties you need to use to filter
the schemas.
Filter properties
The table titled “Node property” describes the property you need to use to filter
database objects.
Node property
Related concepts
“Discovery of system capabilities” on page 34
The adapter discovers business objects in a database by analyzing the database
to identify the schemas. Then it creates a list of all the objects from the database
and shows it as a tree structure.
Selection properties
After you have selected database objects, you need to set values for the Selection
properties.
The enterprise service discovery wizard queries for the Selection properties. The
table titled “Selection properties” describes these properties.
Selection properties
The NameSpace property is initially set to the default NameSpace for all business
objects. The default namespace is http://www.ibm.com/xmlns/prod/websphere/
j2ca/jdbc.
The NameSpace is prepended to the business object name to keep business object
schemas logically separated. For example: http://www.ibm.com/xmlns/prod/
websphere/j2ca/jdbc/Schema1Customer.
Related concepts
“Object selection and generation” on page 35
To generate business objects, you select database object nodes. Then the
enterprise service discovery wizard generates business objects for the objects of
the selected nodes.
Related tasks
“Setting Selection Properties” on page 45
After you have selected database objects, you need to specify values for the
Selection properties for the import and export files.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user’s responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
IBM World Trade Asia Corporation Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106-0032, Japan
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.
All statements regarding IBM’s future direction or intent are subject to change or
withdrawal without notice, a nd represent goals and objectives only.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
COPYRIGHT LICENSE:
If you are viewing this information softcopy, the photographs and color
illustrations may not appear.
However, this information may also contain diagnosis, modification, and tuning
information. Diagnosis, modification and tuning information is provided to help
you debug your application software.
i5/OS
IBM
the IBM logo
AIX
AIX 5L
CICS
CrossWorlds
DB2
DB2 Universal Database
Domino
HelpNow
IMS
Informix
iSeries
Lotus
Lotus Notes
MQIntegrator
MQSeries
MVS
Notes
OS/400
Passport Advantage
pSeries
Redbooks
SupportPac
WebSphere
z/OS
Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the
United States, other countries, or both.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.
Notices 85
Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo,
Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or
registered trademarks of Intel Corporation or its subsidiaries in the United States
and other countries.
UNIX is a registered trademark of The Open Group in the United States and other
countries.
Printed in USA