BEA eLink for Mainframe SNA 3.1   Information Center     

        HOME   |   SEARCH   |   CONTACT   |   PDF FILES |   WHAT'S NEW 
 
        TABLE OF CONTENTS   |   PREVIOUS TOPIC   |   NEXT TOPIC  

Programming Considerations

This section covers the following topics:

Overview

This section is intended for application programmers who implement and integrate BEA TUXEDO and host enterprise applications using Application Program-to-Program Communication (APPC). Although primarily oriented toward BEA TUXEDO application developers, it is also useful for non-TUXEDO application developers seeking to understand the relationship between the environments.

BEA eLink for Mainframe SNA software gives BEA TUXEDO applications access to host APPC programs acting as servers. At the same time, APPC applications can act as clients and access BEA TUXEDO system services. Because the client and server programs must be written for separate and very different environments, eLink SNA allows the applications to be written using native programming facilities:

Programmers in each environment can continue to use the tools with which they are familiar to develop application software. It is not important that a programmer be well versed in the programming facilities of the other environments. What is important, however, is proper coordination between the applications running in each environment.

This section explains the various options offered by the eLink SNA domain and illustrates the most effective ways to implement these options.

APPC/IMS Programming

The eLink SNA system supports non-transactional IMS servers using either the implicit APPC support for IMS or the explicit APPC interface using APPC/MVS calls from a user application.

Implicit APPC is similar and more convenient than the CICS/ESA DPL. Any IMS program that gets from and puts messages to the IMS message queue can be used without change as either a client or server.

Note: BEA eLink for Mainframe SNA does not currently support CONFIRM and SYNCPOINT IMS operations. When specifying synchronization levels for IMS operations, you must use MAXSYNCLVL=0 (none) in the DM_SNALINKS section of the DMCONFIG file. That is the default.

To use the implicit APPC capabilities of IMS, you must modify the APPCM file in the SYS1.PARMLIB library provided with your eLink SNA software. The configuration parameters in this file associate the LU with the IMS scheduler. You must identify the LU representing the application name used by eLink SNA to access the IMS region and the IMS system ID which provides scheduling for inbound requests.It is important to discuss with mainframe support personnel the changes you make to the APPCM file.

In Listing 6-1, the VTAM application major node is designated to be MVSLUO1 and the scheduling facility is designated to be the IMS control region IVP4.

Listing 6-1 APPCM File in SYS1.PARMLIB Library (Example Only)
SYS1.PARMLIB(APPCMxx)

LUADD ACBNAME(MVSLU01) BASE TPDATA(SYS1.APPCTP),
SCHED(IVP4),
SIDEINFO DATASET(SYS1.APPCSI)

SYS1.VTAMLST(MVSLU01)

MVSLU01 APPL ACBNAME=MVSLU01, ACBNAME FOR APPC C
APPC=YES, C
AUTOSES=3, C
DDRAINL=NALLOW, C
DLOGMOD=APPCHOST, C
DMINWNL=3, C
DMINWNR=3, C
DRESPL=NALLOW, C
DSESLIM=6, C
LMDENT=19, C
MODETAB=APPCTAB, C
PARSESS=YES, C
SECACPT=CONV, C
SRBEXIT=YES, C
VPACING=1

The job which starts the IMS subsystem should have the APPC parameter set to Y. The example in Listing 6-2 illustrates such a job, but is not intended to be used under actual conditions. Use your own custom job for starting IMS.

Listing 6-2 IMS Subsystem Start Job (Example Only
)IVP51F41 EXEC,PROC=IMSFP,TIME=(1440),,                         
AGN=IVP, AGN NAME
SOUT='*', SYSOUT CLASS
MBR=DFSIVAG, PROGRAM NAME
PSB=DFSIVPG, PSB NAME
NBA=06, INITIAL FAST PATH DB BUFFERS
OBA=05, SECONDARY FAST PATH DB BUFFERS
TLIM=10, IFP TERMINATION LIMIT
SOD=, SPIN-OFF DUMP CLASS
IMSID=IVP4, IMSID OF IMS CONTROL REGION
APPC=Y, ENABLE IMPLICIT APPC
PREINIT=DC PROCLIB DFSINTXX MEMBER

CICS/ISC Programming

This subsection covers the following topics:

About CICS/ISC

The CICS/ESA Intersystem Communications (ISC) facility permits multiple independent CICS/ESA systems, normally executing on different hosts and possibly different computing platforms, to cooperate while performing various computing tasks.

CICS/ESA defines a set of five distinct services with ISC as a common foundation:

The first four ISC services are categorized as implicit. These services are not used directly by user-written CICS/ESA applications, but are employed indirectly and automatically by the CICS/ESA system on behalf of them. The services are supported between peer CICS/ESA systems; for example, between two mainframe CICS/ESA systems connected by an ISC link. Currently, eLink SNA software supports DPL for BEA TUXEDO.

DTP, on the other hand, is an explicit service that can be used by CICS/ESA applications to cooperatively distribute business functionality. The eLink SNA software supports DTP services between peer CICS/ESA systems, as well as between CICS/ESA systems and non-CICS/ESA systems (for example, a DTP application conversing with an APPC/MVS application). The eLink SNA software also supports DTP for BEA TUXEDO ATMI applications.

Multi-Region versus Multi-Processor Operations

CICS/ESA applications may also use another form of intersystem communication, called Multi-Region Operation (MRO). MRO is typically used to improve the performance of a CICS/ESA system by partitioning it into multiple, physically distinct regions.

MRO can be compared to a BEA TUXEDO Multi-Processor (MP) environment. In a two-platform MP application domain, the first platform might be dedicated to handle terminal and workstation clients, and the second platform might be dedicated to handle the application logic and file services. In a similar MRO configuration, all terminals might be placed in one CICS/ESA region (called a terminal-owning region), and applications and data stores might be placed in another CICS/ESA region (called an application-owning or file-owning region).

The biggest difference between this MP environment and the MRO configuration is that the MP environment spans multiple platforms, whereas the MRO configuration resides on a single host.

The eLink SNA software does not relate directly to the MRO single platform nature. However, it does support ISC operations.

ISC Operations

The ISC facility provides a mechanism for multiple CICS/ESA systems operating on different host computers to communicate with each other, but ISC is more than a simple communications mechanism. It implements a well-defined set of protocols by which connected CICS/ESA systems cooperate in the execution of recoverable, distributed units of work. This important concept is fundamental to understanding the relationship between connected CICS/ESA systems.

IBM's Systems Network Architecture (SNA) defines the protocols for communications between IBM systems in a multi-system environment. ISC is an implementation of a specific SNA protocol known as Advanced Program-to-Program Communications (APPC, also referred to as LU TYPE 6.2 or LU 6.2).

The ISC for APPC is not a strict implementation of the SNA architecture specification. In particular, CICS/ESA makes use of special Function Management Headers (FMH) which are not part of the SNA architecture specification. Other deviations are documented in the IBM Distributed Transaction Programming Guide.

Although ISC can be used to connect CICS/ESA systems residing on a single host computer, ISC is normally used to connect CICS/ESA systems which reside on physically-distinct host computers. Furthermore, systems which are geographically separated may be connected.

IBM's Advanced Communication Facility / Virtual Telecommunications Access Method (AFC/VTAM) is used to define and implement a logical connection between two CICS/ESA systems. Using the VTAM facilities, CICS/ESA systems establish one or more concurrent sessions for communications. Each session supports one logical conversation between the two systems. These logical conversations carry the inter-system traffic associated with the various ISC functions.

Similar to BEA TUXEDO conversational service requests, LU 6.2 is a half-duplex protocol; that is, session traffic can flow in only one direction at a time. The session partners are responsible for coordinating their use of the session such that when one is sending, the other is receiving. Both session partners cannot send (or receive) at the same time.

Asynchronous Processing

