Version 9.5 SP1
 —  ACI for COBOL  —

EntireX Broker ACI for COBOL

ACI-based programming is the base technology of EntireX. It uses a traditional Application Programming Interface (API) approach for conducting client/server and peer-to-peer dialog between distributed processes.

This document describes the EntireX Broker ACI from the perspective of the programming language COBOL and covers the following topics:


Call Format

Calls to EntireX Broker use the following arguments:

  1. The ACI control block is the first argument.

  2. The send buffer is the second argument.

  3. The receive buffer is the third argument.

  4. The error text buffer is the last argument. It can provide a short text of the error code, if desired. Sufficient buffer length must be supplied to allow the standard 40-byte long message to be returned by EntireX Broker. For ACI version 9 and above, the error text buffer can be greater than 40 bytes as specified in the ACI field ERRTEXT-LENGTH.

The send buffer and the receive buffer must always be provided. If they are not required by the selected EntireX Broker function, you can define them as PIC X(1) fields.

The API is called with a statement such as the following:

If 00000000 (zeros) are returned in the ERROR-CODE field in the EntireX Broker control block, the operation has been performed successfully. However, function results other than 00000000 (zeros) do not necessarily indicate an error. See Error Handling for client and server | publish and subscribe.

Top of page

Broker ACI Control Block Layout

The following table shows the Broker fields in order of the physical layout of the Broker ACI control block and provides a brief description of each field. The fields are described in more detail under Broker ACI Fields. See the actual copybook for COBOL in Broker ACI Control Block Copybook below.

Note:
Header files and examples are provided as models if you want to write your own ACI appliations (see ACI Examples and Copybooks for location). The list below does not include unused fields that are for internal purposes only. Check the included header files for the full layout.

Broker ACI Field COBOL Definition Description /
Related Information
API
Vers.
Notes
API-TYPE ETBCB-TYPE PIC X API type. See API-TYPE and API-VERSION for client and server | publish and subscribe. 1  
API-VERSION ETBCB-VERSION PIC X API version. 1  
FUNCTION ETBCB-FUNCTION PIC X See Broker ACI Functions to perform Broker function. 1  
OPTION ETBCB-OPTION PIC X See OPTION. 1  
  RESERVED PIC X(16) Reserved for future use. 1 1
SEND-LENGTH SEND-LENGTH PIC 9(9) COMP Send length. See Using Send and Receive Buffers for client and server | publish and subscribe. 1  
RECEIVE-LENGTH RECEIVE-LENGTH PIC 9(9) COMP Receive length. 1  
RETURN-LENGTH RETURN-LENGTH PIC 9(9) COMP Return length. 1  
ERRTEXT-LENGTH ERRTEXT-LENGTH PIC 9(9) COMP Error text length. 1  
BROKER-ID BROKER-ID PIC X(32) Broker ID. See Using the Broker ID in Applications. 1  
SERVER-CLASS
SERVER-NAME
SERVICE
SERVER-CLASS PIC X(32)
SERVER-NAME PIC X(32)
SERVICE-NAME PIC X(32)
Service. See Control Block Fields and Verbs. 1 3, 5
USER-ID USER-ID PIC X(32) User ID. See USER-ID and TOKEN for client and server | publish and subscribe. 1  
PASSWORD PASSWD PIC X(32) Password. See Authentication. 1 4,5
TOKEN TOKEN PIC X(32) Reconnection token. See USER-ID and TOKEN for client and server | publish and subscribe. 1 3, 5
SECURITY-TOKEN SECURITY-TOKEN PIC X(32) Security token. See Writing Applications using EntireX Security. 1 4, 5
CONV-ID CONV-ID PIC X(16) Conversation ID. See Conversational and Non-conversational Mode. 1 3, 5
WAIT WAIT-TIMEOUT PIC X(8) Wait value. See Blocked and Non-blocked Broker Calls for client and server | publish and subscribe. 1 3, 5
ERROR-CODE ERROR-CODE PIC X(8) Error code. See Error Handling for client and server | publish and subscribe. 1  
ENVIRONMENT ENVIRONMNT PIC X(32) Environment. See Using Internationalization for client and server | publish and subscribe. 1 3, 5
ADCOUNT ADCOUNT PIC 9(9) COMP Attempted delivery count. See Writing Applications: Units of Work. 2  
USER-DATA USER-DATA PIC X(16) Conversation User Data. See Managing Conversation Contexts. 2 3, 5
Not used. MESSAGE-ID PIC X(32) Message ID. 2 4, 5
Not used. MESSAGE-TYPE PIC X(16) Message type. 2 3, 5
  LIFE-TIME PIC X(8) Reserved for future use. 2 1, 3, 5
