table runtime environment user guide - oracletable runtime environment user guide 6 seebeyond...

Table Runtime Environment User Guide

Release 5.0.1 Table Runtime Environment (TRE)

SeeBeyond Proprietary and Confidential

The information contained in this document is subject to change and is updated periodically to reflect changes to the applicable software. Although every effort has been made to ensure the accuracy of this document, SeeBeyond Technology Corporation (SeeBeyond) assumes no responsibility for any errors that may appear herein. The software described in this document is furnished under a License Agreement and may be used or copied only in accordance with the terms of such License Agreement. Printing, copying, or reproducing this document in any fashion is prohibited except in accordance with the License Agreement. The contents of this document are designated as being confidential and proprietary; are considered to be trade secrets of SeeBeyond; and may be used only in accordance with the License Agreement, as protected and enforceable by law. SeeBeyond assumes no responsibility for the use or reliability of its software on platforms that are not supported by SeeBeyond.

SeeBeyond, e*Gate, e*Way, and e*Xchange are the registered trademarks of SeeBeyond Technology Corporation in the United States and/or select foreign countries. The SeeBeyond logo, SeeBeyond Integrated Composite Application Network Suite, eGate, eWay, eInsight, eVision, eXchange, eView, eIndex, eTL, ePortal, eBAM, and e*Insight are trademarks of SeeBeyond Technology Corporation. The absence of a trademark from this list does not constitute a waiver of SeeBeyond Technology Corporation’s intellectual property rights concerning that trademark. This document may contain references to other company, brand, and product names. These company, brand, and product names are used herein for identification purposes only and may be the trademarks of their respective owners.

© 2004 by SeeBeyond Technology Corporation. All Rights Reserved. This work is protected as an unpublished work under the copyright laws.

This work is confidential and proprietary information of SeeBeyond and must be maintained in strict confidence.

Version 20040727154534.

Table Runtime Environment User Guide 2 SeeBeyond Proprietary and Confidential

Contents

Contents

Chapter 1

Introduction 5Organization of Information 5

Intended Audience 5

Writing Conventions 6

Online Documents 6

SeeBeyond Web Site 6

Related Documents 6

Chapter 2

Table Runtime Environment Overview 8Overview 8

Supported Operating Systems 9

Differences Between e*Gate 3.6.2 and the TRE 10

Differences Between TRE 5.0 and TRE 5.0.x 10

Known Issues with the TRE 10

Chapter 3

Installation 13Overview 13

Pre-Installation Steps 13

Installing the TRE on Windows 14

Installing the TRE on UNIX 16

Setting Up Environment Variables on Windows 17


Contents

Chapter 4

JMS Configuration 19Overview 19

Configuring JMS Out 19

Configuring JMS In 23

Glossary 26e*Gate 3.x Terms in eGate 5.0 29

Index 30


Chapter 1

Introduction

Welcome to the Table Runtime Environment User’s Guide. This document includes information about installing and using the eGate 5.0.x Table Runtime Environment with the SeeBeyond® Integrated Composite Application Network (ICAN) Suite™.

This chapter includes

“Organization of Information” on page 5

“Intended Audience” on page 5

“Writing Conventions” on page 6

“Online Documents” on page 6

“SeeBeyond Web Site” on page 6

“Related Documents” on page 6

1.1 Organization of InformationThis document provides information about installing and configuring the eGate 5.0.x Table Runtime Environment (TRE) with the ICAN Suite and includes the following chapters:

Chapter 1 “Introduction” describes the purpose of the Table Runtime Environment User’s Guide including writing conventions and a list of related documents.

Chapter 2 “Table Runtime Environment Overview”

Chapter 3 “Installation”

Chapter 4 “JMS Configuration”

The Glossary on page 26 contains a list of eGate-related terminology.

1.2 Intended AudienceThis guide is intended for experienced computer users who have the responsibility of helping to set up and maintain a fully functioning ICAN Suite system. This person must also understand any operating systems on which will be installed and must be thoroughly familiar with Windows-style GUI operations.


Chapter 1 Section 1.3Introduction Writing Conventions

1.3 Writing ConventionsThe following writing conventions are observed throughout this document.

