Sun Microsystems eWAY Adapter for VSAM 5.1.3 User Manual

SUN SEEBEYOND

eWAY™ ADAPTER FOR VSAM USER’S GUIDE

Release 5.1.3

Copyright © 2007 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, U.S.A. All rights reserved. Sun Microsystems, Inc. has intellectual property rights relating to technology embodied in the product that is described in this document. In particular, and without limitation, these intellectual property rights may include one or more of the U.S. patents listed at http://www.sun.com/patents and one or more additional patents or pending patent applications in the U.S. and in other countries. U.S. Government Rights - Commercial software. Government users are subject to the Sun Microsystems, Inc. standard license agreement and applicable provisions of the FAR and its supplements. Use is subject to license terms. This distribution may include materials developed by third parties. Sun, Sun Microsystems, the Sun logo, Java, Sun Java Composite Application Platform Suite, SeeBeyond, eGate, eInsight, eVision, eTL, eXchange, eView, eIndex, eBAM, eWay, and JMS are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. in the U.S. and other countries. Products bearing SPARC trademarks are based upon architecture developed by Sun Microsystems, Inc. UNIX is a registered trademark in the U.S. and other countries, exclusively licensed through X/Open Company, Ltd. This product is covered and controlled by U.S. Export Control laws and may be subject to the export or import laws in other countries. Nuclear, missile, chemical biological weapons or nuclear maritime end uses or end users, whether direct or indirect, are strictly prohibited. Export or reexport to countries subject to U.S. embargo or to entities identified on U.S. export exclusion lists, including, but not limited to, the denied persons and specially designated nationals lists is strictly prohibited.

Copyright © 2007 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, Etats-Unis. Tous droits réservés. Sun Microsystems, Inc. détient les droits de propriété intellectuels relatifs à la technologie incorporée dans le produit qui est décrit dans ce document. En particulier, et ce sans limitation, ces droits de propriété intellectuels peuvent inclure un ou plus des brevets américains listés à l'adresse http://www.sun.com/patents et un ou les brevets supplémentaires ou les applications de brevet en attente aux Etats - Unis et dans les autres pays. L'utilisation est soumise aux termes de la Licence. Cette distribution peut comprendre des composants développés par des tierces parties. Sun, Sun Microsystems, le logo Sun, Java, Sun Java Composite Application Platform Suite, Sun, SeeBeyond, eGate, eInsight, eVision, eTL, eXchange, eView, eIndex, eBAM et eWay sont des marques de fabrique ou des marques déposées de Sun Microsystems, Inc. aux Etats-Unis et dans d'autres pays. Toutes les marques SPARC sont utilisées sous licence et sont des marques de fabrique ou des marques déposées de SPARC International, Inc. aux Etats-Unis et dans d'autres pays. Les produits portant les marques SPARC sont basés sur une architecture développée par Sun Microsystems, Inc. UNIX est une marque déposée aux Etats-Unis et dans d'autres pays et licenciée exclusivement par X/Open Company, Ltd. Ce produit est couvert à la législation américaine en matière de contrôle des exportations et peut être soumis à la règlementation en vigueur dans d'autres pays dans le domaine des exportations et importations. Les utilisations, ou utilisateurs finaux, pour des armes nucléaires, des missiles, des armes biologiques et chimiques ou du nucléaire maritime, directement ou indirectement, sont strictement interdites. Les exportations ou réexportations vers les pays sous embargo américain, ou vers des entités figurant sur les listes d'exclusion d'exportation américaines, y compris, mais de manière non exhaustive, la liste de personnes qui font objet d'un ordre de ne pas participer, d'une façon directe ou indirecte, aux exportations des produits ou des services qui sont régis par la législation américaine en matière de contrôle des exportations et la liste de ressortissants spécifiquement désignés, sont rigoureusement interdites.

Part Number: 820-0978

Version 20070424231148

VSAM eWay Adapter User’s Guide 2 Sun Microsystems, Inc.

Contents

Chapter 1

Introducing the VSAM eWay 7

About VSAM 7

About the VSAM eWay 8

eWay Operation 8

What’s New in This Release 8

About This Document 9

VSAM eWay Javadoc 9

Scope 10 Intended Audience 10 Text Conventions 10

Introducing the VSAM eWay

Welcome to the Sun SeeBeyond eWay™ Adapter for VSAM User’s Guide. This document includes information about installing, configuring, and using the Sun Java Composite Application Platform Suite VSAM eWay™ Adapter, referred to as the VSAM eWay throughout this guide.

This chapter provides a brief overview of operations, components, general features, and system requirements of the VSAM eWay.

What’s in This Chapter

 About VSAM on page 7

 About the VSAM eWay on page 8

 What’s New in This Release on page 8

 About This Document on page 9

 Related Documents on page 10

Chapter 1

 Sun Microsystems, Inc. Web Site on page 11

 Documentation Feedback on page 11

1.1 About VSAM

Virtual Storage Access Method (VSAM) is one of several access methods that defines the technique by which data is stored and retrieved. It is a GET/PUT interface used to transfer data from a direct-access storage device (DASD) to an application program. VSAM does not support data stored on tape.

VSAM stores data as a collection of data sets. IBM uses a collection of three data-set organizations—sequential, indexed, and direct-access, together with the access methods and utilities used on mainframe operating systems.

VSAM data sets must be cataloged in an integrated catalog facility (ICF) structure. Records are arranged by an index key or by relative-byte addressing. VSAM uses direct or sequential processing of fixed and variable-length records stored on a DASD.