This ISC service allows an application to start a transaction on a remote system. Unlike DPL and Function Request Shipping, the calling application does not wait for the remote task to complete. The calling transaction initiates an asynchronous process with the CICS/ESA interval START command. Information can be passed to the back-end transaction in the FROM option of the START COMMAND. The back-end transaction can then issue a RETRIEVE command to get this data. The transaction can be defined as remote, indicating the system on which the transaction is to be run, or the remote system can be named explicitly in the SYSID option of the START command.

Function Request Shipping

Remote resources, such as VSAM files, DLI requests, Transient Data Queues, and Temporary Storage Queues can be made available to a local application. The application is not necessarily aware that the requested resource is on another CICS/ESA region. Files and Queues are defined as remote with system administration utilities, but could optionally be specified as remote using the SYSID option of the resource request command.

Transaction Routing

Transaction routing provides a terminal connected to a CICS/ESA region with the ability to run a transaction on another CICS/ESA region in a fashion transparent to the terminal user. A transaction can be defined as a remote transaction in the system initialization table. This definition indicates on which remote system the transaction is to run.

Distributed Program Link

Distributed Program Link (DPL) allows a CICS/ESA program to call (link to) another CICS/ESA program located on a remote system. This is a synchronous process; control does not return to the calling program until the called program has finished executing. See Figure 6-1 for a generic example of the DPL process.

In most cases, DPL is completely transparent to both the calling and called programs. An application program is not aware that it is calling a program located on a remote system.

The remote program is minimally constrained. It can access files and databases, as well as link to other programs, but it cannot perform terminal I/O. Also, it does not provide recovery and restart of CICS/ESA-controlled resources, such as files and databases; implicit support is provided automatically by the CICS/ESA system.

Note: If a client sends a data buffer to a remote CICS/ESA system as part of a DPL and no data is modified, the remote system returns no data and the length is zero.

Figure 6-1 Generic DPL Transaction

Step-by-Step Description: Generic DPL Transaction

  1. CICS/ESA transaction TRN1, executing on CICS/ESA System A, issues an EXEC CICS LINK to program PRG002, which resides on CICS/ESA System B. TRN1 "waits" while the LINK request is processed.

  2. The LINK implementation internally initiates a special mirror transaction on system B, using an APPC conversation.

  3. The mirror transaction runs the system program DFHMIR. It starts the user program PRG0002 and passes any input data to it. The mirror program uses APPC verbs to pass data to and from the user program.

  4. Upon completion, PRG0002 returns control to the mirror program which sends any return data back to PGM0001. PGM001 continues execution and may invoke multiple DPL requests using the same conversation and mirror program task.

  5. The conversation with the mirror program remains active and available to PGM0001 until a SYNCPOINT is issued. The conversation is used to coordinate the SYNCPOINT processing and is deallocated when the SYNCPOINT is complete.

Distributed Transaction Processing

Distributed Transaction Processing (DTP) is the only ISC services that provides for direct, application-to-application communications. DTP takes place between two conversation partners, both of which are normally user-written CICS/ESA applications. One conversation partner initiates a conversation with a counterpart on a remote system, and must explicitly identify the remote system. The conversation partner on the remote system must accept the requested conversation. Using the full capabilities of ISC, DTP applications send and receive application-defined data streams and engage in a series of application-defined interactions. See Figure 6-2 for a generic example of the DTP process.

Figure 6-2 Generic DTP Transaction

Step-by-Step Description: Generic DTP Transaction

  1. Transaction TRN1, invokes program PGM0001 executing on CICS/ESA System A.

  2. Program PGM0001 initiates (requests) a conversation with transaction TRN2, located on CICS/ESA System B, which in turn, invokes program PGM0002.

  3. Transaction TRN2, executing on CICS/ESA System B, invokes program PGM002.

  4. Program PGM0001 sends data to program PGM0002, then relinquishes control to PGM002.

  5. Program PGM0002 sends data to PGM0001, perhaps the response to the previous request. PGM0001 receives the data sent by PGM0002.

  6. PGM0001 and PGM0002 synchronize the data, acknowledge the conversation, and end the conversation.

DTP offers the best of two worlds. On one hand, it provides support for completely customized application protocol semantics. On the other hand, it allows the applications to select the desired level of support for resource recovery and restart:

DTP conversations are LUTYPE 6.2 conversations. They are a half-duplex form of data exchange between two transactions. It is half-duplex because only one side of the conversation can send data at a time. A conversation is initiated by the application using the Application Program-to-Program Communication (APPC) protocol. Because of this, the application must be coded to respect the various conversation states. These states are documented in the IBM CICS/ESA Intercommunication Guide and identify which APPC verbs are legal at the various stages of a conversation. LUTYPE 6.2 conversations can be mapped or unmapped conversations.

Unmapped or base-level conversation support is the minimum support level required for LUTYPE 6.2 product implementation. Mapped conversations are at a higher level than base conversations and do not require the application to be aware of the SNA data stream format. The state transitions are less restrictive and the command set is more robust. In addition to this, the application has access to CICS/ESA data areas to determine the status of the conversation and the results of certain APPC commands.

CICS/ESA Sync-Levels

In general, the synchronization level determines the cooperation between communicating partners needed to coordinate changes to their respective resources (such as files and databases). It also defines specific protocol flows required to support a requested synchronization level. The APPC architecture defines three distinct levels of synchronization. These three levels are Level 0, Level 1, and Level 2 (corresponding to the SNA-defined levels of NONE, CONFIRM, and SYNCPOINT, respectively).

Level 0 (NONE)

No synchronization at the protocol level is provided. This level is used when synchronization is not required or supported. This is very similar to non-transactional TUXEDO System service requests.

Level 1 (CONFIRM)

This level supports the exchange of private, application-level, synchronization requests between conversing partners. These partners, or applications, are totally responsible for defining and executing the synchronization process to ensure the integrity of all resources. The CICS/ESA system is not involved in the synchronization process at this level. There is no confirm capability in the TUXEDO System. Any CICS/ESA application attempting to initiate a sync-level 1 operation with TUXEDO causes an error condition.

Level 2 (SYNCPOINT)

At this level, the CICS/ESA system is fully involved in the synchronization process and provides complete, automatic support of sync-pointing, including rollback. The CICS/ESA system defines and coordinates the synchronization process and is responsible for ensuring the integrity of all CICS/ESA-managed resources.

In the case of DTP, the communicating applications participate in the synchronization process and are responsible for the management and integrity of any non-CICS/ESA resources to which they gain access.

Because DTP takes place between two application-level conversation partners, it may operate at any of the three defined synchronization levels. In other words, the conversation partners are permitted to specify the desired level of synchronization and participate in the synchronization process only to the extent specified.

If the user DTP conversation is at sync-level 0 or 1, the CICS/ESA system does not propagate sync-points from one system to another via the conversation. Thus the user can explicitly suspend CICS/ESA ACID Properties. A DTP conversation at sync-level 2 causes a CICS/ESA system to propagate sync-points automatically via the conversation as well as via subordinate conversations.

DPL can also operate at sync-level 1, in which case the user is responsible for maintaining the ACID properties. Sync-level 1 DPL conversations usually occur because one or both of the systems are incapable of operating at sync-level 2. The eLink SNA software can support DPL requests at both sync-levels 1 and 2, and can support DTP conversations at sync-levels 0 and 1.

Time-out and Error Handling

The /Domain's global timer is used to determine excessive time for a service request. If a time-out occurs, a FAILURE indication is raised and tperrno is set to TPETIME. The domain gateway cleans up any resources allocated to the failed communication.

The eLink SNA software sets tperrno values when an error occurs. Appendix B, "ATMI to CPI-C Function Mapping," describes the CPI-C return codes and their mapping to ATMI return codes.

Refer to Appendix D, "Error Messages," for error code listings.

Application-to-Application Programming