1.4 Online DocumentsThe documentation for the SeeBeyond ICAN Suite is distributed as a collection of online documents. These documents are viewable with the Acrobat Reader application from Adobe Systems. Acrobat Reader can be downloaded from:

http://www.adobe.com

1.5 SeeBeyond Web SiteThe SeeBeyond Web site is your best source for up-to-the-minute product news and technical support information. The site’s URL is:

http://www.seebeyond.com

1.6 Related DocumentsThe following SeeBeyond documents provide additional information about the Table Runtime Environment system as explained in this guide:

eGate Integrator JMS Reference Guide (located on the ICAN Installation CD ROMs)

Table 1 Writing Conventions

Text Convention Example

Button, file, icon, parameter, variable, method, menu, and object names.

Bold text Click OK to save and close.From the File menu, select Exit.Select the logicalhost.exe file.Enter the timeout value.Use the getClassName() method.Configure the Inbound File eWay.

Command line arguments and code samples

Fixed font. Variables are shown in bold italic.

bootstrap -p password

Hypertext links Blue text http://www.seebeyond.com


http://www.adobe.com

http://www.SeeBeyond.com

Chapter 1 Section 1.6Introduction Related Documents

SeeBeyond ICAN Suite Installation Guide (located on the ICAN Installation CD ROMs)

SeeBeyond ICAN Suite Upgrade Guide (located on the ICAN Installation CD ROMs)

DataGate Installation Guide (packaged with the original DataGate installation media)


Chapter 2

Table Runtime Environment Overview

This chapter describes the eGate 5.0.x Table Runtime Environment, lists the system requirements, and describes the differences between e*Gate 3.6.2 and the eGate 5.0.x TRE.

Note: For information on upgrading e*Gate 4.x systems, see the eGate Integrator Upgrade Guide.


“Overview” on page 8

“Supported Operating Systems” on page 9

“Differences Between e*Gate 3.6.2 and the TRE” on page 10

“Known Issues with the TRE” on page 10

2.1 Overviewe*Gate 3.6.2 customers can upgrade to eGate 5.0.x by installing the Table Runtime Environment (TRE). The TRE upgrades e*Gate 3.6.2 systems to take advantage of eGate 5.0.x J2EE tools, such as the Enterprise Manager web-based GUI.

The TRE makes it possible for existing e*Gate 3.6.2 tables to exchange messages with the J2EE SeeBeyond JMS IQ Manager. This enables TRE routes to publish and subscribe to J2EE eGate 5.0.x components. Similarly, J2EE eGate 5.0.x components can publish and subscribe to tables running in the TRE. This inter-connectivity is achieved through either the “JMS In” and “JMS Out” TRE communication client executable files or the TRE Server interfacing with the SeeBeyond JMS IQ Manager.

Figure 1 shows how eGate components running in the Table Runtime Environment interact with the J2EE environment.

Tables in the TRE interact with each other and with external systems with the same functionality that existed prior to upgrading.

Components that publish or subscribe to J2EE components use either JMS In and JMS Out or the TRE Server to receive and send messages from and to the J2EE JMS IQ Manager. The route to the JMS IQ Manager is established by pointing JMS In and JMS Out to the J2EE JMS IQ Manager’s host name and port numbers or by configuring the TRE Server to do so directly.


Chapter 2 Section 2.2Table Runtime Environment Overview Supported Operating Systems

The Table Runtime Environment upgrade includes the e*Gate 3.6.2 GUIs and editors needed to maintain the 3.6.2 components.

Figure 1 The Table Runtime Environment

2.2 Supported Operating SystemsThe Table Runtime Environment upgrade for eGate 5.0.x is supported on the following operating systems:

Windows 2000 SP3 and Windows XP

Solaris 8 and 9

AIX 5.1 and 5.2

HP-UX 11 and 11i (RISC)

eGate 5.0

Table Runtime Environment

TRE Server(dgsrvr executable)

J2EE

Table EditorGUI

ExternalSystem(s)

Table Files

SeeBeyondJMS IQ Manager

SeeBeyondIntegration Server

eGate Enterprise ManagerWeb-based GUI(Project Monitor)

Monitors components in eGate5.0

ComClient(s)

JMS In JMS Out