NEWPASSWORD NEW-PASSWD PIC X(32) New password. See Authentication. 2 4, 5
Not used. ADAPTER-ERROR PIC X(8) Adapter error. 2  
CLIENT-UID CLIENT-USER-ID PIC X(32) Client User ID. See Client User ID. 2  
CONV-STAT CONVSTAT PIC X(1) Conversation status. See Conversational and Non-conversational Mode. 2  
STORE STORE PIC X(1) Persistence or non-persistence of a UOW. See Writing Applications: Units of Work. 2  
  STATUS PIC X(1) Reserved for future use. 2 1
UOWSTATUS UOWSTATUS PIC X(1) UOW Status. See Writing Applications: Units of Work. 3 3, 5
UWTIME UOWTIME PIC X(8) UOW lifetime. 3 3, 5
UOWID UOWID PIC X(16) UOW unique identifier. 3 3, 5
USTATUS USERSTATUS PIC X(32) User status. 3  
UOW-STATUS-PERSIST UOWSTATUSPER PIC X(1) Multiplier for persistent status lifetime. See Writing Applications: Units of Work. 3 2
  RESVD2 PIC X(3) Reserved for future use. 3 1
LOCALE-STRING LOCALE-STR PIC X(40) Locale string. To be used to override or provide codepages. See Using Internationalization for client and server | publish and subscribe. 4  
DATA-ARCH DATA-ARCH PIC X(1) Data architecture. See ICU Conversion. 4 2
FORCE-LOGON FORCE-LOGON PIC X(1) Override Broke AUTOLOGON. See Authentication. 6  
ENCRYPTION-LEVEL ENC-LEVEL PIC X(1) Encryption level. See Encryption under Writing Applications using EntireX Security. 6 2
KERNELSECURITY KERSEC PIC X(1) Kernel security. See Writing Applications using EntireX Security 7  
COMMITTIME COMMTIME PIC X(17) Commit time. See Writing Applications: Units of Work. 7  
COMPRESSLEVEL COMPLVL PIC X(1) Compression level.
See Data Compression for client and server | publish and subscribe.
7  
  RESVD3 PIC X(2) Reserved for future use. 7 1
  RESVD4 PIC 9(9) COMP Reserved for future use. 7 1
UWSTAT-LIFETIME UWSTAT-LIFETIME PIC X(8) Add value for persistent status lifetime. See UWSTAT-LIFETIME. 8  
TOPIC TOPIC PIC X(96) Topic name for publish and subscribe. See Key ACI Field Names. 8  
PUBLICATION-ID PUBLICATION-ID PIC X(16) Publication ID for publish and subscribe. 8  
CLIENT-ID CLIENT-ID PIC 9(9) Returns to a server application the unique instance number of a client application. It is returned on receipt of a message (RECEIVE or SEND with WAIT). 9  
LOG-COMMAND LOG-COMMAND PIC X(1) Log the current command. See also Programmatically Turning on Command Logging for client and server | publish and subscribe. 9  
CREDENTIALS-TYPE CRED-TYPE PIC X(1) Indicates the credentials type to be used to authenticate a user. The default is to use user ID and password. Enter "1" to specify IAF authentication. See also IAF Authentication for client and server | publish and subscribe. 9  
VARLIST-OFFSET VAR-LIST-OFF PIC 9(9) Internal Software AG field. 10  
LONG-BROKER-ID-LENGTH LONG-BID-LEN PIC 9(9) See LONG-BROKER-ID-LENGTH. 10  

