Creating and Managing a Connection

In this section:

How to:

Reference:

To access an adapter, you must define a target that connects to the adapter. After the defined target is created, it automatically is saved in the iBSP repository. You must establish a connection to the defined target every time you start iWay Explorer.


Top of page

x
Procedure: How to Define a New Target

To define a new target:

  1. In the left pane of iWay Explorer, expand the iWay Adapters node.
  2. Click the RDBMS node.
  3. In the right pane, move the pointer over Operations and select Define a new target.

    The Add a new RDBMS target pane opens on the right with a definition of targets and instructions for adding a target as shown in the following image.

    1. In the Target Name field, type a descriptive name for the target, for example, NewTarget.
    2. In the Description field, type a brief description for the connection (optional).
    3. From the Target Type drop-down list, select the type of target to connect to.

      Note: The database types that appear in the Target Type drop-down list depend on the available JDBC drivers in the iWay60\lib directory. You must use the JDBC datasource if it is available in the drop-down list for your available target type. The JDBC datasource targets will appear in the drop-down list only if they are registered with the JNDI naming service. If they are not registered, you can then use the JDBC option to connect to the database.

  4. Click Next.

    The Set connection info pane opens on the right pane and includes fields to complete to set your connection parameters. The fields that appear in the Set connection info pane are specific to the type of database to which you are connecting and the target type you select.

    Note: The RDBMS connection parameters are consistent with those found in your RDBMS system. For more information on parameter values that are specific to your RDBMS configuration, consult your RDBMS system administrator.

  5. Enter connection information that is specific to the database to which you want to connect.

    For information on connection parameters for an Oracle target type, see Oracle Connection Parameters.

    For information on connection parameters for an HSQL target type, see HSQL Connection Parameters

    For information on connection parameters for a Progress target type, see Progress Connection Parameters.

    For information on connection parameters for an SQL Server target type, see SQLServer Connection Parameters.

    For information on connection parameters for a Sybase target type, see Sybase Connection Parameters.

    For information on connection parameters for an Informix target type, see Informix Connection Parameters

    For information on connection parameters for a DB2 target type, see DB2 Connection Parameters.

    For information on connection parameters for a MaxDB target type, see MaxDB Connection Parameters.

    For information on connection parameters for an EDA Server target type, see EDA Server Connection Parameters.

    For information on connection parameters for an iWay Server target type, see iWay Server Connection Parameters.

    For information on connection parameters for a WebFocus Server target type, see WebFocus Server Connection Parameters.

    For information on connection parameters for a Cache target type, see Cache Connection Parameters.

    For information on connection parameters for a Teradata type 4 Driver target type, see Teradata Type 4 Driver Connection Parameters.

    For information on connections parameters for an ODBC target type, see ODBC Connection Parameters.

    For information on connection parameters for a JDBC target type, see JDBC Connection Parameters.

    For information on connection parameters for a Datasource target type, see Datasource Connection Parameters.

  6. Click Finish.

    In the left pane, the target name appears under the node where you created the new target. You have finished creating the new target.

    For information on connecting to the target, see How to Connect to a Defined Target.


Top of page

x
Reference: Oracle Connection Parameters

The following table lists and defines the connection parameters for the Oracle target type.

Parameter

Definition

Settings Tab

Enables you to define the standard settings for an Oracle RDBMS.

Host

DNS or IP name of the server where the database instance resides.

Port

Port number on which the database is listening.

SID

For an Oracle database, the unique name of the database service selected by the database administrator or the person who installed Oracle.

User ID

Database user ID to access the database. The user ID must have database access to the interface tables that are accessed.

User password

Password associated with the specified user name.

Oracle RAC Configuration Tab

Enables you to configure Oracle Real Application Clusters (RAC), which provides clustering and higher availability for an Oracle RDBMS.

Connection Cache Name

The connection name you want to use for the Oracle RAC configuration. You can use any name.

TCP Timeout

The number of milliseconds before the connection times out.

Connection Descriptor of LDAP url

The connection description URL, which is found in the tnsnames.ora file of the Oracle RAC configuration.

Oracle Name Server (ONS)

The node setting for each Oracle system in the cluster, which includes host and port number.

For example:

nodes=orac1:6200,orac2:6200

where:

orac1 and orac2

Are the host names.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.

Datasource Tab

Initial Context

JNDI context.INITIAL_CONTEXT_FACTORY that is provided by the JNDI service provider.

URL

For a JDBC connection, the JDBC driver-specific URL used to connect to the Oracle database.

JNDI Name

JNDI name of a queue to which events are emitted.



x
Reference: HSQL Connection Parameters

The following table lists and defines the connection parameters for the HSQL target type.

Parameter

Definition

Driver Type

Select from the following, depending on how you are running your HSQL database:

  • Standalone
  • Server
  • Web Server
  • In-Memory

User ID

ID for accessing the database.

User password

Password for the database ID given.

Path (Standalone)

If you are running HSQL in standalone mode, provide the full path to the database file.

Host

If you are running HSQL in server or Web Server mode, provide the name of the machine on which the database is running.

Port

If you are running HSQL in server or Web Server mode, provide the port number on which the database is listening.