VSAM also provides the following features:

 Allows you to organize and access data (record management).

VSAM eWay Adapter User’s Guide 7 Sun Microsystems, Inc.

Chapter 1 Section 1.2

Introducing the VSAM eWay About the VSAM eWay

 Maintains information about this data, which is stored or referenced in a catalog

(catalog management).

 Supports Entry-sequenced Data Set (ESDS) and Key-sequenced Data Set (KSDS)

files.

The VSAM eWay allows you to utilize and extend all of these features. For more information on VSAM, see IBM’s Web site.

1.2 About the VSAM eWay

The VSAM eWay enables eGate™ Integrator to exchange data with external IBM VSAM mainframe file systems. This eWay is similar to other database eWays, such as IAM, ADABAS, and IDMS. The eWay uses its own properties settings and eGate components to enable VSAM data integration.

1.2.1 eWay Operation

This eWay enables eGate to communicate with VSAM files on a mainframe host system via TCP/IP. The eWay utilizes an IBM WebSphere Information Integrator Classic Federatione component that allows you to view and access VSAM in the same way as any standard relational database system.

For details on operating and using eGate and its user interface, the Enterprise Designer, see the Sun SeeBeyond eGate™ Integrator User’s Guide.

1.3 What’s New in This Release

The Sun SeeBeyond eWay Adapter for VSAM includes the following changes and new features:

New for Version 5.1.3

 This is a maintenance release. No new features.

New for Version 5.1.2

 This is a maintenance release. No new features.

New for Version 5.1.1

 This is a maintenance release. No new features.

New for Version 5.1.0

 Version Control: An enhanced version control system allows you to effectively

manage changes to the eWay components.

 Multiple Drag-and-Drop Component Mapping from the Deployment Editor: The

Deployment Editor now allows you to select multiple components from the Editor’s component pane, and drop them into your Environment component.

VSAM eWay Adapter User’s Guide 8 Sun Microsystems, Inc.

Chapter 1 Section 1.4

Introducing the VSAM eWay About This Document

 Support for Runtime LDAP Configuration: eWay configuration properties now

support LDAP key values.

 Connection Retry Support: Allows you to specify the number of attempts to

reconnect, and the interval between retry attempts, in the event of a connection failure.

 Relaunchable OTD Support: An OTD can be rebuilt and saved (under the same

name) then relaunched back to the same Java Collaboration or BPEL. This allows you to change the metadata in an OTD without having to completely recreate the business logic from scratch.

 Editable OTD Support: An existing OTD can be edited and saved using the OTD

Wizard. This allows you to make minor changes to an OTD without having to completely recreate the OTD from scratch. The OTD is then rebuilt, saved, and then relaunched back to the same Java Collaboration or BPEL.

 Connectivity Map Generator: Generates and links your Project’s Connectivity Map

components using a Collaboration or Business Process.

Many of these features are documented further in the Sun SeeBeyond eGate™ Integrator User’s Guide or the Sun SeeBeyond eGate™ Integrator System Administration Guide.

1.4 About This Document

This document includes the following chapters:

 Chapter 1 “Introducing the VSAM eWay”: Provides an overview description of

the product as well as high-level information about this document.

 Chapter 2 “Installing the VSAM eWay”: Describes the system requirements and

provides instructions for installing the VSAM eWay.

 Chapter 3 “Setting Properties of the VSAM eWay”: Provides instructions for

configuring the eWay to communicate with your legacy systems.

 Chapter 4 “Using the VSAM eWay Database Wizard”: Provides information for

creating Object Type Definitions to be used with the VSAM eWay.

 Chapter 5 “Using VSAM OTDs”: Describes operations you can perform using

VSAM Object Type Definitions (OTDs) in eGate.

 Chapter 6 “Using VSAM Operations”: Provides instructions on using VSAM

database eWay operations in BPEL and JCD.

 Chapter 7 “Implementing the VSAM eWay Sample Projects”: Provides

instructions for installing and running the sample Projects.

VSAM eWay Javadoc

A VSAM eWay Javadoc is also provided that documents the Java methods available with the VSAM eWay. The Javadoc is uploaded with the eWay’s documentation file (VSAMeWayDocs.sar) and downloaded from the Documentation tab of the Sun Java

VSAM eWay Adapter User’s Guide 9 Sun Microsystems, Inc.

Chapter 1 Section 1.5

Introducing the VSAM eWay Related Documents

Composite Application Platform Suite Installer. To access the full Javadoc, extract the Javadoc to an easily accessible folder, and double-click the index.html file.

1.4.1 Scope

This user’s guide provides a description of the VSAM eWay Adapter. It includes directions for installing the eWay, configuring the eWay properties, and implementing the eWay’s sample Projects. This document is also intended as a reference guide, listing available properties, functions, and considerations. For a reference of available VSAM eWay Java methods, see the associated Javadoc.

1.4.2 Intended Audience

This guide is intended for experienced computer users who have the responsibility of helping to set up and maintain a fully functioning Java Composite Application Platform Suite system. This person must also understand any operating systems on which the Java Composite Application Platform Suite will be installed (Windows and UNIX), and must be thoroughly familiar with Windows-style GUI operations.

1.4.3 Text Conventions

The following conventions are observed throughout this document.

Table 1 Text Conventions

Text Convention Used For Examples

Bold Names of buttons, files, icons,

parameters, variables, methods, menus, and objects

Monospaced Command line arguments, code

samples; variables are shown in

bold italic

Blue bold

Blue underlined