Chapter 2 Section 2.3Table Runtime Environment Overview Differences Between e*Gate 3.6.2 and the TRE

HP Tru64 V5.1A

The TRE is not supported on the following operating systems:

Alpha NT

AViiON DG/UX

2.3 Differences Between e*Gate 3.6.2 and the TREThe Table Runtime Environment includes the following changes and additions:

dgsrvr executable: The TRE Server (dgsrvr on UNIX or dgsrvr.exe on Windows) has been updated to contain a roll-up of the ESRs for DataGate 3.6.2 as well as adding support for the newly added platforms.

JmsIn executable: This client executable (JMSIn on UNIX or JMSIn.exe on Windows) has been added to allow TRE tables to subscribe to messages in J2EE JMS IQ Managers.

JmsOut executable: This client executable (JMSOut on UNIX or JMSOut.exe on Windows) has been added to allow TRE tables to publish messages to J2EE JMS IQ Managers.

TRE eWay: The DataGateWay components have been renamed to TRE eWays.

2.4 Differences Between TRE 5.0 and TRE 5.0.xTRE 5.0.x includes the following changes and additions:

Automatic JMSIn/JMSOut port configuration: JMS functionality is also available in the TRE server by specifying "@jms" when defining JmsIn/JmsOut ports. This automatic JmsIn/JmsOut port configuration allows JMS to be used without having to use the JmsIn and JmsOut Comm clients.

To define JmsIn and JmsOut ports

1 Enter “@jms” in the Executable File field

2 Under Direction, select Destination (for JmsOut) or Source (for JmsIn).

2.5 Known Issues with the TREThe following items are known issues or limitations with the TRE.

dgLaunch.exe: The TRE Launcher (dglaunch.exe) cannot be shut down normally on Windows systems after using the TRE Editor; a warning erroneously shows that the Editor is still running. The only way to shut down the TRE Launcher is by


Chapter 2 Section 2.5Table Runtime Environment Overview Known Issues with the TRE

terminating the dglaunch.exe process via the Processes tab of the Windows Task Manager.

Viewing graphics in FrameViewer: The TRE graphical user interfaces (GUIs) use FrameViewer from Adobe to display the online help. Any graphics in the online help will not display correctly unless you set your display properties to display 256 colors.

libauth.so.1 on Solaris: On Solaris systems, the TRE eWays require the libauth.so.1 file (which is not included with Solaris 8 or 9). You can copy this file from a Solaris 2.6 system or search for it on Sun’s web site. You should copy this file to /usr/lib/libauth.so.1 on your Solaris 8 or 9 system.

OSFRCS520 for HP Tru64: To access rcsdiff, rcsclean, or rlog (located in the /bin directory on HP Tru64 systems), you must install OSFRCS520—GNU Revision Control System (Software Development).

GCC version 3.3: To recompile the TRE eWays using GCC (GNU Compiler Collection), you must use GCC version 3.3.

DART Oracle 9i on Solaris, HP-UX, and AIX: You must use the Oracle 32-bit library or it will fail to load. For example:

Use

/opt/oracle/app/oracle/product/9.2.0/lib32

NOT

/opt/oracle/app/oracle/product/9.2.0/lib

Using JMS Topics: When using the JmsOut executable or the TRE server in topic mode, a durable subscriber is automatically created so that messages will not be lost.

Interfacing with JMS servers: TRE JMS clients (TRE eWays) can connect to JMS servers (JMS IQ Managers) running within TRE or ICAN J2EE environments. TRE JMS clients can not interface with JMS servers running in a Schema Runtime Environment (SRE).

Port definition shortcut invoking a warning: When you use the port definition shortcut for TRE 5.0.x (see “Differences Between TRE 5.0 and TRE 5.0.x” on page 10), you encounter a “file not found” warning. Click OK and proceed without complication.

Data direction within the Port table: When you use the port definition shortcut for TRE 5.0.x (see “Differences Between TRE 5.0 and TRE 5.0.x” on page 10), you must specify JMS ports as unidirectional clients. Choose either Source or Destination under Direction in the Port Table Editor. Do not specify the JMS ports as Bidirectional.

Error when compiling custom communication clients on Solaris: Install libiconv-1.8.