Server Name:

The name of the database server.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.



x
Reference: Progress Connection Parameters

The following table lists and defines the connection parameters for the Progress target type.

Parameter

Definition

HOST

DNS or IP name of the server where the Progress database instance resides.

PORT

Port number on which the Progress database is listening.

Database Name

Specific name of the Progress database to which you connect.

User

Database user ID to access the Progress database.

Password

Password associated with the specified user name.

To connect with a Progress database, the following files must be available in the classpath:

Currently, iWay Service Manager 6.0.1 supports Progress version 9.2 and higher.



x
Reference: SQLServer Connection Parameters

The following table lists and defines the connection parameters for the SQLServer target type.

Parameter

Definition

Host

DNS or IP name of the server where the database instance resides.

Port

Port number on which the database is listening.

Database Name

Specific name of the database or data source to which you connect.

User Name

Database user ID to access the database. The user ID must have database access to the interface tables that are accessed.

Password

Password associated with the specified user name.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.



x
Reference: Sybase Connection Parameters

The following table lists and defines the connection parameters for the Sybase target type.

Parameter

Definition

Host

DNS or IP name of the server where the database instance resides.

Port

Port number on which the database is listening.

User Name

Database user ID to access the database. The user ID must have database access to the interface tables that are accessed.

Password

Password associated with the specified user name.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.



x
Reference: DB2 Connection Parameters

The following table lists and defines the connection parameters for the DB2 target type.

Parameter

Definition

Host

DNS or IP name of the server where the database instance resides.

Port

Port number on which the database is listening.

Database Name

Specific name of the database or data source to which you connect.

Driver Type

For DB2 connections, select one of the following JDBC drivers.

  • app driver: Ensure you have the DB2 client installed on the machine from which you are accessing iWay Explorer.
  • net driver: Ensure you started the DB2 applet server.
  • JCC driver: Pure Java connectivity to the DB2 database.

For more information, see your DB2 documentation.

Note: The app (type 2) and net (type 3) drivers only support connection to DB2 7 and DB2 8. The JCC (type 4) driver is required for connectivity to DB2 9.

If the db2java.zip and the db2jcc.jar files are added to the classpath, you have the option to choose from any of the three drivers.

User Name

Database user ID to access the database. The user ID must have database access to the interface tables that are accessed.

Password

Password associated with the specified user name.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.



x
Reference: MaxDB Connection Parameters

The following table lists and defines the connection parameters for the MaxDB target type.

Parameter

Definition

URL

DNS or IP name of the server where the MaxDB database instance resides.

User

Database user ID to access the MaxDB database.

Password

Password associated with the specified user name.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.



x
Reference: Informix Connection Parameters

The following table lists and defines the connection parameters for the Informix target type.

Parameter

Definition

Host

DNS or IP name of the server where the database instance resides.

Port

Port number on which the database is listening.

Database Name

The name of the database being accessed.

Informix Server Name

The name of the database server.

User id

Database user ID to access the database. The user ID must have database access to the interface tables that are accessed.

User password

Password associated with the specified user name.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.



x
Reference: EDA Server Connection Parameters

The following table lists and defines the connection parameters for the EDA Server target type.

Parameter

Definition

Host

DNS or IP name of the server where the database instance resides.

Port

Port number on which the database is listening.

User Name

Database user ID to access the database. The user ID must have database access to the interface tables that are accessed.

Password

Password associated with the specified user name.

Server Name

For an iWay server component, the name of the service node to which you are connecting.

Trace

Type 0 to disable tracing and 1 to enable tracing.

Trace File

Path and file name for the trace file.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.



x
Reference: iWay Server Connection Parameters

The following table lists and defines the connection parameters for the iWay Server target type.

Parameter

Definition

Host

DNS or IP name of the server where the database instance resides.

Port

Port number on which the database is listening.

User Name

Database user ID to access the database. The user ID must have database access to the interface tables that are accessed.

Password

Password associated with the specified user name.

Server Name

For an iWay server component, the name of the service node to which you are connecting.

Trace

Type 0 to disable tracing and 1 to enable tracing.

Trace File

Path and file name for the trace file.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.



x
Reference: WebFocus Server Connection Parameters

The following table lists and defines the connection parameters for the WebFOCUS Server target type.

Parameter

Definition

Host

DNS or IP name of the server where the database instance resides.

Port

Port number on which the database is listening.

User Name

Database user ID to access the database. The user ID must have database access to the interface tables that are accessed.

Password

Password associated with the specified user name.

Server Name

For an iWay server component, the name of the service node to which you are connecting.

Trace

Type 0 to disable tracing and 1 to enable tracing.

Trace File

Path and file name for the trace file.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.



x
Reference: Cache Connection Parameters

Parameter

Definition

Host

DNS or IP name of the server where the database instance resides.

Port

Port number on which the database is listening.

Database Name

Name of the database you want to access.

User id

User ID to access the database. The user ID must have database access to the interface tables that need to be accessed.

User password

Password associated with the specified user name.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.



x
Reference: Teradata Type 4 Driver Connection Parameters

Parameter

Definition

Database Name