Notes:

  1. Reserved for future use.
  2. You must set this field to a LOW VALUE (X'00') if you do not intend to use it.
  3. The field is transmitted up to the first blank or LOW VALUE (X'00'). It is not transmitted if the first character is a blank or a LOW VALUE (X'00').
  4. All trailing LOW VALUES (X'00') are truncated. The field is not transmitted if the entire field is a LOW VALUE (X'00').
  5. If fields are not needed for a specific command function, suppress their transmission by initializing them to blanks or LOW VALUE (X'00').

Top of page

Broker ACI Control Block Copybook

The Developer's Kit provides a copybook with the ACI control block definition. See ACI Examples and Copybooks for where it is provided on your platform:

      ******************************************************************
      * Product        : EntireX Broker
      * Copyright      : (c) Copyright Software AG 1997 - 2012.
      *                  All rights reserved.
      * Version        : 9.0
      * File Version   : $Revision: 1.1 $
      * File           : COBDEF
      * Description    : COBOL ACI control block definitions.
      ******************************************************************
      * Note: When an option value is used it must be added to the
      * previous assigned function value.
      ******************************************************************
      *
      * --- ENTIRE BROKER API Type Constants ---------------------------
      *
       01  TYPE-1             PIC 9(4)  BINARY VALUE 256.
      *
      * --- ENTIRE BROKER API Version Constants ------------------------
      *
       01  VERSION-1          PIC 9(4)  BINARY VALUE 1.
       01  VERSION-2          PIC 9(4)  BINARY VALUE 2.
       01  VERSION-3          PIC 9(4)  BINARY VALUE 3.
       01  VERSION-4          PIC 9(4)  BINARY VALUE 4.
       01  VERSION-5          PIC 9(4)  BINARY VALUE 5.
       01  VERSION-6          PIC 9(4)  BINARY VALUE 6.
       01  VERSION-7          PIC 9(4)  BINARY VALUE 7.
       01  VERSION-8          PIC 9(4)  BINARY VALUE 8.
       01  VERSION-9          PIC 9(4)  BINARY VALUE 9.
       01  VERSION-10         PIC 9(4)  BINARY VALUE 10.
      *
      * --- ENTIRE BROKER API Function Constants -----------------------
      *
       01  FCT-SEND                PIC 9(4)  BINARY VALUE 256.
       01  FCT-RECEIVE             PIC 9(4)  BINARY VALUE 512.
       01  FCT-UNDO                PIC 9(4)  BINARY VALUE 1024.
       01  FCT-EOC                 PIC 9(4)  BINARY VALUE 1280.
       01  FCT-REGISTER            PIC 9(4)  BINARY VALUE 1536.
       01  FCT-DEREGISTER          PIC 9(4)  BINARY VALUE 1792.
       01  FCT-VERSION             PIC 9(4)  BINARY VALUE 2048.
       01  FCT-LOGON               PIC 9(4)  BINARY VALUE 2304.
       01  FCT-LOGOFF              PIC 9(4)  BINARY VALUE 2560.
       01  FCT-SET                 PIC 9(4)  BINARY VALUE 2816.
       01  FCT-GET                 PIC 9(4)  BINARY VALUE 3072.
       01  FCT-SYNC                PIC 9(4)  BINARY VALUE 3328.
       01  FCT-KERNELVERS          PIC 9(4)  BINARY VALUE 3584.
       01  FCT-LOCTRANS            PIC 9(4)  BINARY VALUE 3840.
       01  FCT-SETSSLPARMS         PIC 9(4)  BINARY VALUE 4096.
       01  FCT-SEND-PUBLICATION    PIC 9(4)  BINARY VALUE 4352.
       01  FCT-RECEIVE-PUBLICATION PIC 9(4)  BINARY VALUE 4608.
       01  FCT-SUBSCRIBE           PIC 9(4)  BINARY VALUE 4864.
       01  FCT-UNSUBSCRIBE         PIC 9(4)  BINARY VALUE 5120.
       01  FCT-CONTROL-PUBLICATION PIC 9(4)  BINARY VALUE 5376.
       01  FCT-REPLY-ERROR         PIC 9(4)  BINARY VALUE 5632.
      *
      * --- ENTIRE BROKER API Option Constants -------------------------
      *
       01  OPT-MSG            PIC 9(4)  BINARY VALUE 1.
       01  OPT-HOLD           PIC 9(4)  BINARY VALUE 2.
       01  OPT-IMMED          PIC 9(4)  BINARY VALUE 3.
       01  OPT-QUIESCE        PIC 9(4)  BINARY VALUE 4.
       01  OPT-EOC            PIC 9(4)  BINARY VALUE 5.
       01  OPT-CANCEL         PIC 9(4)  BINARY VALUE 6.
       01  OPT-LAST           PIC 9(4)  BINARY VALUE 7.
       01  OPT-NEXT           PIC 9(4)  BINARY VALUE 8.
       01  OPT-PREVIEW        PIC 9(4)  BINARY VALUE 9.
       01  OPT-COMMIT         PIC 9(4)  BINARY VALUE 10.
       01  OPT-BACKOUT        PIC 9(4)  BINARY VALUE 11.
       01  OPT-SYNCPOINT      PIC 9(4)  BINARY VALUE 12.
       01  OPT-ATTACH         PIC 9(4)  BINARY VALUE 13.
       01  OPT-DELETE         PIC 9(4)  BINARY VALUE 14.
       01  OPT-EOCCANCEL      PIC 9(4)  BINARY VALUE 15.
       01  OPT-QUERY          PIC 9(4)  BINARY VALUE 16.
       01  OPT-SETUSTATUS     PIC 9(4)  BINARY VALUE 17.
       01  OPT-ANY            PIC 9(4)  BINARY VALUE 18.
       01  OPT-TERMINATE      PIC 9(4)  BINARY VALUE 19.
       01  OPT-DURABLE        PIC 9(4)  BINARY VALUE 20.
       01  OPT-CHECKSERVICE   PIC 9(4)  BINARY VALUE 21.
      *
      * --- ENTIRE BROKER API Conversation Status Constants ------------
      *
       01  CNV-NEW            PIC 9(4)  BINARY VALUE 256.
       01  CNV-OLD            PIC 9(4)  BINARY VALUE 512.
       01  CNV-NONE           PIC 9(4)  BINARY VALUE 768.
      *
      * --- ENTIRE BROKER API Store Constants --------------------------
      *
       01  STORE-OFF          PIC 9(4)  BINARY VALUE 1.
       01  STORE-BROKER       PIC 9(4)  BINARY VALUE 2.
      *
      * --- ENTIRE BROKER API Status Constants -------------------------
      *
       01  STATUS-OFF         PIC 9(4)  BINARY VALUE 256.
       01  STATUS-STORED      PIC 9(4)  BINARY VALUE 512.
       01  STATUS-DEL-ATTEMPT PIC 9(4)  BINARY VALUE 768.
       01  STATUS-DELIVERED   PIC 9(4)  BINARY VALUE 1024.
       01  STATUS-PROCESSED   PIC 9(4)  BINARY VALUE 1280.
       01  STATUS-DEAD        PIC 9(4)  BINARY VALUE 1536.
      *
      * --- ENTIRE BROKER API Control Block Definition -----------------
      *
       01  ETBCB.
           02  TYPE-VERSION   PIC 9(4)  BINARY VALUE 0.
           02 FILLER REDEFINES TYPE-VERSION.
              04 ETBCB-TYPE    PIC X.
              04 ETBCB-VERSION PIC X.
           02  FCT-OPT        PIC 9(4)  BINARY VALUE 0.
           02 FILLER REDEFINES FCT-OPT.
              04 ETBCB-FUNCTION PIC  X.
              04 ETBCB-OPTION   PIC  X.
           02  RESERVED       PIC X(16) VALUE SPACES.
           02  SEND-LENGTH    PIC 9(9)  BINARY VALUE 0.
           02  RECEIVE-LENGTH PIC 9(9)  BINARY VALUE 0.
           02  RETURN-LENGTH  PIC 9(9)  BINARY VALUE 0.
           02  ERRTEXT-LENGTH PIC 9(9)  BINARY VALUE 0.
           02  BROKER-ID      PIC X(32) VALUE SPACES.
           02  SERVER-CLASS   PIC X(32) VALUE SPACES.
           02  SERVER-NAME    PIC X(32) VALUE SPACES.
           02  SERVICE-NAME   PIC X(32) VALUE SPACES.
      *                                               SERVICE
           02  USER-ID        PIC X(32) VALUE SPACES.
           02  PASSWD         PIC X(32) VALUE SPACES.
      *                                               PASSWORD
           02  TOKEN          PIC X(32) VALUE SPACES.
           02  SECURITY-TOKEN PIC X(32) VALUE SPACES.
           02  CONV-ID        PIC X(16) VALUE SPACES.
           02  WAIT-TIMEOUT   PIC X(8)  VALUE SPACES.
           02  ERROR-CODE     PIC X(8)  VALUE SPACES.
           02  ERROR-CODE-X REDEFINES ERROR-CODE.
             03  ERROR-CLASS  PIC X(4).
             03  ERROR-NUMBER PIC X(4).
           02  ENVIRONMNT     PIC X(32) VALUE SPACES.
      *                                               ENVIRONMENT
      *                                  V2 additions
           02  ADCOUNT        PIC 9(9)  BINARY VALUE 0.
      *                                  ATTEMPTED DELIVERY COUNT
           02  USER-DATA      PIC X(16) VALUE SPACES.
           02  MESSAGE-ID     PIC X(32) VALUE SPACES.
           02  MESSAGE-TYPE   PIC X(16) VALUE SPACES.
           02  LIFE-TIME      PIC X(8)  VALUE SPACES.
           02  NEW-PASSWD     PIC X(32) VALUE SPACES.
           02  ADAPTER-ERROR  PIC X(8)  VALUE SPACES.
           02  CLIENT-USER-ID PIC X(32) VALUE SPACES.
           02  CONVSTAT-STORE PIC 9(4)    BINARY VALUE 0.
           02  FILLER REDEFINES CONVSTAT-STORE.
             03 ETBCB-CONVSTAT  PIC X.
             03 ETBCB-STORE     PIC X.
           02  STATUS-UOWSTATUS PIC 9(4) BINARY VALUE 0.
           02  FILLER REDEFINES STATUS-UOWSTATUS.
             03 ETBCB-STATUS    PIC X.
             03 ETBCB-UOWSTATUS PIC X.
      *                                  V3 additions
           02  UOWTIME        PIC X(8)  VALUE SPACES.
           02  UOWID          PIC X(16) VALUE SPACES.
           02  USERSTATUS     PIC X(32) VALUE SPACES.
           02  UOWSTATUSPER   PIC X(1).
           02  RESVD2         PIC X(3)  VALUE SPACES.
      *                                  V4 additions
           02  LOCALE-STR     PIC X(40) VALUE SPACES.
           02  DATA-ARCH      PIC X(1).
      *                                  V6 additions
           02  FORCE-LOGON    PIC X(1)  VALUE SPACES.
           02  ENC-LEVEL      PIC X(1).
      *                                  V7 additions
           02  KERSEC         PIC X(1)  VALUE SPACES.
           02  COMMTIME       PIC X(17) VALUE SPACES.
           02  COMPLVL        PIC X(1)  VALUE SPACES.
           02  RESVD3         PIC X(2)  VALUE SPACES.
           02  RESVD4         PIC 9(9)  BINARY VALUE 0.
      *                                  V8 additions
           02  UWSTAT-LIFETIME PIC X(8) VALUE SPACES.
           02  TOPIC          PIC X(96) VALUE SPACES.
           02  PUBLICATION-ID PIC X(16) VALUE SPACES.
      *                                  V9 additions
           02  PARTNER-BID    PIC X(32) VALUE SPACE.
           02  RESVD-V73-1    PIC 9(9)  BINARY VALUE 0.
           02  RESVD-V73-2    PIC 9(9)  BINARY VALUE 0.
           02  RESVD-V73-3    PIC 9(9)  BINARY VALUE 0.
           02  CLIENT-ID      PIC 9(9)  BINARY VALUE 0.
           02  RESVD-V73-4    PIC X(32) VALUE SPACES.
           02  LOG-COMMAND    PIC X(1)  VALUE SPACES.
           02  CRED-TYPE      PIC X(1).
           02  RESVD-V73-5    PIC X(32) VALUE SPACES.
           02  RESVD5         PIC X(2)  VALUE SPACES.
      *                                  V10 additions
           02  VAR-LIST-OFF   PIC 9(9)  BINARY VALUE 0.
           02  LONG-BID-LEN   PIC 9(9)  BINARY VALUE 0.
      *
      * --- ENTIRE BROKER Attach Manager Control Block -----------------
      *
       01  ETBATMCB.
           02  A-VERSION      PIC 9(4)  BINARY VALUE 0.
           02  A-NOT-USED     PIC 9(4)  BINARY VALUE 0.
           02  A-N-ATTACH     PIC 9(9)  BINARY VALUE 0.
      *                       NUMBER OF FAILED SERVER LOOKUPS
           02  A-N-SERVER     PIC 9(9)  BINARY VALUE 0.
      *                       NUMBER OF REGISTERED SERVERS
           02  A-N-PEND-CONV  PIC 9(9)  BINARY VALUE 0.
           02  A-N-ACT-CONV   PIC 9(9)  BINARY VALUE 0.
           02  A-SERVER-CLASS PIC X(32) VALUE SPACES.
           02  A-SERVER-NAME  PIC X(32) VALUE SPACES.
           02  A-SERVICE-NAME PIC X(32) VALUE SPACES.
      *
      * *END*