Error when compiling custom MQSeries communication clients on Solaris: Verify that the latest Sun Solaris MQSeries Client has been installed.


http://www.sunfreeware.com/programlistsparc9.html#libiconv

http://www.sunfreeware.com/programlistsparc9.html#libiconv

http://www-306.ibm.com/software/integration/support/supportpacs/individual/maco.html

Chapter 2 Section 2.5Table Runtime Environment Overview Known Issues with the TRE

MQ-Begin function on an MQBO structure: Consult the MQSeries documentation for detailed information regarding transactions. For some GET functions, null characters will be appended to data if fixed expected lengths are too long. Strings longer than 100Kb can induce unpredictable behavior.

Viewing log files from the monitor: Ensure that the following directory exists for viewing log files:

$DATAGATE/dgtmp

Bringing the Database Builder to the foreground on Windows systems: If you are building a database, the Database Builder dialog box appears as a background process. To bring the Database Builder to the foreground, click the Build icon in the toolbar.

Running db-proc-execute with Oracle: When you bind a store procedure, you get a statement-handle back. When you run db-proc-execute, you must use the same connection-handle and the same statement-handle that you bound; otherwise, you could experience unpredictable behavior.

For example:

(db-login connection-handle “data_source” “login” “password”)(define stmt-handle (db-proc-bind connection-handle “procedure_name”))(if (statement-handle? stmt-handle) (begin

;; ok (db-proc-execute connection-handle stmt-handle);; bad code (db-proc-execute connection-handle2 stmt-handle)

) ) (db-logout connection-handle)


Chapter 3

Installation

This chapter describes the process of installing the eGate 5.0.x Table Runtime Environment upgrade.



“Pre-Installation Steps” on page 13

“Installing the TRE on Windows” on page 14

“Installing the TRE on UNIX” on page 16

3.1 OverviewDataGate 3.6.2 users have the option of upgrading “in place” or installing the TRE on a new environment.

Upgrading “in place”

The eGate 5.0.x TRE product can be installed in the same location as an existing e*Gate 3.6.2 installation. Doing so will preserve the existing table files and configuration files. If you choose this method, make sure you are installing the TRE on a platform that is supported by the TRE. For a list of supported platforms, see “Supported Operating Systems” on page 9.

Installing in a new environment

The eGate 5.0.x TRE product can also be installed to a new location where no e*Gate 3.6.2 installation exists. This is necessary in the event you are installing the TRE on a platform that wasn’t supported by e*Gate 3.6.2.

If you choose to install the TRE to a new environment, you will need to manually copy your table files and configuration files from your existing environment to the new location.

3.2 Pre-Installation StepsBefore installing the Table Runtime Environment, make sure you back up all of your existing table and configuration files.


Chapter 3 Section 3.3Installation Installing the TRE on Windows

If you are installing the TRE in a new environment, you will need to create a series of network user groups that are used by the TRE system. See the following table for a list of the required user groups.

3.3 Installing the TRE on WindowsBefore you begin the Windows installation you must create the TRE User Groups shown in Table 2.

To install the TRE on Windows

1 Log on to your Windows server or workstation using an account with Administrator privileges.

Important: Administrator privileges are required in order to set the necessary environment variables.

2 Double-click setup.exe on the TRE installation CD-ROM.

3 The Welcome screen appears. Click Next to continue.

4 Select the components that you want to install and click Next to continue.

Note: Use the Browse button to select an installation location other than the default.

Table 2 TRE User Groups

User Group Description

dgadmin The TRE administrator account.This account has the ability to install, rebuild, or remove files in the DataGate home directory.

dgserver Used to run the TRE server.This account has access to all server monitoring and administration functions, except for server-table editing functions.

dgclient Used to run the client executable file(s).This account has access to all client monitoring and administration functions, except for client configuration-table editing functions. It includes display access to client configuration tables as well as access to journaling commands and journal files.

dgtable This account has write-file permission for server table and client configuration files.

dguser This is the basic user account. Members of this group can view configuration files and run the monitor.


Chapter 3 Section 3.3Installation Installing the TRE on Windows

5 The setup progress indicator shows the progress of the installation.

Figure 2 Setup Progress

