Extracting the program interface

To deploy a program with the CICS® web services assistant, you must create a copybook that matches the COMMAREA or container interface.

About this task

In this example, the INQUIRE SINGLE ITEM function of the central catalog manager program (DFH0XCMN) is deployed as a web service. The interface to this program is a COMMAREA; the structure of the COMMAREA is defined in the copybook DFH0XCP1:
* Catalogue COMMAREA structure
03 CA-REQUEST-ID PIC X(6).
03 CA-RETURN-CODE PIC 9(2).
03 CA-RESPONSE-MESSAGE PIC X(79).
03 CA-REQUEST-SPECIFIC PIC X(911).
* Fields used in Inquire Catalog
03 CA-INQUIRE-REQUEST REDEFINES CA-REQUEST-SPECIFIC.
05 CA-LIST-START-REF PIC 9(4).
05 CA-LAST-ITEM-REF PIC 9(4).
05 CA-ITEM-COUNT PIC 9(3).
05 CA-INQUIRY-RESPONSE-DATA PIC X(900).
05 CA-CAT-ITEM REDEFINES CA-INQUIRY-RESPONSE-DATA
OCCURS 15 TIMES.
07 CA-ITEM-REF PIC 9(4).
07 CA-DESCRIPTION PIC X(40).
07 CA-DEPARTMENT PIC 9(3).
07 CA-COST PIC X(6).
07 IN-STOCK PIC 9(4).
07 ON-ORDER PIC 9(3).
* Fields used in Inquire Single
03 CA-INQUIRE-SINGLE REDEFINES CA-REQUEST-SPECIFIC.
05 CA-ITEM-REF-REQ PIC 9(4).
05 FILLER PIC 9(4).
05 FILLER PIC 9(3).
05 CA-SINGLE-ITEM.
07 CA-SNGL-ITEM-REF PIC 9(4).
07 CA-SNGL-DESCRIPTION PIC X(40).
07 CA-SNGL-DEPARTMENT PIC 9(3).
07 CA-SNGL-COST PIC X(6).
07 IN-SNGL-STOCK PIC 9(4).
07 ON-SNGL-ORDER PIC 9(3).
05 FILLER PIC X(840).
* Fields used in Place Order
03 CA-ORDER-REQUEST REDEFINES CA-REQUEST-SPECIFIC.
05 CA-USERID PIC X(8).
05 CA-CHARGE-DEPT PIC X(8).
05 CA-ITEM-REF-NUMBER PIC 9(4).
05 CA-QUANTITY-REQ PIC 9(3).
05 FILLER PIC X(888).
The copybook defines three separate interfaces for the INQUIRE CATALOG, INQUIRE SINGLE ITEM, and PLACE ORDER functions, which are overlaid on one another in the copybook. However, the DFHLS2WS utility does not support the REDEFINES statement. Therefore you must extract from the combined copybook just those sections that relate to the inquire single function:
* Catalogue COMMAREA structure
03 CA-REQUEST-ID PIC X(6).
03 CA-RETURN-CODE PIC 9(2) DISPLAY.
03 CA-RESPONSE-MESSAGE PIC X(79).
* Fields used in Inquire Single
03 CA-INQUIRE-SINGLE.
05 CA-ITEM-REF-REQ PIC 9(4) DISPLAY.
05 FILLER PIC X(4) DISPLAY.
05 FILLER PIC X(3) DISPLAY.
05 CA-SINGLE-ITEM.
07 CA-SNGL-ITEM-REF PIC 9(4) DISPLAY.
07 CA-SNGL-DESCRIPTION PIC X(40).
07 CA-SNGL-DEPARTMENT PIC 9(3) DISPLAY.
07 CA-SNGL-COST PIC X(6).
07 IN-SNGL-STOCK PIC 9(4) DISPLAY.
07 ON-SNGL-ORDER PIC 9(3) DISPLAY.
05 FILLER PIC X(840).
The redefined element CA-REQUEST-SPECIFIC has been removed and replaced by the section of the copybook that redefined it for the inquire single function. The copybook is now suitable for use with the web services assistant.

The copybook is supplied with the example application as copybook DFH0XCP4.



dfhxa_t421.html | Timestamp icon Last updated: Monday, 5 June 2017