OpenTP1 Version 7 TP1/Client User's Guide TP1/Client/W, TP1/Client/P

[Contents][Index][Back][Next]

2.3.15 Remote API facility

TP1/Client provides permanent connection between a CUP and the server. Using this connection, the CUP can transfer an API to the server, allowing a server process to execute that API. This capability is called the remote API facility. You can also use the remote API facility to issue a service request to a UAP inside a firewall. A firewall, which is located between a shared network and a restricted network, is hardware and software for preventing a third party from illegally entering the network.

When passing through the firewall using the remote API facility, the CUP issues the dc_clt_cltin_s (DCCLT_NO_AUTHENT specified in flags) function to send a request for establishing a permanent connection to the RAP-processing listener in TP1/Server.

Upon the reception of a response for establishing the permanent connection, the permanent connection with the RAP-processing server is established. After the establishment of a permanent connection, any request to the RAP-processing server is sent using the permanent connection. After disconnection, however, the system sends a request to the RAP-processing listener.

When using this function, specify DCCLTRAPHOST for the client environment definition.

The remote API facility is also available for requesting services to DCCM3 logical terminal.

When Y is specified in DCCLTRAPAUTOCONNECT of the client environment definition, a permanent connection is automatically established between the CUP and the RAP-processing server or between the CUP and the DCCM3 logical terminal. In this case, the dc_clt_connect_s function and the dc_clt_disconnect_s function do not need to be executed.

The following figure illustrates the remote API facility.

Figure 2-7 Remote API facility

[Figure]

Organization of this subsection
(1) Prerequisites
(2) Scope
(3) Selecting a permanent connection destination
(4) Notes on controlling transactions by using the remote API facility

(1) Prerequisites

The remote API facility is available for service-requested TP1/Server Base with version 03-05 or later.

To use the remote API facility to control transactions, service-requested TP1/Server Base must be version 03-06 or later.

You can request services to DCCM3 logical terminals with version 09-02 or later as well as:

(2) Scope

When using this facility to execute an RPC for DCCM3, you cannot generate a transaction for which the CUP is the root transaction. Also, you cannot concurrently establish a permanent connection with two or more remote systems.

This facility cannot access the XATMI interface.

(3) Selecting a permanent connection destination

The destination of a permanent connection varies with the flags set by the dc_clt_connect_s function, and with specified DCCLTDCCMHOST and DCCLTRAPHOST in the client environment definitions. When passing through the firewall using the remote API facility, specify DCCLTRAPHOST in the client environment definition.

Table 2-3 lists relationships between the function settings, definition specification and permanent connection destinations.

Table 2-3 Function settings, definition specification and permanent connection destinations

Argument flags Client environment definition Establishing permanent connection for:
DCCLTDCCMHOST DCCLTRAPHOST
DCNOFLAGS


Y Y RAP-processing server or DCCM3 logical terminal1
- CUP execution process
- Y RAP-processing server or DCCM3 logical terminal1
- CUP execution process
DCCLT_DCCM3


Y Y DCCM3 logical terminal2
- DCCM3 logical terminal2
- Y Error return
- Error return

Legend:
Y: Specified
-: Not specified

1
Establish permanent connection for a DCCM3 logical terminal specified by DCCLTRAPHOST.

2
Establish permanent connection for a DCCM3 logical terminal specified by DCCLTDCCMHOST.

(4) Notes on controlling transactions by using the remote API facility