1.5 Related Documents

Hypertext links within document

Hypertext links for Web addresses (URLs) or email addresses

 Click OK.  On the File menu, click Exit.  Select the eGate.sar file.

java -jar filename.jar

See

Text Conventions on page 10

http://www.sun.com

The following Sun documents provide additional information about the Sun Java Composite Application Platform Suite product:

 Sun SeeBeyond eGate™ Integrator User’s Guide

 Sun Java Composite Application Platform Suite Installation Guide

VSAM eWay Adapter User’s Guide 10 Sun Microsystems, Inc.

Chapter 1 Section 1.6

Introducing the VSAM eWay Sun Microsystems, Inc. Web Site

1.6 Sun Microsystems, Inc. Web Site

The Sun Microsystems web site is your best source for up-to-the-minute product news and technical support information. The site’s URL is:

http://www.sun.com

1.7 Documentation Feedback

We appreciate your feedback. Please send any comments or suggestions regarding this document to:

CAPS_docsfeedback@sun.com

VSAM eWay Adapter User’s Guide 11 Sun Microsystems, Inc.

Installing the VSAM eWay

This chapter explains how to install the VSAM eWay.

What’s in This Chapter

 Installing the VSAM eWay on page 12

 ICAN 5.0 Project Migration Procedures on page 15

 Installing Enterprise Manager eWay Plug-Ins on page 16

2.1 Installing the VSAM eWay

The Java Composite Application Platform Suite Installer, referred to throughout this guide as the Suite Installer, is a web-based application that is used to select and upload core products, composite applications, and add-on files (eWays) during the installation process. The following section describes how to install the components required for this eWay.

Chapter 2

Refer to the readme for the latest information on:

 Supported Operating Systems

 System Requirements

 External System Requirements

The VSAM eWay Readme is uploaded with the eWay’s documentation file (VSAMeWayDocs.sar) and can be accessed from the Documentation tab of the Sun Java Composite Application Platform Suite Installer. Refer to the VSAM eWay Readme for the latest requirements before installing the VSAM eWay.

Note: When the Repository is running on a UNIX operating system, the eWays are loaded

from the Sun Java Composite Application Platform Suite Installer running on a Windows platform connected to the Repository server using Internet Explorer.

VSAM eWay Adapter User’s Guide 12 Sun Microsystems, Inc.

Chapter 2 Section 2.1

Installing the VSAM eWay Installing the VSAM eWay

2.1.1 Installing the VSAM eWay on an eGate supported system

Follow the directions for installing the Sun Java Composite Application Platform Suite in the Sun Java Composite Application Platform Suite Installation Guide. After you have installed Core Products, do the following:

1 From the Sun Java Composite Application Platform Suite Installer’s Select Sun

Java Composite Application Suite Products to Install table (Administration tab), click the Click to install additional products link.

2 Expand the eWay option.

3 Select the products for your Sun Java Composite Application Platform Suite and

include the following:

 File eWay (the File eWay is used by most sample Projects)

 VSAMeWay

To upload the VSAM eWay User’s Guide, Help file, Javadoc, Readme, and sample Projects, expand the Documentation option and select VSAMeWayDocs.

4 Once you have selected all of your products, click Next in the top-right or bottom-

right corner of the Select Sun Java Composite Application Platform Suite Products to Install box.

5 From the Selecting Files to Install box, locate and select your first product’s SAR

file. ONce you have selected the SAR file, click Next. Your next selected product appears. Follow this procedure for each of your selected products. The Installation Status window appears and installation begins after the last SAR file has been selected.

6 Once your product’s installation is finished, continue installing the Sun Java

Composite Application Platform Suite as instructed in the Sun Java Composite Application Platform Suite Installation Guide.

Adding the eWay to an Existing Sun Java Composite Application Platform Suite Installation

If you are adding the eWay to an existing Sun Java Composite Application Platform Suite installation, do the following:

1 Complete steps 1 through 4 above.

2 Once your product’s installation is complete, open the Enterprise Designer and

select Update Center from the Tools menu. The Update Center Wizard appears.

3 For Step 1 of the wizard, simply click Next.

4 For Step 2 of the wizard, click the Add All button to move all installable files to the

Include in Install field, then click Next.

5 For Step 3 of the wizard, wait for the modules to download, then click Next.

6 The wizard’s Step 4 window displays the installed modules. Review the installed

modules and click Finish.

VSAM eWay Adapter User’s Guide 13 Sun Microsystems, Inc.

Chapter 2 Section 2.1

Installing the VSAM eWay Installing the VSAM eWay

7 When prompted, restart the IDE (Integrated Development Environment) to

complete the installation.

Copying JAR files to the eDesigner Library

The VSAM eWay SAR file no longer includes the WebSphere Information Integrator Classic Federation JDBC Driver for VSAM databases. You are required to copy the product’s JDBC JAR file (cacjdbc30.jar) to the following location prior to running a VSAM project:

<JavaCAPS51>\edesigner\lib\ext

where <JavaCAPS51> is the directory where the Sun Java Composite Application Platform Suite is installed.

Note: If eDesigner is running, it must be restarted to pickup the new JAR file.

Installing Third-Party Products

In order to run the VSAM eWay you must also install the IBM WebSphere Information Integrator Classic Federation. The product is no longer shipped with the VSAM eWay. For complete details on how to install the Classic Federation, see the IBM WebSphere

Information Integrator Installation Guide for Classic Federation and Classic Event.

Important: When you install the Classic Federation, be sure to configure the properties for