Top of page

ACI Examples and Copybooks

When you begin to write your first broker ACI program, you can use the client example BCOCCBL and server example BCOSCBL as a model for your own implementation. If the examples are not available on your platform, transfer them (for example using FTP) from a platform where they are delivered.

Depending on your platform for COBOL, you will find the files with the examples, copybooks, etc., in the following locations:

Platform Copybooks / Examples Location Notes
z/OS Broker ACI Control Block copybook See member COBDEF in the mainframe source library EXX951.SRCE. 2, 3
Broker Command and Info Services Control Block copybook See member COBINF in the mainframe source library EXX951.SRCE. 2, 3, 6
COMMAREA example (used with EXEC LINK) See member ETBCOMM in the mainframe source library EXX951.SRCE. 2, 3
CIS example to perform INFO server, psf and publication calls See member BRKCNTL in the mainframe source library EXX951.SRCE. 2, 3, 6
BS2000/OSD Broker ACI Control Block copybook See element COBDEF in the LMS library EXX951.LIB.  
Broker Command and Info Services Control Block copybook See element COBINFF in the LMS library EXX951.LIB.  
IBM i Broker ACI Control Block copybook See member COBDEF in include source file QCBLLESRC. 1
Broker Command and Info Services Control Block copybook See member COBINF in include source file QCBLLESRC. 1
Sample procedure for compiling See member CRT_CBLMOD in source file EXASRC. 1
Sample procedure for binding See member EXABNDPGM in source file EXASRC. 1
Client example See member BCOCCBL of type CBLLE in source file EXASRC. 1, 5
Procedure to call client example See the CL member EXABCOC in source file EXASRC. 1, 4
Procedure to call client example with Security parameters See the CL member EXABCOCSEC in source file EXASRC. 1, 4
Server example See member BCOSCBL of type CBLLE in source file EXASRC. 1, 5
Procedure to call server example See the CL member EXABCOS in source file EXASRC. 1, 4
Procedure to call server example with Security parameters See the CL member EXABCOSSEC in source file EXASRC. 1, 4
z/VM Broker ACI Control Block copybook See member COBDEF in MACLIB EXX951.MACLIB. 7
Broker Command and Info Services Control Block copybook See member COBINF in MACLIB EXX951.MACLIB. 7