This section provides Transaction scenarios for the following programming environments supported by eLink SNA:

Distributed Program Link (DPL)

Using the eLink SNA gateway, BEA TUXEDO applications can make ATMI service calls to invoke programs running in a remote CICS/ESA DPL environment. CICS/ESA programs can in turn use the EXEC CICS LINK command to invoke user-defined BEA TUXEDO services. This feature is available to either new or existing CICS/ESA programs and BEA TUXEDO applications. DPL can only be used by BEA TUXEDO application domains connected to a CICS/ESA system.

Consider the program issuing the distributed link request or ATMI service request to be the Client program. Consider the executing remote program or service to be the Server program. The client does not have to be aware of the server's location.

BEA TUXEDO programs can use both the request/response and conversational models to invoke programs on the host. (However, request/response models are preferred.)

Local and remote services are defined with the FUNCTION=DPL option in the DM_LOCAL_SERVICES and DM_REMOTE_SERVICES section in the DMCONFIG file, indicating that the DPL ISC function is invoked.

Host DPL requests, in turn, can also be compared to BEA TUXEDO services using either call model. The request/response model is very similar to DPL. The conversational model, although supported in DTP, is less efficient and programmatically more complex than the request/response model. It is recommended that you use a DTP model when invoking conversational transactions.

It is also recommended you use a DPL model when invoking the same request/response or conversational request multiple times in a single transaction. With DPL, ISC starts a long-running mirror transaction to the CICS/ESA DPL server, enabling the server to process each of the requests over the same conversation. With DTP, each of the requests establishes a separate conversation with the server and the conversation remains outstanding until the transaction is committed.

Special Treatment of TRANSID for DPL

The eLink SNA software employs a special feature that enables BEA TUXEDO clients to invoke CICS/ESA server programs and, conversely, CICS/ESA client programs to invoke BEA TUXEDO services. Based on the IBM CICS/ESA mirror transaction, this feature facilitates DPL requests to/from a remote region. The feature is called Mirror Transaction Identifier Support and it involves special treatment of the transaction ID (TRANSID) that is part of every DPL request.

This subsection discusses DPL fundamentals related to this feature and describes how eLink SNA software does the following:

CICS/ESA Fundamentals Relating to Alternate Mirror TRANSID

In the CICS/ESA context, DPL requests are treated as mirror transactions, which include attachment of the server program to the requestor's TRANSID. Two scenarios are possible: implicit attachment (default) and explicit attachment.

When a server program receives a DPL request from a remote region, the mirror task services the request. The task attaches the request to a mirror transaction, typically CVMI for SYNCONRETURN requests or CSMI for transactional requests. The mirror task then attaches the appropriate mirror transaction to the requestor's TRANSID, found in the requestor's EIBTRNID field. This is implicit attachment (default).

Note: Implicit attachment of alternate mirror transaction identifier is not supported for inbound DPL requests to BEA TUXEDO services.

The other scenario is explicit attachment. The DPL requestor names the TRANSID that should be attached to the request instead of the default CSMI or CVMI.

For outbound requests from BEA TUXEDO domains to remote CICS/ESA regions, this TRANSID can be included in the API command (tpcall). The TRANSID must be defined in the program resource definition for the destination region and it must point to the mirror task DFHMIRS.

For inbound requests from a remote CICS/ESA region to a local BEA TUXEDO domain, the TRANSID is paired with a PROGRAM name to explicitly name an advertised service.

Implicit Attachment of TRANSID

Figure 6-3 depicts an implicit attachment using the requestor's TRANSID. The outbound tpcall invokes a service from the remote CICS/ESA region, but does not explicitly name a TRANSID. Instead, the TRANSID of the requestor is passed to the region as an invoking TRANSID. The mirror transaction (CSMI or CVMI) is attached and starts the mirror program, which attaches the requestor's TRANSID found in its EIBTRNID field. The mirror task then calls the application program.

Note: The eLink SNA software does not support implicit attachment of TRANSID to inbound requests for BEA TUXEDO services.

Figure 6-3 Implicit Attachment of TRANSID (Outbound Requests Only)

  1. The BEA TUXEDO service makes a request to the service TRN1DATA, which is advertised as a remote service in the DMCONFIG file. It is a DPL request to a program named SVC1 in the CICS/ESA region.

  2. The first four characters of the remote service tag name (TRN1) are extracted and passed to the CICS/ESA region as the invoking TRANSID. No CICS/ESA resource definition for the TRANSID is required in the region.

  3. The mirror transaction CSMI is attached in the CICS/ESA region, starting the mirror program DFHMIRS. The program performs the DTP requests for the service.

  4. The mirror program now attaches the invoking TRANSID (TRN1) and then invokes the application service program SVC1.The program can interrogate the EIBTRNID field to find this value.

Explicit Attachment of TRANSID

Explicit attachment names the TRANSID to be attached instead of the default mirror transaction, CSMI or CVMI. The client might use the explicit method for the following reasons:

Explicit attachment can be used for both outbound and inbound DPL requests. You can specify the TRANSID in the API command or in the RNAME parameter for the service definition in the DMCONFIG file.

The following example shows how to provide a TRANSID in the API command:

EXEC CICS LINK PROGRAM("SERVICE1")
SYSID("AIX1")
TRANSID("TRN1")

A TRANSID for an outbound DPL request is specified in the DM_REMOTE_SERVICES section of the DMCONFIG file. Conversely, a TRANSID for an inbound DPL request is specified in the DM_LOCAL_SERVICES section. The format for the TRANSID and server name in the DMCONFIG file entry is as follows:

RNAME=AAAA:BBBBBBBB

where:

AAAA
is a 1-4 character alternate mirror TRANSID

BBBBBBBB
is a 1-8 character CICS/ESA program name.

The colon is required to indicate the TRANSID/program name combination. The TRANSID must be composed of acceptable CICS/ESA characters:

A-Za-z0-9$@#./-_%&Q¢?!|"=,;<>

The following paragraphs discuss explicit attachment of TRANSID to both outbound requests for remote CICS/ESA services and to inbound requests for BEA TUXEDO services.

Outbound Requests

Figure 6-4 depicts the explicit attachment of the TRANSID to an outbound request for services in a remote CICS/ESA region. The TRANSID can be provided in the API command or in the remote-service definition in the DMCONFIG file. The RNAME value in the DMCONFIG file is used to create the alternate mirror ID and invoke the remote server.

The request passes the transaction ID of the mirror transaction to the remote CICS/ESA region. This transaction ID is defined in the remote region and must point to the mirror program DFHMIRS. When the mirror program invokes the application program, the transaction ID is passed to the program in the EIBTRNID field.

Figure 6-4 Explicit Attachment of TRANSID for Outbound Requests

  1. The BEA TUXEDO program makes a service request for SERVICE1, which is advertised as a remote service in the DMCONFIG file. The FUNCTION option indicates the remote service is invoked as a DPL.

  2. The request extracts TRN1 as an alternate mirror transaction ID for the remote region, along with the remote program name SERVICE1.

  3. The TRN1 ID is attached instead of the default mirror transaction, CSMI or CVMI. The TRN1 ID must be defined as a transaction resource in the remote region and must point to the mirror transaction program DFHMIRS.

  4. The mirror program DFMMIRS calls the server application program, passing the TRN1 ID in the EIBTRNID field.

Inbound Requests

Figure 6-5 depicts the explicit attachment of the TRANSID to inbound request for services in a BEA TUXEDO local domain. The TRANSID can be provided in the API command or in the local-service definition in the DMCONFIG file. The TRANSID named in the API command or in the requested program name must exactly match an RNAME in the DM_LOCAL_SERVICES section of the DMCONFIG file.