VSAM. See the appropriate Federation documentation for details.

After Installation

Once you install the eWay, it must then be incorporated into a Project before it can perform its intended functions. See the eGate Integrator User’s Guide for more information on incorporating the eWay into an eGate Project.

2.1.2 Extracting the Sample Projects and Javadocs

The VSAM eWay includes sample Projects and Javadocs. The sample Projects are designed to provide you with a basic understanding of how certain database operations are performed using the eWay, while Javadocs provide a list of classes and methods exposed in the eWay.

Steps to extract the Javadoc include:

1 Click the Documentation tab of the Sun Java Composite Application Platform Suite

Installer, then click the Add-ons tab.

2 Click the VSAM eWay Adapter link. Documentation for the VSAM eWay appears

in the right pane.

3 Click the icon next to Javadoc and extract the ZIP file.

4 Open the index.html file to view the Javadoc.

VSAM eWay Adapter User’s Guide 14 Sun Microsystems, Inc.

Chapter 2 Section 2.2

Installing the VSAM eWay ICAN 5.0 Project Migration Procedures

Steps to extract the Sample Projects include:

1 Click the Documentation tab of the Sun Java Composite Application Platform Suite

Installer, then click the Add-ons tab.

2 Click the VSAM eWay Adapter link. Documentation for the VSAM eWay appears

in the right pane.

3 Click the icon next to Sample Projects and extract the ZIP file. Note that the

VSAM_eWay_Sample.zip file contains two additional ZIP files for each sample

Project.

Refer to “Importing a Sample Project” on page 65 for instructions on importing the sample Project into your repository via the Enterprise Designer.

2.2 ICAN 5.0 Project Migration Procedures

This section describes how to transfer your current ICAN 5.0.x Projects to the Sun Java Composite Application Platform Suite 5.1.3. To migrate your ICAN 5.0.x Projects to the Sun Java Composite Application Platform Suite 5.1.3, do the following:

Export the Project

1 Before you export your Projects, save your current ICAN 5.0.x Projects to your

Repository.

2 From the Project Explorer, right-click your Project and select Export from the

shortcut menu. The Export Manager appears.

3 Select the Project that you want to export in the left pane of the Export Manager and

move it to the Selected Projects field by clicking the Add to Select Items (arrow) button, or click All to include all of your Projects.

4 In the same manner, select the Environment that you want to export in the left pane

of the Export Manager and move it to the Selected Environments field by clicking the Add to Select Items (arrow) button, or click All to include all of your Environments.

5 Browse to select a destination for your Project ZIP file and enter a name for your

Project in the ZIP file field.

6 Click Export to create the Project ZIP file in the selected destination.

Install Java CAPS 5.1.3

1 Install Java CAPS 5.1.3, including all eWays, libraries, and other components used

by your ICAN 5.0 Projects.

2 Start the Java CAPS 5.1.3 Enterprise Designer.

Import the Project

1 From the Java CAPS 5.1.3 Enterprise Designer’s Project Explorer tree, right-click the

Repository and select Import Project from the shortcut menu. The Import Manager appears.

VSAM eWay Adapter User’s Guide 15 Sun Microsystems, Inc.

Chapter 2 Section 2.3

Installing the VSAM eWay Installing Enterprise Manager eWay Plug-Ins

2 Browse to and select your exported Project file.

3 Click Import. A warning message, “Missing APIs from Target Repository,” may

appear at this time. This occurs because various product APIs were installed on the ICAN 5.0 Repository when the Project was created, that are not installed on the Java CAPS 5.1.3 Repository. These APIs may or may not apply to your Projects. You can ignore this message if you have already installed all of the components that correspond to your Projects. Click Continue to resume the Project import.

4 Close the Import Manager after the Project is successfully imported.

Deploy the Project

1 A new Deployment Profile must be created for each of your imported Projects.

When a Project is exported, the Project’s components are automatically “checked in” to Version Control to write-protected each component. These protected components appear in the Explorer tree with a red padlock in the bottom-left corner of each icon. Before you can deploy the imported Project, the Project’s components must first be “checked out” of Version Control from both the Project Explorer and the Environment Explorer. To “check out” all of the Project’s components, do the following:

A From the Project Explorer, right-click the Project and select Version Control >

Check Out from the shortcut menu. The Version Control - Check Out dialog box

appears.

B Select Recurse Project to specify all components, and click OK.

C Select the Environment Explorer tab, and from the Environment Explorer, right-

click the Project’s Environment and select Version Control > Check Out from the shortcut menu.

D Select Recurse Environment to specify all components, and click OK.

2 If your imported Project includes File eWays, these must be reconfigured in your

Environment prior to deploying the Project.

To reconfigure your File eWays, do the following:

A From the Environment Explorer tree, right-click the File External System, and

select Properties from the shortcut menu. The Properties Editor appears.

B Set the inbound and outbound directory values, and click OK. The File External

System can now accommodate both inbound and outbound eWays.

3 Deploy your Projects.

Note: Only projects developed on ICAN 5.0.2 and later can be imported and migrated

successfully into the Sun Java Composite Application Platform Suite.

2.3 Installing Enterprise Manager eWay Plug-Ins

The Sun SeeBeyond Enterprise Manager is a Web-based interface you use to monitor and manage your Sun Java Composite Application Platform Suite applications. The

VSAM eWay Adapter User’s Guide 16 Sun Microsystems, Inc.

Chapter 2 Section 2.3

Installing the VSAM eWay Installing Enterprise Manager eWay Plug-Ins