Notes:

  1. See Installing EntireX under IBM i.
  2. See Installing EntireX under z/OS.
  3. Where vrs represents the version, release and service pack.
  4. By default, these CL procedures call the C type of client and server programs (BCOC and BCOS). To use the relevant COBOL programs BCOCCBL and BCOSCBL, you must modify the procedures accordingly. After adjusting the Broker ID, Broker Version and Security parameters, you must compile the sources and bind the created modules to executable *PGM programs. For compiling, use the procedure CRT_CBLMOD. For binding, use the procedure EXABNDPGM. All sample programs copy the Broker ACI control block definitions COBDEF during compilation.
  5. See also Verifying the Installation of the Broker Stubs.
  6. The Broker CIS API requires selection fields to be terminated with binary nulls - i.e., NULLS or LOW-VALUES - or to be initialized with binary nulls if the fields are not being used.

    Note:
    Initializing these fields with spaces is not recommended.

  7. See Installing Broker Stubs under z/VM.

Top of page

Creating a COBOL User Application under IBM i

On the IBM i system, the broker stub is implemented as an object of type *SRVPGM (Service Program). This object type has the advantage that its program code can be shared by several programs. It exists as an object on its own and can therefore be easily replaced without rebinding the user's application, when a newer version becomes available.

The service program EXA supplied by Software AG contains all the functions necessary for controlling and communicating with the remote broker. To create an executable Broker application on IBM i, you need to develop, in any ILE-enabled programming language, at least one main module to which the EXA service program is bound.