Figure 6-5 Explicit Attachment of TRANSID for Inbound Requests

  1. The CICS/ESA program makes a request to INSVC1, which is a local BEA TUXEDO service. The SYSID and PROGRAM values in the request identify the local system and the name of the local service. The TRANSID option indicates the mirror transaction to be initiated.

  2. The PROGRAM and mirror TRANSID are extracted from the DPL request. These are used to find an exact RNAME match in the DM_LOCAL_SERVICES section of the DMCONFIG file.

  3. The service SERVICE1, which is advertised locally in the BEA TUXEDO application, is initiated.

Explicit Attachment Usage Notes

You must enter the alternate mirror transaction and remote server name as RNAME values in both the DM_LOCAL_SERVICES and DM_REMOTE_SERVICES sections of the DMCONFIG file, using the format shown previously in the "Inbound Requests" section.

For outbound requests to a CICS/ESA server, the RNAME value in the DMCONFIG file is used to create the alternate mirror ID and invoke the remote server.

For inbound requests, the TRANSID named in the API command or in the PROGRAM definition is used along with the requested program name to exactly match an RNAME associated with a local service entry.

Note: If an RNAME is not found with both the transaction ID and the PROGRAM name, an error is returned to the CICS/ESA client.

Do not insert trailing spaces between the TRANSID and colon in the RNAME option. The eLink SNA software automatically discards trailing spaces before attempting to match RNAME values.

If the specified TRANSID/PROGRAM combination in a service name (either local or remote) is not a DPL, eLink SNA software returns an error which is not detected until run time.

Specifying the Size of a DPL Commarea

To translate a TUXEDO ATMI request to an EXEC CICS LINK request, the eLink SNA gateway uses the INBUFTYPE and OUTBUFTYPE of the remote service to create the COMMAREA for the DPL program.

For each remote service defined in the DMCONFIG file REMOTE_SERVICES section, INBUFTYPE is a description of the data that the service receives (the format of the request) and OUTBUFTYPE is a description of the data that the service sends as a response.

When a DPL program is invoked, it receives the request data in a COMMAREA. When the program completes, it returns this same COMMAREA to the program that invoked it. The DPL program cannot change the size of the COMMAREA; therefore, the COMMAREA must be large enough to hold both the request and the reply.

Before the gateway invokes a DPL program, it uses the INBUFTYPE and OUTBUFTYPE to calculate this size. Because CARRAY and STRING do not have sizes associated with them, the maximum size is used (4096 bytes).

Note: You cannot specify a response buffer in a tpcall or a tpacall for the purpose of sizing a COMMAREA. The gateway is unaware of the size of the response buffer that is specified in the tpcall, and in tpacall, the response buffer is not specified until the reply is retrieved with tpgetreply.

The best approach is to use VIEW types as the INBUFTYPE and OUTBUFTYPE of DPL programs. This allows the size of the request and response to be described in exact detail. Refer to the examples below:

Listing 6-3 Example of DMCONFIG File Entry Specifying VIEWS to Size the COMMAREA
*DM_REMOTE_SERVICES
SIMPDPLV AUTOTRAN=N
        LDOM="simpsnad"
        RDOM=SIMPSNAG
        CONV=N
        RNAME="TOUPDPLS"
        INBUFTYPE="VIEW:reqstr"
        OUTBUFTYPE="VIEW:respstr"
        FUNCTION="DPL

The following listing shows the corresponding view descriptions:

Listing 6-4 Descriptions of VIEWS for Sizing COMMAREA
VIEW reqstr
#TYPE   CNAME           FBNAME          COUNT   FLAG    SIZE    NULL
string  reqstring       -               1       -       20      " "
END
VIEW respstr
#TYPE   CNAME           FBNAME          COUNT   FLAG    SIZE    NULL
string  respstring       -               1       -       50      " "
END

The following listing shows the code used for a client that requests the SIMPDPLV application:

Listing 6-5 Program Using Views to Size COMMAREA
/* Include header file generated by views -n myviews.v */
#include "myviews.h"
sendbuf = (struct reqstr *) tpalloc("VIEW", "reqstr", sizeof(struct reqstr)); 
rcvbuf = (struct respstr *) tpalloc("VIEW", "respstr", sizeof(struct respstr)); 
tpcall("SIMPDPLV", (char *) sendbuf, 0,  (char **) &rcvbuf, &rcvlen, (long)0);

In the previous examples, the two VIEWs describe a request string of length 20 and a response string of length 50; therefore, the COMMAREA created can hold a string of 50 characters.

DPL Examples

The examples in this section represent a few of the many programming scenarios available for using DPL and BEA TUXEDO service invocations. These examples employ the most natural and efficient approaches.

Note: To run Transaction client/server scenarios, the eLink SNA software must be licensed for sync-level 2 operations.

(This page intentionally blank.)

Figure 6-6 TUXEDO Client Request/Response to CICS/ESA DPL

Step-by-Step Description: TUXEDO Client Request/Response to CICS/ESA DPL

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpcall for SIMPDPL, which is advertised in the DM_REMOTE_SERVICES section of the DMCONFIG file.

  3. Host mirror transaction starts TOUPDPLS program and passes idata buffer contents for processing.

  4. The TOUPDPLS program processes data.

  5. The CICS/ESA server returns the commarea into the client's odata buffer.

    Figure 6-7 TUXEDO Client Asynchronous Request/Response to CICS/ESA DPL

Step-by-Step Description: TUXEDO Client Asynchronous Request/Response to CICS/ESA DPL

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpacall for SIMPDPL, which is advertised in the DM_REMOTE_SERVICES section of DMCONFIG file.

  3. Host mirror transaction starts TOUPDPLS program and passes idata buffer contents for processing.

  4. The TOUPDPLS program processes data.

  5. The CICS/ESA system returns the commarea into the client's tpgetreply odata buffer.

    Figure 6-8 TUXEDO Client Asynchronous Request/Response with No Reply to CICS/ESA DPL

Step-by-Step Description: TUXEDO Client Asynchronous Request/Response with No Reply to CICS/ESA DPL

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpacall for SIMPDPL, which is advertised in the DM_REMOTE_SERVICES section of DMCONFIG file. The toupsrv service uses TPNOREPLY to specify that no reply is expected.

  3. Host mirror transaction starts TOUPDPLS program and passes idata buffer contents for processing.

  4. The TOUPDPLS program processes data.

    Figure 6-9 CICS/ESA DPL to TUXEDO Request/Response Server

Step-by-Step Description: CICS/ESA DPL to TUXEDO Request/Response Server

  1. User-entered HOPL invokes MIRRDPLC program.

  2. The EXEC CICS LINK command causes the advertised service mapped to MIRRDPLS (in the DM_LOCAL_SERVICES section of the DMCONFIG file) to execute.

  3. The MIRROR service processes the data received in the service TPSVCINFO data buffer from the EXEC CICS LINK.

  4. The tpreturn call returns the data into the COMM-AREA buffer.

    Figure 6-10 CICS/ESA DPL to TUXEDO Request/Response Server, Service in Autonomous Transaction

Step-by-Step Description: CICS/ESA DPL to TUXEDO Request/Response Server, Service in Autonomous Transaction

  1. User-entered H0PL invokes MIRRDPLC program.

  2. The EXEC CICS LINK command causes the advertised service mapped to MIRRDPLS (in the DM_LOCAL_SERVICES section of the DMCONFIG file) to execute. The SYNCONRETURN option indicates that the invoked service will not participate in the CICS/ESA transaction.

  3. The MIRROR service request tpbegin incorporates all further operations in a transaction.

  4. The MIRROR service processes the data.

  5. The tpcommit indicates the end of the transaction; all updates performed within the service transaction are to be committed.

  6. The tpreturn call returns the data into the commarea buffer.

  7. The EXEC CICS SYNCPOINT is an explicit commit request. All updated resources in the CICS/ESA transaction are committed.

    Figure 6-11 TUXEDO Client Request/Response to CICS/ESA DPL, in Autonomous Transaction