Enterprise Manager requires an eWay specific “plug-in” for each eWay you install. These plug-ins enable the Enterprise Manager to target specific alert codes for each eWay type, as well as start and stop the inbound eWays.

The Sun Java Composite Application Platform Suite Installation Guide describes how to install Enterprise Manager. The Sun SeeBeyond eGate Integrator System Administration Guide describes how to monitor servers, Services, logs, and alerts using the Enterprise Manager and the command-line client.

The eWay Enterprise Manager Plug-ins are available from the List of Components to

Download under the Sun Java Composite Application Platform Suite Installer’s Downloads tab.

There are two ways to add eWay Enterprise Manager plug-ins:

 From the Sun SeeBeyond Enterprise Manager

 From the Sun Java Composite Application Platform Suite Installer

To add plug-ins from the Enterprise Manager

1 From the Enterprise Manager’s Explorer toolbar, click configuration.

2 Click the Web Applications Manager tab, go to the Auto-Install from Repository

sub-tab, and connect to your Repository.

3 Select the application plug-ins you require, and click Install. The application plug-

ins are installed and deployed.

To add plug-ins from the Sun Java Composite Application Platform Suite Installer

1 From the Sun Java Composite Application Platform Suite Installer’s Downloads

tab, select the Plug-Ins you require and save them to a temporary directory.

2 From the Enterprise Manager’s Explorer toolbar, click configuration.

3 Click the Web Applications Manager tab and go to the Manage Applications sub-

tab.

4 Browse for and select the WAR file for the application plug-in that you

downloaded, and click Deploy. The plug-ins is installed and deployed.

2.3.1 Viewing Alert Codes

You can view and delete alerts using the Enterprise Manager. An alert is triggered when a specified condition occurs in a Project component. The purpose of the alert is to warn the administrator or user that a condition has occurred.

To View the eWay Alert Codes

1 Add the eWay Enterprise Manager plug-in for this eWay.

2 From the Enterprise Manager’s Explorer toolbar, click configuration.

3 Click the Web Applications Manager tab and go to the Manage Alert Codes sub-

tab. Your installed eWay alert codes display under the Results section. If your eWay alert codes are not displayed under Results, do the following:

VSAM eWay Adapter User’s Guide 17 Sun Microsystems, Inc.

Chapter 2 Section 2.3

Installing the VSAM eWay Installing Enterprise Manager eWay Plug-Ins

A From the Install New Alert Codes section, browse to and select the eWay alert

properties file for the application plug-in that you added. The alert properties files are located in the alertcodes folder of your Sun Java Composite Application Platform Suite installation directory.

B Click Deploy. The available alert codes for your application are displayed under

Results. A listing of the eWay’s available alert codes is displayed in Table 2.

Table 2 Alert Codes for the VSAM eWay

Alert Code\Description Description Details User Actions

DBCOMMON-CONNECTFAILED000001=Failed to connect to database {0} on host {1}. Reason: The Pooled connection could not be allocated: [{2}]

DBCOMMON-CONNECTFAILED000002=Operation failed because of a database connection error. Reason: [{0}]

DBCOMMON-CONNECTFAILED000005=Connection handle not usable. Reason:[{0}]

DBCOMMON-XARESOURCEFAILED000001=Unable to get XAResource for the database. Reason: [{0}]

Occurs during the initial database connection establishment.

Occurs while retrieving a connection from the database or the connection pool.

The connection in the pool is stale and is not usable.

Could not obtain XAResource for the connection.

 Database is down; start your

database.

 External configuration

information is invalid. You may need to verify the following:

 Server name  Database name  User  Password  Port

 Verify that the database has not

terminated with unexpected errors.

 Probably a database restart

occurred causing the connection to be stale, retry the operation after the database is up.

 Check if the database supports XA

and has been configured for Distributed Transaction Support.

DBCOMMON-XACONNECTFAILED000001=Failed to connect to database {0} on host {1}. The XA connection could not be allocated: Reason [{2}]

DBCOMMON-XASTARTFAILED000001=Unable to perform XAStart for the connection. Reason: [{0}]

VSAM eWay Adapter User’s Guide 18 Sun Microsystems, Inc.

Occurs during the initial database connection establishment.

A connection error has occurred which caused XASTART to fail.

 Check if the database is

configured for XA and if the database is running.

 External configuration

information is invalid. You may need to verify the following:

 Server name  Database name  User  Password  Port

 Check if the database is running,

and there are no network issues.

Chapter 2 Section 2.3

Installing the VSAM eWay Installing Enterprise Manager eWay Plug-Ins

Alert Code\Description Description Details User Actions

DBCOMMON-XAENDFAILED000001=XAEnd failed. Reason: [{0}]

DBCOMMON-CANNOT-GETISOLATION-LEVEL=Unable to get isolationLevel for the transaction. Reason: [{0}]

For information on Managing and Monitoring alert codes and logs, as well as how to view the alert generated by the project component during runtime, see the Sun SeeBeyond eGate™ Integrator System Administration Guide.

Error occurred during commit on XA connection.

Could not read transaction isolation information of the connection.

 Look for the detailed error

mentioned in the alert for the appropriate action.

 Transaction isolation is one of the

following constants:

 Connection.TRANSACTION_RE

AD_UNCOMMITTED

 Connection.TRANSACTION_RE

AD_COMMITTED

 Connection.TRANSACTION_RE

PEATABLE_READ

 Connection.TRANSACTION_SE

RIALIZABLE

 Connection.TRANSACTION_N