Name of the database you want to access.

User id

User ID to access the database. The user ID must have database access to the interface tables that need to be accessed.

User password

Password associated with the specified user name.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.



x
Reference: ODBC Connection Parameters

The following table lists and defines the connection parameters for the ODBC target type.

Parameter

Definition

Data Source Name

Specific name of the database or data source to which you connect.

User Name

Database user ID to access the database. The user ID must have database access to the interface tables that are accessed.

Password

Password associated with the specified user name.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.



x
Reference: JDBC Connection Parameters

The following table lists and defines the connection parameters for the JDBC target type.

Parameter

Definition

Driver

Name of the driver used to access the database you want to connect to. For more information, see your database documentation.

URL

For a JDBC connection, the JDBC driver-specific URL used to connect to the RDBMS.

For information on using driver options in the URL definition, for example, selectMethod=Cursor for Microsoft SQL, see Using URL Options (For JDBC Connections Only).

User Name

Database user ID to access the database. The user ID must have database access to the interface tables that are accessed.

Password

Password associated with the specified user name.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.



x
Reference: Datasource Connection Parameters

The following table lists and defines the connection parameters for the Datasource target type.

Parameter

Definition

Initial Context Factory

JNDI context.INITIAL_CONTEXT_FACTORY that is provided by the JNDI service provider.

URL

For a JDBC connection, the JDBC driver-specific URL used to connect to the RDBMS.

For information on using driver options in the URL definition, for example, selectMethod=Cursor for Microsoft SQL, see Using URL Options (For JDBC Connections Only).

For a data source connection, the URL to use to contact the JNDI provider. The syntax of this URL depends on the JNDI provider being used. This value corresponds to the standard JNDI property,

java.naming.provider.url

JNDI Name

JNDI name of a queue to which events are emitted.

Database

Oracle, SQL Server, Sybase, DB2, Informix, EDA Server, or other.

JDBC Tab

URL

Allows optional settings to be specified for the JDBC URL.

For information on connecting to the target, see How to Connect to a Defined Target.


Top of page

x
Reference: Using URL Options (For JDBC Connections Only)

Each driver has specific JDBC system properties, most of which can be used in the connection string. The URL options can be added to the JDBC URL in the connection properties for a specific target. For more information on these properties, refer to the documentation on the specific driver.


Top of page

x
Procedure: How to Connect to a Defined Target
  1. In the left pane of iWay Explorer, expand the iWay Adapters node.

    The following image shows the RDBMS node expanded with NewTarget selected. The x under the connection icon indicates that the connection is closed.

  2. Expand the RDBMS node and select the connection you want to open (for example, NewTarget).
  3. In the right pane, move the pointer over Operations and select Connect.

    The connection pane opens and displays the connection information.

  4. Verify your connection parameters. If required, provide the password and then click OK.

    If the parameters are correct and the RDBMS component is available, the node under the RDBMS node displays a plus sign indicating that you are connected to the defined target. Otherwise, an error message appears in the right pane.


Top of page

x
Disconnecting From a Defined Target

Although you can maintain multiple open connections, iWay Software recommends disconnecting from targets that are not in use.



x
Procedure: How to Disconnect From a Defined Target
  1. In the left pane of iWay Explorer, expand the iWay Adapters node.
  2. Expand the RDBMS node.
  3. The following image shows the RDBMS node expanded with NewTarget selected. The plus icon associated with the connection icon indicates that the connection is open.

  4. Click the connection you want to close, for example, NewTarget.
  5. In the right pane, move the pointer over Operations and select Disconnect.

    Disconnecting from the application closes the connection, but the connection still appears in the left pane so that you can re-open it.

    The connection node now has an x icon, indicating that it is closed, as shown in the following image.

    When you want to re-establish a connection, Connect is available from the pop-up menu.


Top of page

x
Editing a Defined Target

After you create a defined target using iWay Explorer, you can edit any information that you provided during the creation process. If you change any parameters without editing, the changes will not be saved. You must edit the target in order for the changes to be saved.



x
Procedure: How to Edit a Defined Target
  1. In the left pane of iWay Explorer, expand the iWay Adapters node.
  2. Expand the RDBMS node.
  3. Click the connection you want to edit, for example, NewTarget.
  4. In the right pane, move the pointer over Operations and select Edit.

    The Edit pane opens on the right and includes three fields (Target Name, Description, and Target Type) and two active buttons (Next and Cancel).

  5. Modify the target information as required and then, click Next.

    The Set connection info pane opens on the right.

  6. Modify the information as required and then, click Finish.

Top of page

x
Deleting a Defined Target

You can delete a target, rather than just disconnecting and closing it. When you delete the target, the node disappears from the list of RDBMS targets in the left pane of the explorer.



x
Procedure: How to Delete a Defined Target
  1. In the left pane of iWay Explorer, expand the Way Adapters node.
  2. To view the list of connections, expand the RDBMS node.
  3. Click the connection you want to delete.
  4. In the right pane, move the pointer over Operations and select Delete.

    A message appears, prompting you to confirm the deletion of the node.

  5. Click OK.

    The node disappears from the list of available connections.


iWay Software