6 Click OK to allow the installation program to set the environment variables.

Figure 3 Setting Environment Variables

7 Click Yes to start the Exceed installation.

8 The setup will remind you that the DISPLAY and XSERVER environment variables must be correct for Exceed to run. Click OK to continue.

Figure 4 Confirm Environment Variables

9 Click Finish to complete the installation.


Chapter 3 Section 3.4Installation Installing the TRE on UNIX

Figure 5 Installation Complete

10 You must reboot your computer or log off and log back on in order for the environment variables to take affect. Click OK to continue.

11 If you are installing the TRE to a new environment, you will need to manually copy the table files and configuration files from your existing e*Gate 3.6.2 environment to the corresponding location in the Windows TRE environment.

3.4 Installing the TRE on UNIXThis section explains how to install the TRE on your UNIX system. You can mount the CD-ROM on your UNIX computer or FTP the installation files to your UNIX computer via a Windows computer.

For complete DataGate 3.X installation instructions for UNIX, see the DataGate Installation Guide.

To install the TRE on UNIX

1 Log in as either a non-root or root user on the workstation containing the CD-ROM drive, and insert the SeeBeyond TRE CD-ROM into the drive.

Note: To mount the CD-ROM, you must have root privileges. If the directory that you want to mount over does not exist, you must create it. Once this directory is created, mount the CD-ROM, using the appropriate command. The correct arguments for


Chapter 3 Section 3.5Installation Setting Up Environment Variables on Windows

the mount command vary for each operating platform. See the following table for the recommended mounting commands.

2 Navigate to the root directory of the CD-ROM on your UNIX computer.

3 Type ./cdinst.sh and press Enter. The TRE owner prompt appears:

Enter TRE Owner [ datagate ]:

4 Type your username and press Enter. The TRE installation menu appears:

[1] Install TRE[2] Install GNU Tools[3] Setup TRE User Script[0] Quit

Enter Your Choice:

5 Type 1 (Install TRE) and press Enter.

The next prompt displays the following message:

Enter Path For CDROM[CDROMFILEPATH]:

6 Type the path to the CD-ROM and press Enter.

The next prompt displays the following message:

Enter Installation Directory:

7 Type the filepath to the TRE installation directory and press Enter.

The installation runs and finishes.

3.5 Setting Up Environment Variables on WindowsThe following environment variables are created and/or modified by the TRE installation for Windows. These should not be removed:

CLASSPATH: Used by the TRE GUI to find the required Java classes.

Table 3 Mounting a CD-ROM Drive Locally

Platform Mount Command

HP Tru64 mount -t cdfs -r -o noversion -o rrip /dev/rz<extension>/cdrom

HP-UX pfs_mount -t rrip -r /dev/dsk/c0t<extension> /cdrom where /cdrom is the mount point.

IBM AIX mount -V cdrfs -r /dev/cd<extension>/cdrom

Sun Solaris 8 and 9

mount -F hsfs -o ro /dev/dsk/c0t<extension> /cdrom(On Sun Solaris systems, the CD-ROM drive mounts automatically if the volume manager is running.)

Note: Mounting of the CD-ROM on a Sun Solaris machine is automatic; for all other platforms you must be logged in as root to mount the CD-ROM.


Chapter 3 Section 3.5Installation Setting Up Environment Variables on Windows

DATAGATE: Shows the path where you installed the TRE. This requires the forward slash ("/") as a separator.

DGOS: The value of this variable should be set to the appropriate platform. It should be Win32 for windows, and it should be set to the output of the config.guess script file.

DISPLAY: The value of this parameter is hostname:1.0, where hostname is the IP address or host name of the machine where the GUI directs output.

NCDIR: Shows the path of the Xresources. For example, "NCDIR=C:/stc/datagate/Xresource".

PATH: The Java runtime binaries must be included in the search path. For example, <drive>:/Java/JDK_1_1/bin.

WINTIF_MODE: Must be set to "Motif".

XSERVER: Used by the GUI editors to communicate with the Exceed X server. For example, "XSERVER=C:/XSERVER".

XUSERFILESEARCHPATH: Used by the X server to find the application default resource file. This requires a trailing "%N". For example, "XUSERFILESEARCHPATH=C:/stc/datagate/Xresource/%N"