ONE

Note: Confirm with the

vendor that the getIsolation() method of the connection is implemented correctly.

Note: An alert code is a warning that an error has occurred. It is not a diagnostic. The user

actions noted above are just some possible corrective measures you may take. Refer to the log files for more information. For information on Managing and Monitoring alert codes and logs, see the Sun SeeBeyond eGate Integrator System Administration Guide.

VSAM eWay Adapter User’s Guide 19 Sun Microsystems, Inc.

Setting Properties of the VSAM eWay

This chapter explains how to set the properties of the VSAM eWay.

What’s in This Chapter

 Creating and Configuring a VSAM eWay on page 20

 Configuring the eWay Connectivity Map Properties on page 20

 Configuring the eWay Environment Properties on page 23

 eWay Connectivity Map Properties on page 24

 eWay Environment Properties on page 26

3.1 Creating and Configuring a VSAM eWay

All eWays contain a unique set of default configuration parameters. After the eWays are established and a VSAM External System is created in the Project’s Environment, the eWay parameters are modified for your specific system. The VSAM eWay configuration parameters are modified from two locations:

Chapter 3

 Connectivity Map: These parameters most commonly apply to a specific

component eWay, and may vary from other eWays (of the same type) in the Project.

 Environment Explorer : These parameters are commonly global, applying to all

eWays (of the same type) in the Project. The saved properties are shared by all eWays in the VSAM External System window.

 Collaboration or Business Process: VSAM eWay properties may also be set from

your Collaboration or Business Process, in which case the settings will override the corresponding properties in the eWay’s Connectivity Map configuration. Any properties that are not overridden retain their configured default settings.

3.2 Configuring the eWay Connectivity Map Properties

When you connect an External Application to a Collaboration, Enterprise Designer automatically assigns the appropriate eWay to the link. Each eWay is supplied with a list of eWay connections (transaction support levels) from which to choose.

Transaction support levels provided by the VSAM eWay include:

VSAM eWay Adapter User’s Guide 20 Sun Microsystems, Inc.

Chapter 3 Section 3.2

Setting Properties of the VSAM eWay Configuring the eWay Connectivity Map Properties

 VSAM CP eWay

 Outbound VSAM non-Transactional eWay

To configure the eWay properties:

1 On the Enterprise Designer’s Connectivity Map, double-click the VSAM eWay icon.

The eWay Connections window appears.

Figure 1 Connectivity Map with Components

VSAM eWay

2 Select a parameter from the list and click OK.

Figure 2 Template window

The choices to make are as follows:

 VSAM CP eWay: Also referred to as LocalTransaction, this support level is

opposite to NoTransaction, and this means that the transaction, when The Properties window opens, displaying the default properties for the eWay.

 Outbound VSAM non-Transactional eWay: Also referred to as NoTransaction,

this support level indicates that the Collaboration does not support transactions. This means that when a transaction aborts, there is no ability to roll back any changes to the previous update.

3 The Properties window opens, displaying the default properties for the eWay.

VSAM eWay Adapter User’s Guide 21 Sun Microsystems, Inc.

Chapter 3 Section 3.2

Setting Properties of the VSAM eWay Configuring the eWay Connectivity Map Properties

Figure 3 Outbound eWay Properties

3.2.1 Transaction Support Levels Between Different Versions

The types of transaction support levels used in Java CAPS 5.1.0 may be different from the support levels used in Java CAPS 5.1.3. Projects that are imported from a Java CAPS 5.1.0 version can potentially display different results, depending on whether the 5.1.0 Java Collaboration Definition (JCD) included multiple (insert/ update/delete) operations. This only affects non-XA transactions. Example:

In 5.1.0, five new records are to be inserted into a table. If the last record fails to insert (such as when a duplicate key exists), all previous records will have been inserted. This is the behavior of NoTransaction support.

In 5.1.3, five new records are to be inserted into a table. If one of the records fails to insert (such as when a duplicate key exists), the other four records will not be inserted. This is the behavior of the LocalTransaction.

In order to achieve the same result as in 5.1.0 versions, you can choose the method below:

A In the Connectivity Map, delete the link to the database external application,

then reconnect the link and select NoTransaction.

B Fill in the NoTransaction property for the database external system under the

Environment.

C Rebuild the Project.

If you want 5.1.3 behavior for a LocalTransaction, then set your eWay connection to be Outbound VSAM non-Transactional eWay (NoTransaction).

VSAM eWay Adapter User’s Guide 22 Sun Microsystems, Inc.

Chapter 3 Section 3.3

Setting Properties of the VSAM eWay Configuring the eWay Environment Properties

3.3 Configuring the eWay Environment Properties

The eWay Environment Configuration properties contain parameters that define how the eWay connects to and interacts with other eGate components within the Environment. When you create a new VSAM External System, you may configure the type of External System required.

Available External System properties include:

 Inbound VSAM eWay

 (Outbound) VSAM CP eWay

 Outbound VSAM non-Transactional eWay

To Configure the Environment Properties:

1 In Enterprise Explorer, click the Environment Explorer tab.

2 Expand the Environment created for the VSAM Project and locate the VSAM

External System.

Note: For more information on creating an Environment, see the “Sun SeeBeyond eGate

Integrator Tutorial”.

3 Right-click the External System created for the VSAM Project and select Properties

from the list box. The Environment Configuration Properties window appears.

VSAM eWay Adapter User’s Guide 23 Sun Microsystems, Inc.

Chapter 3 Section 3.4