Example:

The following steps show how to create a server application using the program BCOSCBL. See ACI Examples and Copybooks.

Step 1: Set the Environment

The library EXX must be located in the *LIBL list.

To set the library list, you can use the command:

 CHGCURLIB CURLIB(EXX)

Step 2: Compile the User Program

To compile BCOSCBL, use the command CRTCBLMOD with options similar to the following:

MODULE(BCOSCBL) SRCFILE(*CURLIB/EXASRC) OUTPUT(*PRINT)
OPTION(*NOMONOPRC *MAP *UNREF) EXTDSPOPT(*NODFRWRT)
LINKLIT(*PGM)

Or, use the sample procedure CRT_CBLMOD.

If the program has been successfully compiled, the module BCOSCBL will be created.

Step 3: Bind EXA to the User Program

To produce an executable program, bind the user program BCOSCBL to the service program EXA supplied by Software AG. Use the command CRTPGM similar to the following:

CRTPGM PGM(EXX/BCOSCBL) MODULE(*PGM) ENTMOD(*PGM)
BNDSRVPGM(EXX/EXA) BNDDIR(*NONE) OPTION(*GEN *WARN *DUPVAR)
DETAIL(*EXTENDED)

Or, use the sample program EXABNDPGM.

If the programs have been bound successfully, the object BCOSCBL with type *PGM will be created.

To test the program, you can modify/use the sample procedure EXABCOS as described in the package delivered.

Top of page

Related Literature

Top of page