Chapter 4

JMS Configuration

This chapter describes the steps required to configure the JMS Out and JMS In TRE eWays or the TRE Server to exchange data with the J2EE JMS IQ Managers.

This chapter contains


“Configuring JMS Out” on page 19

“Configuring JMS In” on page 23

4.1 OverviewAs Figure 1 on page 9 shows, the TRE Server publishes and subscribes to messages in the J2EE JMS IQ Manager either directly or via the “JMS In” and “JMS Out” TRE eWays. If the TRE Server is not publishing and subscribing directly, then the TRE eWays must be configured to publish and subscribe to the necessary JMS IQ Manager host name and port.

The following sections describe the process of configuring the TRE Server or the “JMS In” and “JMS Out” TRE eWays.

Note: Please refer to “Known Issues with the TRE” on page 10 for a list of any issues that may relate to using JMS in the TRE.

4.2 Configuring JMS OutThe TRE Server (dgsrvr) publishes messages to the JMS IQ Manager running in the J2EE environment two ways:

By means of the “JMS Out” TRE eWay

By means of the TRE server

To configure either the “JMS Out” TRE eWay or the TRE server, you must add a JMS Out port and create a JMS Out configuration file.


Chapter 4 Section 4.2JMS Configuration Configuring JMS Out

To create the JMS Out port and configuration file

1 In the TRE Editor, click the Ports button.

The Define Ports dialog appears.

2 Enter a name for the port, such as “JmsOut”, in Enter/Select Port Name.

3 For the TRE eWay:

A Under Executable File, click Find to display the list of executable files.

B In the Find Executable File list, click JmsOut.exe and then click OK.

Figure 6 The JMS Out Port



4 For the TRE Server:

A Select Destination in the Direction drop-down menu.

B Enter “@jms” in Executable File.

Figure 7 The JMS Out Port

5 Click Apply to save your changes.

6 When the File Does Not Exist dialog appears, click Create and Edit to create the new configuration file.

7 In the configuration file editor, enter the necessary information. The following table shows the parameters used by the JMS Out TRE eWay. (See the example in Figure 8).

Table 4 JmsOutM.cfg

Parameter Description

DATATABLE The data configuration table

NPTTABLE The network parameter table

SERIALTABLE The full name of the serial configuration table

CHILDNAME The logical port name

INTERFACENAME A unique string used to identify this interface



Figure 8 The JMS Out Configuration File

8 When you are finished editing the configuration file, save the file and close the editor.

9 In the Define Ports dialog, click OK to save the port and close the editor.

SCRATCHFILE Unused

HOSTNAME The host name of the SeeBeyond JMS IQ Manager

PORT The port number of the SeeBeyond JMS IQ Manager

TOPICNAME The name of the topic or queue

CLIENTNAME The client name used to connect to the JMS IQ Manager

DESTTYPE The type of message destination: topic or queue

MSGTYPE The data type of the message: BytesMessage or TextMessage

SUBSCIRBERNAME The name of the subscriber. This must match the SUBSCIRBERNAME in the JMS In TRE e*Way.

SUBSCRIBERCLIENTID This must match the logical name of the JMS In TRE e*Way.

Table 4 JmsOutM.cfg (Continued)



Chapter 4 Section 4.3JMS Configuration Configuring JMS In

4.3 Configuring JMS InThe TRE Server (dgsrvr) subscribes to messages from the JMS IQ Manager running in the J2EE environment two ways:

By means of the “JMS In” TRE eWay

By means of the TRE server

To configure either the “JMS In” TRE eWay or the TRE server, you must add a JMS In port and create a JMS In configuration file.

To create the JMS In port and configuration file

1 In the TRE Editor, click the Ports button.

The Define Ports dialog appears.

2 Enter a name for the port, such as “JmsIn”, in Enter/Select Port Name.

3 For the TRE eWay:

A Under Executable File, click Find to display the list of executable files.

B In the Find Executable File list, click JMSIN.exe and then click OK.

Figure 9 The JMS In Port



4 For the TRE Server:

A Select Source in the Direction drop-down menu.

B Enter “@jms” in Executable File.

Figure 10 The JMS In Port