Step-by-Step Description: TUXEDO Client Request/Response to CICS/ESA DPL, in Autonomous Transaction

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpbegin to start the transaction.

  3. The toupsrv service issues tpcall for SIMPDPL, which is advertised in the DM_REMOTE_SERVICES section of the DMCONFIG file. The TPNOTRAN parameter indicates the CICS/ESA application does not participate in the service transaction.

  4. Host mirror transaction starts TOUPDPLS program and passes idata buffer contents for processing.

  5. The TOUPDPLS program processes data.

  6. The EXEC CICS SYNCPOINT is an explicit commit request. All updated resources in the CICS/ESA transaction are committed.

  7. The CICS/ESA server returns the commarea into the client's odata buffer.

  8. The toupsrv service tpcommit request signals the successful completion of the transaction, causing a commit of its own updated resources.

    Figure 6-12 Transactional TUXEDO Client Multiple Requests/Responses to CICS/ESA DPL

Step-by-Step Description: Transactional TUXEDO Client Multiple Requests/Responses to CICS/ESA DPL

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpbegin to start the transaction.

  3. The toupsrv service issues tpcall for SIMPDPL, which is advertised in the DM_REMOTE_SERVICES section of the DMCONFIG file. The tpcall is requested multiple times within the same transaction.

  4. Host mirror transaction starts TOUPDPLS program and passes idata buffer contents for processing. The host mirror transaction remains as a long-running task to service all further requests on the transaction.

  5. The TOUPDPLS program processes data.

  6. The CICS/ESA system returns the commarea into the client's odata buffer.

  7. Step 3 through Step 6 are repeated until the toupsrv service loop end conditions are met.

  8. The tpcommit request indicates the successful completion of the transaction, causing a commit of its own resources and the resources held by the host mirror transaction.

    Figure 6-13 Transactional CICS/ESA DPL to TUXEDO Request/Response Server

Step-by-Step Description: Transactional CICS/ESA DPL to TUXEDO Request/Response Server

  1. User-entered H2PL invokes MIRRDPLC program.

  2. The EXEC CICS LINK command causes the advertised service mapped to MIRRDPLS (in the DM_LOCAL_SERVICES section of the DMCONFIG file) to execute. The invoked service participates in the CICS/ESA transaction.

  3. The MIRROR service processes the data.

  4. The tpreturn call returns the data into the commarea buffer.

  5. The EXEC CICS SYNCPOINT is an explicit commit request indicating a successful end of the conversation. All updated resources in the transaction are committed.

    (This page intentionally blank.)

Distributed Transaction Processing (DTP)

The following examples represent a few programming scenarios for using DTP and BEA TUXEDO service invocations.

The recommended method of performing DTP services is to use BEA TUXEDO conversational services instead of request/response services. The conversational service enables a client and a server to communicate as needed over the eLink SNA session conversation.

Although it is most suited for the DPL environment, the tpcall is used in the examples for a request/response to a DTP server.

It is recommended you use a DPL model when invoking multiple request/response calls in a single transaction. With DPL, a long-running mirror transaction to the CICS/ESA DPL server is started, enabling the server to process each of the requests over the same conversation. With DTP, each of the ATMI requests will establish a separate conversation; the conversation remains outstanding until the transaction is committed.

The examples in this section represent a few of the many programming scenarios available for using DTP and BEA TUXEDO service invocations. These examples employ the most natural and efficient approaches.

Note: To run transactional client/server scenarios, the eLink SNA software must be licensed for sync-level 2 operations.

Figure 6-14 TUXEDO Client Request/Response to CICS/ESA DTP

Step-by-Step Description: TUXEDO Client Request/Response to CICS/ESA DTP

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpcall for SIMPDTP, which is advertised in the DM_REMOTE_SERVICES section of DMCONFIG file.

  3. User transaction DTPS starts TOUPDTPS program.

  4. It is recommended you save the eibtrmid to a program variable. This value may be used to identify the specific conversation in your CICS/ESA APPC verbs.

  5. The EXEC CICS RECEIVE command receives the idata buffer contents for processing.

  6. The TOUPDTPS program processes data.

  7. The EXEC CICS SEND command returns the OUT-BUFFER contents into the clients odata buffer. LAST indicates the conversation is finished. WAIT suspends processing until the data has successfully been received.

    Figure 6-15 TUXEDO Client Asynchronous Request/Response to CICS/ESA DTP

Step-by-Step Description: TUXEDO Client Asynchronous Request/Response to CICS/ESA DTP

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpacall for SIMPDTP, which is advertised in the DM_REMOTE_SERVICES section of the DMCONFIG file.

  3. User transaction DTPS starts TOUPDTPS program.

  4. It is recommended you save the EIBTRMID to a program variable. This value may be used to identify the specific conversation in your CICS/ESA APPC verbs.

  5. The EXEC CICS RECEIVE command receives the idata buffer contents for processing.

  6. The TOUPDTPS program processes data.

  7. The EXEC CICS SEND command returns the OUT-BUFFER contents into the clients tpgetreply odata buffer. LAST indicates the conversation is finished. WAIT suspends processing until the data has successfully been received.

    Figure 6-16 TUXEDO Client Asynchronous Request/Response with No Reply to CICS/ESA DTP

Step-by-Step Description: TUXEDO Client Asynchronous Request/Response with No Reply to CICS/ESA DTP

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpacall with a TPNOREPLY request for SIMPDTP, which is advertised in the DM_REMOTE_SERVICES section of DMCONFIG file.

  3. User transaction DTPS starts TOUPDTPS program.

  4. It is recommended you save the EIBTRMID to a program variable. This value may be used to identify the specific conversation on your CICS/ESA APPC verbs.

  5. The EXEC CICS RECEIVE command receives the idata buffer contents for processing.

  6. The TOUPDTPS program processes data.

    Figure 6-17 TUXEDO Conversational Client to CICS/ESA DTP, Server Gets Control

Step-by-Step Description: TUXEDO Conversational Client to CICS/ESA DTP, Server Gets Control

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpconnect for SIMPDTP, which is advertised in the DM_REMOTE_SERVICES section of DMCONFIG file. The TPRECVONLY flag indicates the server gets control and the first conversation verb toupsrv can issue is tprecv. Data is sent on the tpconnect in the idata buffer.

  3. User transaction DTPS starts TOUPDTPS program.

  4. It is recommended you save the EIBTRMID to a program variable. This value may be used to identify the specific conversation on your CICS/ESA APPC verbs.

  5. The EXEC CICS RECEIVE command receives the idata buffer contents for processing.

  6. The TOUPDTPS program processes data.

  7. The EXEC CICS SEND command returns the OUT-BUFFER contents into the clients tprecv odata buffer. WAIT suspends processing in TOUPDTPS until the data has successfully been received. LAST indicates the conversation is finished and is communicated to the tprecv as TPEV_SVCSUCC.

    Figure 6-18 TUXEDO Conversational Client to CICS/ESA DTP, Client Sends/Receives Data

Step-by-Step Description: TUXEDO Conversational Client to CICS/ESA DTP, Client Sends/Receives Data

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpconnect for SIMPDTP, which is advertised in the DM_REMOTE_SERVICES section of DMCONFIG file. The TPSENDONLY indicates the client retains control and continues to send data. Data is sent on the tpconnect in the idata buffer.

  3. User transaction DTPS starts TOUPDTPS program.

  4. It is recommended you save the EIBTRMID to a program variable. This value may be used to identify the specific conversation on your CICS/ESA APPC verbs.

  5. The EXEC CICS RECEIVE command receives the tpconnect idata buffer contents for processing.

  6. The TOUPDTPS program processes data.

  7. The EXEC CICS RECEIVE command receives the tpsend idata contents into the server's IN-BUFFER.

  8. The server processes the data.

  9. The EXEC CICS SEND WAIT LAST returns OUT-BUFFER data in the tprecv odata buffer, along with notification that the conversation is over.

    Figure 6-19 TUXEDO Conversational Client to CICS/ESA DTP, Client Grants Control

