iWay Adapter for EDAAPI

In this section:

Reference:

The iWay Adapter for EDAAPI (CS3) enables you to modify existing client applications to access packaged adapters as well as terminal emulation adapters. Client applications, such as Microsoft Query, can use the iWay Connector for ODBC, which generates EDAAPI (CS3) network calls usually intended for a data server.

Note: The CS3 listeners provide access to both JDBC and non-JDBC data sources.


Top of page

x
Using EDAAPI Calls

The iWay Adapter for EDAAPI (CS3) can accept EDAAPI calls in the same way as an iWay Server. The results are returned to the client in CS3 format or in XML format to alternate destinations.

When EDAAPI calls are received from the client, a standard iWay request document is generated automatically. The information required for the connection and query is extracted from each call and built into the request document. Requests are processed synchronously as soon as the SQL or RPC command is received from the client.


Top of page

x
Reference: EDAAPI Listener Properties

The following table lists and describes the EDAAPI listener properties. For instructions on creating a listener, see Configuring Listeners.

Property Name

Property Description

Port (required)

The service port number that the listener uses to exchange messages. The iWay Service Manager configuration tool requires that the port be numeric.

Note: The port must match the value that the EDAAPI client is using to send the CS3 calls.

Delimiter (%)

The delimiter for embedded commas. Data encapsulated by the delimiter (%data, more data, more data%) is sent to the server as a single data element that allows you to send special characters, such as commas to the server. If the delimiter is not used, the CS3 listener treats commas as separators.

Multithreading

Indicates the number of documents that can process in parallel. To enable the listener to handle a second request while an earlier request is still being processed, set this to a value greater than 1. The total throughput of a system is affected by the number of threads operating.

Default: 1

Max value: 99

Agent Precedence

This changes the order in which the engine selects agents. Usually, the document overrides the listener. This is used to manage iWay documents.

Return Message Only

If set to true, this returns to an earlier behavior where an acknowledgment is returned to an application instead of an answer set.

Always reply to listener default

If set to true, the default reply definition is used in addition to defined replies.

Execution Time Limit

The maximum time to complete a request. Prevents runaway requests. iWay Service Manager terminates any request that takes longer than this value to complete.

LDAP Security

Using LDAP security allows the CS3 listener to confirm the incoming user name and password values against values stored in the LDAP repository. Otherwise, EDAAPI calls are processed without user validation.

To use LDAP security you must have configured an LDAP repository. For more information, see Obtaining Configuration Properties Using LDAP.

Secure

If selected, the listener confirms the password against the LDAP value.

iWay Client Login Field

The LDAP attribute that represents the client login.

iWay Client Password Field

The LDAP attribute that represents the client password.

Access Context

The context where the client attributes are stored.


Top of page

x
Reference: EDAAPI Listener Special Registers

The following table lists and describes the special registers (SREGs) available on the EDAAPI listener.

Name

Source

Level

Type

iwayconfig

Listener

System

String

msgsize

Listener

Document

Integer

name

Listener

System

String

protocol

Listener

System

String

tid

Listener

Document

String


Top of page

x
Configuring an EDAAPI Client (ODIN.CFG Node)

An EDAAPI client must be configured to connect to a server with a name that matches the name of a data server defined in the iWay Service Manager configuration.

For example, you can use the iWay Server test tool as a EDAAPI client to the iWay Service Manager EDAAPI listener. The test tool obtains a list of available servers from the odin.cfg file. The file must contain a node entry name matching the name of a data source configured to iWay Service Manager.

The following is a node in the odin.cfg file used by the EDAAPI Client:

NODE=IXTEJLNK
BEGIN
PROTOCOL=TCP
PORT=2222
HOST=IXTESERV
END

The client is configured to communicate with an EDAAPI listener, hosted by a machine called iXTESERV, listening on port 2222. IXTEJLNK must be a configured data source in iWay Service Manager.


iWay Software