5 Click Apply to save your changes.

6 When the File Does Not Exist dialog appears, click Create and Edit to create the new configuration file.

7 In the configuration file editor, enter the necessary information. The following table shows the parameters used by the JMS In TRE eWay. (See the example in Figure 11).

Table 5 JmsInM.cfg


DATATABLE The data configuration table

NPTTABLE The network parameter table

SERIALTABLE The full name of the serial configuration table

CHILDNAME The logical port name

INTERFACENAME A unique string used to identify this interface

SCRATCHFILE Unused



Figure 11 The JMS In Configuration File

8 When you are finished editing the configuration file, save the file and close the editor.

9 In the Define Ports dialog, click OK to save the port and close the editor.

HOSTNAME The host name of the SeeBeyond JMS IQ Manager

PORT The port number of the SeeBeyond JMS IQ Manager

TOPICNAME The name of the topic or queue

CLIENTNAME The client name used to connect to the JMS IQ Manager

DESTTYPE The destination type: topic or queue

SUBSCRIBERNAME The name of the subscriber. This must match the SUBSCIRBERNAME in the JMS Out TRE e*Way.

MAXBUFFERSIZE The maximum buffer size in bytes (integer value) when MSGTYPE = BytesMessage.

Table 5 JmsInM.cfg (Continued)



Glossary

Glossary

CollaborationA logical operation performed between some combination of message destinations and external applications. The operation is defined by a Collaboration Definition, which can be encoded in either Java or XSLT.

Also see “Service” and “Collaboration Definition”.

Collaboration DefinitionThe encoding of business rules, in Java or XSLT format. Typically, the encoding consists of operations on OTDs (see “OTD”). Several Collaborations can have the same Collaboration Definition.

ConnectionConsists of the configuration information that enables an eWay to connect to an external system.

Connectivity MapContains business logic and routing information about the data transmission. A Connectivity Map usually includes one or more Collaborations, Passthrough Collaborations, topics, queues, and eWays. A Connectivity Map is created under a Project. A Project may have multiple Connectivity Maps.

ConstantsA name or value pair that is visible across a Project.

Deployment ProfileContains the information about how the Project components will be deployed in an Environment. A Project can have multiple Deployment Profiles, but only one Deployment Profile can be activated for a Project in any one Environment.

Derived CollaborationCollaboration that inherits operations from another, according to standard object-oriented practice.

eGate SystemSee “Project”.

EnvironmentA collection of physical resources and their configurations that are used to host Project components. An Environment contains logical hosts and external systems.


Glossary

eWayA link between a Collaboration and an external connection including the message server connection (topic or queue) or external application.

External ApplicationA logical representation in an eGate Project of an external application.

External SystemA representation in an eGate Project of an external application system.

ICAN SuiteThe SeeBeyond Integrated Composite Application Network Suite.

Integration ServerJ2EE software platform that houses the business logic container used to run Collaborations and JCA connectors (eWays). Provides transaction services, persistence, and external connectivity.

JMS IQ ManagerJMS-compliant, guaranteed delivery store, forwarding, and queueing service.

LinkThe JMS Connection between a Collaboration and a topic or queue in a JMS-compliant message server.

Linked Message DestinationA reference to a Message Destination defined in another Connectivity Map.

Logical HostAn instance of the eGate runtime Environment that is installed on a machine. A Logical Host contains the software and other installed components that are required at runtime, such as application and message servers.

Management AgentUses J2EE technology to manage and monitor an eGate 5.0 deployment that may contain other application servers in addition to the SeeBeyond Integration Server. Defines management interfaces and services designed for distributed environments, focusing on providing functionality for managing networks, systems, and applications.

Message DestinationA general term for a topic or queue. Two or more Projects can share a message destination that has the same name and is deployed on the same message server. A single Project may also have a single message destination referenced in multiple Connectivity Maps.

OTDAn acronym for Object Type Definition. OTDs contain the data structure and rules that define an object. An OTD is used in Java Collaboration Definitions for creating data transformations and interfacing with external systems.


Glossary

ProjectContains a collection of logical components, configurations, and files that are used to solve business problems. A Project organizes the files and packages and maintains the settings that comprise an eGate system in SeeBeyond’s Enterprise Designer.