Step-by-Step Description: TUXEDO Conversational Client to CICS/ESA DTP, Client Grants Control

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpconnect for SIMPDTP, which is advertised in the DM_REMOTE_SERVICES section of DMCONFIG file. The TPRECVONLY indicates the server gets control and the first conversation verb toupsrv can issue is tprecv.

  3. User transaction DTPS starts TOUPDTPS program.

  4. It is recommended you save the EIBTRMID to a program variable. This value may be used to identify the specific conversation on your CICS/ESA APPC verbs.

  5. The EXEC CICS RECEIVE command receives a send state indicator from the tpconnect TPRECVONLY flag. No data is received into the INBUFFER.

  6. The EXEC CICS SEND command returns the OUT-BUFFER contents into the clients tprecv odata buffer. The EXEC CICS SEND command relinquishes control to the client by using the INVITE option. This is communicated to the tprecv as TPEV_SENDONLY.

  7. The EXEC CICS RECEIVE command receives the tpsend idata contents into the server's IN-BUFFER, along with notification that the server has relinquished control.

  8. The EXEC CICS RETURN ends the conversation, communicated to the tprecv as TPEV_SVCSUCC.

    Figure 6-20 CICS/ESA DTP to TUXEDO Conversational Server, Client Retains Control

Step-by-Step Description: CICS/ESA DTP to TUXEDO Conversational Server, Client Retains Control

  1. User-entered H0TP invokes MIRRDTPC program.

  2. The EXEC CICS ALLOCATE acquires a session to the remote BEA TUXEDO domain.

  3. Save the conversation ID returned in EIBRSRCE to a program variable. This value is used to identify the specific conversation in your CICS/ESA APPC verbs.

  4. The EXEC CICS CONNECT PROCESS command initiates the advertised service mapped to MIRROR in the DM_LOCAL_SERVICES section of the DMCONFIG file.

  5. Execute the EXEC CICS SEND command to send the contents of the OUT-BUFFER to the BEA TUXEDO service in the tpsvcinfo->data buffer. The contents might be sent immediately.

  6. The EXEC CICS SEND INVITE WAIT command sends out-buff contents into the tprecv odata buffer. The INVITE parameter relinquishes control of the conversation, seen as a TPEV_SENDONLY in the reevent parameter on the tprecv command. The data is sent immediately, along with the data from the previous SEND operation.

  7. The BEA TUXEDO service processes data.

  8. The CICS/ESA server processes data.

  9. The TUXEDO tpreturn data returns data to the EXEC CICS RECEIVE, along with notification that the conversation completed successfully.

    Figure 6-21 CICS/ESA DTP to TUXEDO Conversational Server, Client Relinquishes Control

Step-by-Step Description: CICS/ESA DTP to TUXEDO Conversational Server, Client Relinquishes Control

  1. User-entered HOTP invokes MIRRDTPC program.

  2. The EXEC CICS ALLOCATE acquires a session to the remote BEA TUXEDO domain.

  3. Save the conversation ID returned in EIBRSRCE to a program variable. This value is used to identify the specific conversation in your CICS/ESA APPC verbs.

  4. The EXEC CICS CONNECT PROCESS command initiates the advertised service mapped to MIRROR in the DM_LOCAL_SERVICES section of the DMCONFIG file.

  5. The EXEC CICS SEND command relinquishes control with the INVITE WAIT option.

  6. The EXEC CICS RECEIVE command receives the tpsend idata buffer contents into the IN-BUFFER.

  7. The tpreturn request tears down the conversation and indicates on the EXEC CICS RECEIVE that the conversation is over.

    Figure 6-22 Transactional TUXEDO Client Request/Response to CICS/ESA DTP

Step-by-Step Description: Transactional TUXEDO Client Request/Response to CICS/ESA DTP

Note: This is not the recommended method of performing a DTP transactional service. Please refer to the transactional DPL using request/response for the recommended method.

  1. TUXEDO client toupclt invokes toupsrv service. (Note that each tpcall made in the program must be bookended with a tpbegin and a tpcommit.)

  2. The service issues tpbegin to start a transaction.

  3. The toupsrv service issues tpcall for SIMPDTP, which is advertised in the DM_REMOTE_SERVICES section of the DMCONFIG file.

  4. User transaction DTPS starts TOUPDTPS program.

  5. Save the EIBTRMID to a program variable. This value is used to identify the specific conversation on your CICS/ESA APPC verbs.

  6. The EXEC CICS RECEIVE command receives the idata buffer contents for processing.

  7. The TOUPDTPS program processes data.

  8. The EXEC CICS SEND command returns the OUT-BUUFER contents into the clients odata buffer. CONFIRM indicates the conversation is finished. INVITE allows the client to respond with a COMMIT request.

  9. The toupsrv service issues tpcommit to end the transaction. The COMMIT is received on the EXEC CICS RECEIVE verb and the server issues EXEC CICS RETURN to commit the resources, terminate the transaction, and free the outstanding conversation.

    Figure 6-23 Transactional TUXEDO Conversational Client to CICS/ESA DTP, Server Gets Control

Step-by-Step Description: Transactional TUXEDO Conversational Client to CICS/ESA DTP, Server Gets Control

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpbegin to start the transaction.

  3. The toupsrv service issues tpconnect for SIMPDTP, which is advertised in the DM_REMOTE_SERVICES section of DMCONFIG file. The TPRECVONLY indicates the server gains control and the first conversation verb toupsrv can issue is tprecv. Data is sent on the tpconnect in the idata buffer.

  4. User transaction DTPS starts TOUPDTPS program.

  5. It is recommended you save the EIBTRMID to a program variable. This value may be used to identify the specific conversation on your CICS/ESA APPC verbs.

  6. The EXEC CICS RECEIVE command receives the idata buffer contents for processing.

  7. The TOUPDTPS program processes data.

  8. The EXEC CICS SEND command returns the OUT-BUFFER contents into the clients tprecv odata buffer. CONFIRM indicates that the conversation is finished and is communicated to the tprecv as TPEV_SVCSUCC. INVITE enables the client to respond with a COMMIT request.

  9. The toupsrv service issues tpcommit to end the transaction. The COMMIT is received on the EXEC CICS RECEIVE verb and the server issues EXEC CICS RETURN to commit the resources, terminate the transaction, and free the outstanding conversation.

    Figure 6-24 Transactional CICS/ESA DTP to TUXEDO Conversational Server, Host Client Relinquishes Control

Step-by-Step Description: CICS/ESA DTP to Transactional TUXEDO Conversational Server, Host Client Relinquishes Control

  1. User-entered H2TP invokes MIRRDTPC program.

  2. The EXEC CICS ALLOCATE acquires a session to the remote BEA TUXEDO domain.

  3. Save the conversation ID returned in EIBRSRCE to a program variable. This value is used to identify the specific conversation on your CICS/ESA APPC verbs.

  4. The EXEC CICS CONNECT PROCESS command initiates the advertised service mapped to MIRRDTPS. The SYNCLEVEL(2) parameter indicates the inclusion of the TUXEDO service in the CICS/ESA transaction.

  5. The EXEC CICS SEND INVITE WAIT command causes the client to immediately relinquish control to the BEA TUXEDO server. This is communicated to the service in TPSVCINFO as TPSENDONLY. No data is sent to the server on this request.

  6. The EXEC CICS RECEIVE command receives the tpsend idata buffer contents into the IN-BUFFER. The EXEC CICS RECEIVE command receives a confirm request indicating the conversation should be terminated.

  7. The EXEC CICS ISSUE CONFIRMATION verb responds positively to the confirm request.

  8. The EXEC CICS SYNCPOINT is an explicit commit request to end the conversation and update all resources in the transaction.

  9. The EXEC CICS FREE verb explicitly frees the outstanding conversation.

    (This page intentionally blank.)