Setting Properties of the VSAM eWay eWay Connectivity Map Properties

Figure 4 VSAM eWay Environment Configuration

4 Click on any folder to display the default configuration properties for that section.

5 Click on any property field to make it editable.

After modifying the configuration properties, click OK to save the changes.

3.4 eWay Connectivity Map Properties

The eWay Connectivity Map consists of the following properties categories.

 Outbound eWay

 Connectivity Map (Outbound) CP eWay Properties on page 25

 Outbound non-Transactional eWay

 Connectivity Map Outbound non-Transactional eWay Properties on page 25

VSAM eWay Adapter User’s Guide 24 Sun Microsystems, Inc.

Chapter 3 Section 3.4

Setting Properties of the VSAM eWay eWay Connectivity Map Properties

3.4.1 Connectivity Map (Outbound) CP eWay Properties

The Outbound eWay Properties include outbound parameters used by the external database.

Table 3 Outbound eWay—JDBC Connector Settings

Name Description Required Value

Description VSAM Connection Pool Datasource. A valid string.

ClassName Displays the Java class in the JDBC driver

that is used to implement the ConnectionPoolDataSource interface.

3.4.2 Connectivity Map Outbound non-Transactional eWay

A valid class name.

The default is:

com.cac.jdbc.ConnectionPoo lDataSource

Note: Do not change

this value.

Properties

You can create VSAM databases with or without logging enabled. If logging is disabled, then Non-Transactional mode must be used. Because data logs are not retained during Non-Transactional execution of SQL calls, data recovery is not possible during accidental or unscheduled shut-down of the database server.

Disabled logging also prevents transactions—enclosed in BEGIN-Tran and END-Tran statements—from occurring. This means that Non-Transactional mode cannot be used in XA (two-phase commit) transactions.

The Outbound non-Transactional eWay Properties listed in Table 4 include inbound parameters used by the external database.

Table 4 Outbound VSAM non-Transactional eWay Connectivity Map Properties

Name Description Required Value

Description Enter a description for the database. A valid string. The default is

VSAM non-Transactional Connection Pool Datasource.

ClassName Specifies the Java class in the JDBC driver

that is used to implement the nonTransactional ConnectionPoolDataSource interface.

A valid class name. The default is com.cac.jdbc.ConnectionPool DataSource

VSAM eWay Adapter User’s Guide 25 Sun Microsystems, Inc.

Chapter 3 Section 3.5

Setting Properties of the VSAM eWay eWay Environment Properties

3.5 eWay Environment Properties

eWay External System properties must be configured from within the Environment. Until you have successfully configured all eWays for your Java CAPS project, your project cannot be properly executed or deployed. The following list identifies the VSAM eWay properties. There are two Environment Configuration categories that the VSAM eWay implements.

Property Categories Configured in the Logical Host Environment

 Inbound VSAM eWay Properties on page 26

 (Outbound) VSAM CP eWay Properties on page 26

 Outbound VSAM non-Transactional eWay Properties on page 30

3.5.1 Inbound VSAM eWay Properties

Before deploying your eWay, you will need to set the Environment properties. The Inbound VSAM eWay includes the following configuration section:

 Parameter Settings

Details for the Inbound VSAM eWay Parameter Settings are listed in Table 5.

Table 5 Inbound VSAM eWay—Parameter Settings

Name Description Required Value

Description The description of the database. A valid string.

ServerName This setting specifies the host name of the

external database server.

PortNumber Specifies the I/O port number on which

the server is listening for connection requests.

DatabaseName Specifies the name of the database

instance. This parameter is configured in conjuction with the Data Catalogue name you created in WebSphere Classic Federation’s Data Mapper.

User Specifies the user name the eWay uses to

connect to the database.

Password Specifies the password used to access the

database.

Any valid string.

A valid port number.

Any valid string.

3.5.2 (Outbound) VSAM CP eWay Properties

The (Outbound) VSAM CP eWay includes the following configuration sections:

 JDBC Connector Settings

 Connection Retry Settings

VSAM eWay Adapter User’s Guide 26 Sun Microsystems, Inc.

Chapter 3 Section 3.5

Setting Properties of the VSAM eWay eWay Environment Properties

JDBC Connector Settings

Details for the VSAM CP eWay JDBC Connector Settings used by the external database are detailed in Table 6.

Table 6 VSAM CP eWay—JDBC Connector Settings

Name Description Required Value

Description The description of the database. A valid string. The configured default

is VSAM Connection Pool Datasource.

ServerName This setting specifies the host name

of the external database server.

PortNumber Specifies the I/O port number on

which the server is listening for connection requests.

Any valid string.

A valid port number.

DatabaseName Specifies the name of the database

instance.

User Specifies the user name the eWay

uses to connect to the database.

Password Specifies the password used to

access the database.

Any valid string.

VSAM eWay Adapter User’s Guide 27 Sun Microsystems, Inc.

Chapter 3 Section 3.5

Setting Properties of the VSAM eWay eWay Environment Properties

Table 6 VSAM CP eWay—JDBC Connector Settings (Continued)

Name Description Required Value

DriverProperties The Connection Pool DataSource

implementation may need to execute additional methods to assure a successful run. The additional methods will need to be identified in the Driver Properties. You must ensure that the driver is installed on both the Logical Host machine and the Enterprise Designer machine.

The delimiter set by the user. For more information, see the Delimiter property below.

Valid delimiters are:

“<method-name-1>#<param-

1>#<param-2>#.........<param-

n>##<method-name-2>#<param-