QueueA JMS queue is a shareable object that conforms to the point-to-point (p2p, or PTP) messaging domain, where one sender delivers a message to exactly one receiver. When the SeeBeyond JMS IQ Manager sends a message to a queue, it ensures it is received once and only once, even though there may be many receivers “listening” to the queue. This is equivalent to the subscriber pooling in other queue implementations. You can reference a queue that exists in another Connectivity Map or Project.

RepositoryStores and manages the setup, component, and configuration information for eGate Projects. The Repository also provides monitoring services for Projects, which include version control and impact analysis.

Schema Runtime EnvironmentAn add-on in eGate 5.0 that provides the upgrade path for e*Gate 4.x users to upgrade to eGate 5.0. Also known as the SRE.

ServiceContains the information about executing a set of business rules. These business rules can be defined in a Java Collaboration Definition, XSLT Collaboration Definition, Business Process, eTL Definition, or other service. A Service also contains binding information for connecting to JMS Topics, Queues, eWays, and other services.

SubprojectAn independent Project that is included as part of another Project and listed on the Enterprise Explorer tree beneath the main Project icon.

Table Runtime EnvironmentAn add-on in eGate 5.0 that provides the upgrade path for e*Gate 3.x users to upgrade to eGate 5.0. Also known as the TRE.

TopicA JMS topic is a shareable object that conforms to the publish-and-subscribe (pub/sub) messaging domain, where one publisher broadcasts messages to potentially many subscribers. When the SeeBeyond JMS IQ Manager publishes a message on a topic, it ensures that all subscribers receive the message.

XSLT

An acronym for Extensible Stylesheet Language Transformations. A file format used in eGate to generate Collaboration Definitions.


Glossary

e*Gate 3.x Terms in eGate 5.0

Table 6 provides definitions for the terms that are new with eGate release 5.0, as well as equivalent terms from e*Gate release 3.x.

Table 6 eGate 5.0 Terms

5.0 Term 3.x Equivalent Term

Collaboration Translation

Collaboration Definition

Translation Rules

Connection Connection

Connectivity Map Route

Deploy Start DataGate Server

Deployment <none>

Deployment Profile <none>

Enterprise Designer DgEdit

Enterprise Manager DgMon (GUI Monitor)

Environment Table

eWay DataGateWay (DGW)

eWay Configuration DGW Configuration

External Application External Application

External System External System

JMS Connection <none>

Integration Server <none>

Link <none>

Linked Message Destination

<none>

Logical Host Host

Message Destination <none>

Message Server <none>

Object Type Definition (OTD)

Message Structure

Process Manager <none>

Project Table

Queue GDBM Queue

Repository <none>

Subproject <none>

Topic <none>

XSLT <none>


Index

Index

CCD-ROM drive

mounting on UNIX 17Collaboration 26, 29

derived 26Collaboration definition 26, 29Connection 29connection 26, 29Connectivity Map 26, 29constants 26

DDataGateWay 29deploy 29Deployment 29Deployment Profile 26, 29derived Collaboration 26DgEdit 29DgMon 29DGW 29DGW Configuration 29document

conventions 6

EeGate system 26Enterprise Designer 29Enterprise Manager 29Environment 26, 29eWay 27, 29eWay Configuration 29external

application 27, 29system 27, 29

External Application 29External System 29

GGDBM Queue 29GUI Monitor 29

HHost 29

IICAN Suite 27Integration Server 27, 29

JJMS

connection 29JMS IQ Manager 27

Llink 27, 29linked message destination 27, 29Logical Host 27, 29

MManagement Agent 27message

destination 27, 29server 29

Message Structure 29mount commands

Linux 17UNIX 17

OObject Type Definition 27, 29OTD 27, 29

PProcess Manager 29Project 28, 29

Qqueue 28, 29

RRepository 28, 29Route 29


Index

SSchema Runtime Environment 28Security Server 28SRE 28Start DataGate Server 29subproject 28, 29

TTable 29Table Runtime Environment 28topic 28, 29Translation 29Translation Rules 29TRE 28

UUNIX

mounting CD-ROM drive 17

Wwriting conventions 6

XXSLT 28, 29