CPI-C Programming

The Common Programming Interface for Communications (CPI-C) is an implementation choice for program-to-program communications. The reason that CPI-C may be used over other implementations is that CPI-C defines a single programming interface to the underlying network protocols across many different programming languages and environments.

Also, you can use the CPI Resource Recovery interface to provide a consistent interface to system services that allow your programs to coordinate data exchange and updates of databases and resources.

The examples in this section show the protocol exchanges between the local BEA TUXEDO and remote host application program. With BEA TUXEDO, the type of ATMI service request determines the nature of the client/server communication model. For requests initiated by the host application, the configuration information for the local service determines the protocol exchanges on the conversation.

The recommended method of performing APPC services is to use BEA TUXEDO conversational services instead of request/response services. The conversational service enables a client and a server to communicate as needed over the eLink SNA session conversation.

Although it is most suited for the DPL environment, the tpcall is used in the examples for a request/response to an APPC server.

It is recommended you use a DPL model when invoking multiple request/response calls in a single transaction. With DPL, a long-running mirror transaction to the CICS/ESA DPL server is started, enabling the server to process each of the requests over the same conversation. With APPC, each of the ATMI requests will establish a separate conversation; the conversation remains outstanding until the transaction is committed.

The examples in this section represent a few of the many programming scenarios available for using CPI-C and BEA TUXEDO service invocations. These examples employ the most natural and efficient approaches.

Note: To run transactional client/server scenarios or the CPI Resource Recovery interface, the eLink SNA software must be licensed for sync-level 2 operations.

Figure 6-25 TUXEDO Client Request/Response to Host CPI-C

Step-by-Step Description: TUXEDO Client Request/Response to Host CPI-C

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpcall for SIMPCPIC, which is advertised in the DM_REMOTE_SERVICES section of the DMCONFIG file.

  3. The remote service with the tpname TPNCPIC invokes TOUPCPIC program.

  4. The server accepts the conversation with the cmaccp call. The conversation id returned on the request in convid is used for all other requests on this conversation.

  5. The cmrcv request receives the idata buffer contents for processing

  6. The TOUPCPIC program processes data.

  7. The cmsst request prepares the next send request by setting the send type to CM_SEND_AND_DEALLOCATE.

  8. The cmsend request returns the obuffer contents into the client odata buffer. The buffer is flushed, and the conversation ended.

    Figure 6-26 TUXEDO Client Asynchronous Request/Response to Host CPI-C

Step-by-Step Description: TUXEDO Client Asynchronous Request/Response to Host CPI-C

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpacall for SIMPCPIC, which is advertised in the DM_REMOTE_SERVICES section of the DMCONFIG file.

  3. The remote service with tpname TPNCPIC invokes TOUPCPIC program.

  4. The server accepts the conversation with the cmaccp call. The conversation id returned on the request in convid is used for all other requests on this conversation.

  5. The cmrcv request receives the idata buffer contents for processing.

  6. The TOUPCPIC program processes data.

  7. The cmsend command returns the obuffer contents into the client tpgetreply odata buffer. The data may not be immediately sent to the tpgetreply odata buffer on this request.

  8. The cmdeal flushes the data to the client, and indicates the conversation is finished.

    Figure 6-27 TUXEDO Client Asynchronous Request/Response to Host CPI-C with No Reply

Step-by-Step Description: TUXEDO Client Asynchronous Request/Response to Host with No Reply

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpacall with a TPNOREPLY request for SIMPCPIC, which is advertised in the DM_REMOTE_SERVICES section of the DMCONFIG file.

  3. The remote service with tpname TPNCPIC invokes TOUPCPIC program.

  4. The server accepts the conversation with the cmaccp call. The conversation id returned on the request in convid is used for all other requests on this conversation.

  5. The cmrcv request receives the idata buffer contents for processing, and notification that the conversation has ended with the return code value of CM_DEALLOCATED_NORMAL.

  6. The TOUPCPIC program processes data.

    Figure 6-28 TUXEDO Conversational Client to Host CPI-C, Server Gets Control

Step-by-Step Description: TUXEDO Conversational Client to Host CPI-C, Server Gets Control

  1. TUXEDO client invokes toupsrv service

  2. The toupsrv service issues tpconnect for SIMPCPIC, which is advertised in the DM_REMOTE_SERVICES section of the DMCONFIG file. The TPRECVONLY indicates the server gains control and the first conversation verb the toupsrv can issue is tprecv. Data is sent on the tpconnect in the idata buffer.

  3. The remote service with tpname TPNCPIC invokes TOUPCPIC program.

  4. The server accepts the conversation with the cmaccp call. The conversation ID returned on the request in convid is used for all other requests on this conversation.

  5. The cmrcv request receives the idata buffer contents for processing.

  6. The TOUPCPIC program processes data

  7. The cmsst request prepares the next send request by setting the send type to CM_SEND_AND_FLUSH.

  8. The cmsend command returns the obuffer contents into the client tprecv odata buffer. The data is immediately flushed on the send request.

  9. The cmdeal request ends the conversation.

    Figure 6-29 TUXEDO Conversational Client To Host CPI-C, Client Retains Control

Step-by-Step Description: TUXEDO Conversational Client to Host CPI-C, Client Retains Control

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpconnect for SIMPCPIC, which is advertised in the DM_REMOTE_SERVICES section of the DMCONFIG file. The TPSENDONLY indicates the client retains control and continues to send data. No data is sent with the tpconnect.

  3. The remote service with tpname TPNCPIC invokes TOUPCPIC program.

  4. The server accepts the conversation with the cmaccp call. The conversation id returned on the request in convid is used for all other requests on this conversation.

  5. The cmrcv request receives the tpsend idata buffer contents for processing. The conversation is relinquished with the TPRECVONLY flag.

  6. The TOUPCPIC program processes data.

  7. The cmsend returns a response in the tprecv idata buffer, along with notification from the cmdeal command that the conversation is over. The cmdeal flushes the data buffer and the tprecv reevent parameter is set to TPEV_SUCCESS.

    Figure 6-30 TUXEDO Conversational Client to Host CPI-C, Client Grants/gets Control

Step-by-Step Description: TUXEDO Conversational Client to Host CPI-C, Client Grants/Gets Control

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpconnect for SIMPCPIC, which is advertised in the DM_REMOTE_SERVICES section of the DMCONFIG file. The TPRECVONLY indicates the server gains control and the first conversation verb the toupsrv can issue is tprecv.

  3. The remote service with tpname TPNCPIC invokes TOUPCPIC program.

  4. The server accepts the conversation with the cmaccp request. The conversation id returned on the request in convid is used for all other requests on this conversation.

  5. The cmrcv requests receives the indicator that control has been granted to the server.

  6. The cmsend request returns its obuffer contents into the first client tprecv odata buffer. The data may not immediately be sent.

  7. The cmsend request returns its obuffer contents into the second client tprecv odata buffer. The data may not immediately be sent.

  8. The cmptr request flushes the data to the client, and grants control to the client.

  9. The cmrcv request receives the tpsend idata buffer contents for processing. The TPRECVONLY is passed to the tprecv, relinquishing control of the conversation.

  10. The cmdeal indicates a successful completion of the conversation to the tprecv; no data is passed.

    Figure 6-31 Host CPI-C to TUXEDO Asynchronous Request/Response Server with No Reply

Step-by-Step Description: Host CPI-C to TUXEDO Asynchronous Request/Response Server with No Reply

  1. The CPI-C application program MIRRCPIC is invoked using environment start-up specifications.

  2. The MIRRCPIC client requests cminit to establish conversation attributes and receive a conversation ID that will be used on all other requests on this conversation. The remote server and service are named in the CPI-C side information entry MIRRSIDE.

  3. The cmallc request initiates the advertised service mapped to MIRRORSERV in the DM_LOCAL_SERVICES section of the DMCONFIG file.

  4. The cmsend request sends the contents of obuffer to the TUXEDO service in the tpsvcinfo->data buffer.

  5. The cmdeal request flushes the data, and indicates the conversation is finished with the TPNOREPLY in the tpsvcinfo->flag field.

  6. The service completes with the tpreturn.

    Figure 6-32 Host CPI-C to TUXEDO Server Request/Response