1>#<param-2>#........<param-

n>##......##”.

For example: to execute the method setSpyAttributes, give the method a String for the URL “setSpyAttribute#<url>##”.

Note: The setSpyAttributes (for

Data Direct drivers) that are contained in the following examples (between the last set of double octothorps [##] within each example), are used for debugging purposes and need not be used on every occasion.

Delimiter This is the delimiter character to be

used in the DriverProperties prompt.

Optional—if you are using Spy Log:

“setURL#jdbc:Seebeyond:VSAM:// <server>:4100;DatabaseName=<datab ase>##setSpyAttributes#log=(file)c:/ temp/spy.log;logTName=yes##”

The default is #. See the DriverProperties property above for more information on how the default value is used.

VSAM eWay Adapter User’s Guide 28 Sun Microsystems, Inc.

Chapter 3 Section 3.5

Setting Properties of the VSAM eWay eWay Environment Properties

Table 6 VSAM CP eWay—JDBC Connector Settings (Continued)

Name Description Required Value

MinPoolSize Specifies the minimum number of

physical connections the pool should keep available at all times. 0 (zero) indicates that there should be no physical connections in the pool and the new connections should be created as needed.

If the pool size is too small, you may experience a longer connection time due to the existing number of physical connections.

A connection that stays in the pool allows transactions to use it via a logical connection (which is faster).

MaxPoolSize Specifies the maximum number of

physical connections the pool should keep available at all times. 0 (zero) indicates that there is no maximum.

If the pool size is too big, you may end up with too many connections with the database. The pool size depends on the transaction volume and response time.

A valid numeric value. The default is 0.

A valid numeric value. The default is

10.

MaxIdleTime Specifies the maximum number of

seconds that a physical connection may remain unused before it is closed. 0 (zero) indicates that there is no limit.

A valid numeric value. The default is 0.

Connection Retry Settings

Details for the VSAM CP eWay Connection Retry Settings used by the external database are detailed in Table 7.

Table 7 VSAM CP eWay—Connection Retry Settings

Name Description Required Value

ConnectionRetries Specifies the number of retries to

establish a connection upon failure to acquire one.

A valid numeric value. The default is 0.

VSAM eWay Adapter User’s Guide 29 Sun Microsystems, Inc.

Chapter 3 Section 3.5

Setting Properties of the VSAM eWay eWay Environment Properties

Table 7 VSAM CP eWay—Connection Retry Settings (Continued)

Name Description Required Value

ConnectionRetryInterval Specifies the milliseconds of pause

before each attempt to reaccess the database. This setting is used in conjunction with the 'Connection Retries' setting.

For example: In the event that the eWay cannot connect to the Database, the eWay will try to reconnect to the database 10 times in 5 seconds apart when the Connection Retries is 10 and the Connection Retry Interval is 5000.

3.5.3 Outbound VSAM non-Transactional eWay Properties

A valid numeric value. The default is 1000.

The (Outbound) VSAM non-Transactional eWay includes the following configuration sections:

 JDBC Connector Settings

 Connection Retry Settings

JDBC Connector Settings

Details for the VSAM non-Transactional eWay JDBC Connector Settings used by the external database are detailed in Table 8.

Table 8 VSAM non-Transactional eWay—JDBC Connector Settings

Name Description Required Value

Description The description of the database. A valid string. The configured default

is VSAM non-Transactional Connection Pool Datasource.

ServerName This setting specifies the host name

of the external database server.

PortNumber Specifies the I/O port number on

which the server is listening for connection requests.

DatabaseName Specifies the name of the database

instance.

User Specifies the user name the eWay

uses to connect to the database.

Password Specifies the password used to

access the database.

Any valid string.

A valid port number.

Any valid string.

VSAM eWay Adapter User’s Guide 30 Sun Microsystems, Inc.

+ 85 hidden pages

Sun Microsystems eWAY Adapter for VSAM 5.1.3 User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Contents

Introducing the VSAM eWay

1.1 About VSAM

1.2 About the VSAM eWay

1.2.1 eWay Operation

1.3 What’s New in This Release

1.4 About This Document

VSAM eWay Javadoc

1.4.1 Scope

1.4.2 Intended Audience

1.4.3 Text Conventions

1.5 Related Documents

1.6 Sun Microsystems, Inc. Web Site

1.7 Documentation Feedback

Installing the VSAM eWay

2.1 Installing the VSAM eWay

2.1.1 Installing the VSAM eWay on an eGate supported system

Adding the eWay to an Existing Sun Java Composite Application Platform Suite Installation

Copying JAR files to the eDesigner Library

Installing Third-Party Products

After Installation

2.1.2 Extracting the Sample Projects and Javadocs

2.2 ICAN 5.0 Project Migration Procedures

2.3 Installing Enterprise Manager eWay Plug-Ins

2.3.1 Viewing Alert Codes

Setting Properties of the VSAM eWay

3.1 Creating and Configuring a VSAM eWay

3.2 Configuring the eWay Connectivity Map Properties

3.2.1 Transaction Support Levels Between Different Versions

3.3 Configuring the eWay Environment Properties

3.4 eWay Connectivity Map Properties

3.4.1 Connectivity Map (Outbound) CP eWay Properties

3.5 eWay Environment Properties

3.5.1 Inbound VSAM eWay Properties

3.5.2 (Outbound) VSAM CP eWay Properties

JDBC Connector Settings

Connection Retry Settings

3.5.3 Outbound VSAM non-Transactional eWay Properties

JDBC Connector Settings