Step-by-Step Description: HOST CPI-C to TUXEDO Server Request/Response

  1. The CPI-C application program MIRRCPIC is invoked using environment start-up specifications.

  2. The MIRRCPIC client requests cminit to establish conversation attributes and receive a conversation id that will be used on all other requests on this conversation. The remote server and service are named in the CPI-C side information entry MIRRSIDE.

  3. The cmallc request initiates the advertised service mapped to MIRRORSERV in the DM_LOCAL_SERVICES section of the DMCONFIG file.

  4. The cmsst request prepares the next send request by setting the send type to CM_SEND_AND_PREP_TO_RECEIVE.

  5. The cmsend request immediately sends the contents of obuffer to the TUXEDO service in the tpsvcinfo->data buffer and relinquishes control to the mirrorserv service.

  6. The cmrcv request receives the contents of the odata returned on the TUXEDO tpreturn service, and notification that the conversation has ended with the return code value of CM_DEALLOCATED_NORMAL.

    Figure 6-33 Host CPI-C to TUXEDO Conversational Service, Client Retains Control

Step-by-Step Description: Host CPI-C to TUXEDO Conversational Service, Client Retains Control

  1. The CPI-C application program MIRRCPIC is invoked using environment start-up specifications.

  2. The MIRRCPIC client requests cminit to establish conversation attributes and receive a conversation id that will be used on all other requests on this conversation. The remote server and service are named in the CPI-C side information entry MIRRSIDE.

  3. The cmallc request initiates the advertised service mapped to MIRRORSERV in the DM_LOCAL_SERVICES section of the DMCONFIG file.

  4. The cmsend request sends the contents of obuffer to the TUXEDO service in the tpsvcinfo->data buffer.

  5. The cmdeal request flushes the data and ends the conversation, as indicated by TPNOREPLY in the tpsvcinfo->flag field.

    Figure 6-34 Host CPI-C TUXEDO to Conversational Service, Client Grants Control

Step-by-Step Description: TUXEDO Conversational Service, Client Grants Control

  1. The CPI-C application program MIRRCPIC is invoked using environment start-up specifications.

  2. The MIRRCPIC client requests cminit to establish conversation attributes and receive a conversation ID that will be used on all other requests on this conversation. The remote server and service are named in the CPI-C side information entry MIRRSIDE.

  3. The cmallc request initiates the advertised service mapped to MIRROR in the DM_LOCAL_SERVICES section of the DMCONFIG file.

  4. The cmptr relinquishes control of the conversation to the TUXEDO service indicated as TPSENDONLY in the tpsvcinfo->flag field. No data is passed in the tpsvcinfo->data field.

  5. The cmrcv receives the contents of the tpsend odata into the ibuffer. The end of the conversation is passed from the tpreturn service as return code value CM_DEALLOCATED_NORMAL.

    Figure 6-35 Transactional TUXEDO Client Request/Response to Host CPI-C

Step-by-Step Description: Transactional TUXEDO Client Request/Response to Host CPI-C

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpbegin to start the transaction.

  3. The toupsrv service issues tpcall for SIMPCPIC, which is advertised in the DM_REMOTE_SERVICES section of the DMCONFIG file. Data is sent from the idata buffer on the tpconnect.

  4. The remote service with tpname TPNCPIC invokes TOUPCPIC program.

  5. The server accepts the conversation with the cmaccp call. The conversation ID returned on the request in convid is used for all other requests during this conversation.

  6. The cmrcv request receives the idata buffer contents for processing.

  7. The cmsst and cmsptr prepare the next send request by setting the send type to CM_SEND_AND_PREP_TO_RECEIVE and by setting the prepare-to-receive type to CM_PREP_TO_RECEIVE_CONFIRM.

  8. The cmsend request immediately returns the obuffer contents into the client's odata buffer. The server relinquishes control to the server and indicates the end of the conversation with the CONFIRM request.

  9. The toupsrv issues the tpcommit to successfully complete the transaction and commit all updated resources. The cmrcv request receives the commit request, and responds explicitly to the request with the SAA Resource/Recovery commit call srrcmit. The conversation is ended after the successful commit exchange.

    Figure 6-36 Transactional TUXEDO Conversational Client to Host CPI-C, Server Gets Control

Step-by-Step Description: Transactional TUXEDO Conversational Client to Host CPI-C, Server Gets Control

  1. TUXEDO client invokes toupsrv service.

  2. The toupsrv service issues tpbegin to start the transaction.

  3. The toupsrv service issues a tpconnect service request for SIMPCPIC, which is advertised in the DM_REMOTE_SERVICES section of the DMCONFIG file. Data is sent in the idata buffer on the tpconnect.

  4. The remote service with tpname TPNCPIC invokes TOUPCPIC program.

  5. The server accepts the conversation with the cmaccp call. The conversation ID returned on the request in convid is used for all other requests during this conversation.

  6. The cmrcv request receives the idata buffer contents sent on the tpconnect for processing.

  7. The TOUPCPIC program processes the data.

  8. The cmsend returns the obuffer contents into the client's tprecv odata buffer. The buffer contents may not be sent immediately.

  9. The cmsptr prepares the prepare-to-receive request with CM_PREP_TO_RECEIVE_CONFIRM. The cmptr request with CONFIRM indicates that the conversation is finished and is communicated to the tprecv as TPEV_SVCSUCC.

  10. The toupsrv issues the tpcommit to successfully complete the transaction and commit all updated resources. The cmrcv request receives the commit request and responds explicitly to the request with the SAA Resource/Recovery commit call srrcmit. The conversation is ended after the successful commit exchange.

    Figure 6-37 Transactional Host CPI-C to TUXEDO Conversational Server, Client Grants Control

Step-by-Step Description: Transactional Host CPI-C to TUXEDO Conversational Server, Client Grants Control

  1. The CPI-C application program MIRRCPIC is invoked using environment start-up specifications.

  2. The MIRRCPIC client requests cminit to establish conversation attributes and receive a conversation ID that will be used on all other requests on this conversation. The remote server and service are named in the CPI-C side information entry MIRRSIDE.

  3. The cmssl sets the conversation attributes to sync-level 2 with CM_SYNCPOINT. This allows the TUXEDO service to participate in the transaction.

  4. The cmallc request initiates the advertised service mapped to MIRRORSERV in the DM_LOCAL_SERVICES section of the DMCONFIG file.

  5. The MIRRCPIC causes the client to relinquish control to the TUXEDO server with a prepare-to-receive request. The cmsptr sets the prepare-to-receive type to CM_RECEIVE_AND_FLUSH. The cmptr request immediately relinquishes control.

  6. The MIRROR service sends the data contents of the odata buffer to the cmrcv ibuffer. The cmrcv receives a confirm request from the server indicating the conversation should be terminated.

  7. The client replies positively to the confirm request with cmcfmd.

  8. The MIRRCPIC client prepares to free the conversation with the cmdeal request. The conversation in CM_DEALLOCATE_SYNC_LEVEL commits all updated resources in the transaction and waits for the SAA resource recovery verb, srrcmit. After the commit sequence has completed, the conversation terminates.

Where to Find Additional Information

Additional information on the subject of CICS/ESA Intersystem Communications may be found in the following IBM publications:


Copyright © 1999 BEA Systems, Inc. All Rights Reserved.
Required browser version: Netscape Communicator version 4.0 or higher, or Microsoft Internet Explorer version 4.0 or higher.
Last update: May 28, 1999.