APP - Fixed section
The buffer that your program passes to HCL Workload Automation for Z must contain a fixed section, and it must be the first section in the buffer. It identifies the buffer, its size, the default request type, and points to object sections. The buffer must contain only 1 fixed section, even if multiple requests are passed in the same buffer.
The fixed section has this format:
Offsets | |||||
---|---|---|---|---|---|
Dec | Hex | Type | Len | Name | Description |
0 |
(0) |
STRUCTURE |
80 |
APP |
APPC BUFFER MAPPING |
0 |
(0) |
CHARACTER |
4 |
APPDESC |
BLOCK DESCRIPTOR (APP) |
4 |
(4) |
CHARACTER |
2 |
APPVER |
VERSION NUMBER (02) |
6 |
(6) |
BITSTRING |
2 |
* |
RESERVED |
8 |
(8) |
CHARACTER |
3 |
APPTYPE |
EYE CATCHER (DIA) |
11 |
(B) |
BITSTRING |
1 |
APPFLAGS |
RESERVED |
12 |
(C) |
SIGNED |
4 |
APPTOTSZ |
TOTAL SIZE |
16 |
(10) |
CHARACTER |
8 |
APP_TYPE |
DIALOG DATA TYPE (GET|PUT| DEL|CREATE) |
24 |
(18) |
SIGNED |
4 |
APP_RETCODE |
*RETURN CODE |
28 |
(1C) |
SIGNED |
4 |
APP_RSNCODE |
*REASON CODE |
32 |
(20) |
12 |
APP_OBJ_TRIPLET |
OBJECT SECTION TRIPLET | |
32 |
(20) |
SIGNED |
4 |
APP_OBJ_OFF |
OFFSET TO FIRST OBJECT SECTION |
36 |
(24) |
SIGNED |
4 |
APP_OBJ_LEN |
LENGTH OF AN OBJECT SECTION |
40 |
(28) |
SIGNED |
4 |
APP_OBJ_NBR |
NUMBER OF OBJECT SECTIONS |
44 |
(2C) |
SIGNED |
4 |
APP_ERR_OFF |
*OFFSET TO VERIFICATION ERROR |
48 | (30) | CHARACTER | 8 | * | RESERVED |
56 | (38) | CHARACTER | 16 | APPTOKEN | *TOKEN FIELD |
72 | (48) | CHARACTER | 8 | * | RESERVED |
80 | (50) | CHARACTER | 8 | APP_USERID | USER ID WHOSE AUTHORIZATION IS CHECKED TO RUN SRSTAT BY THE EQQUSIN SUBROUTINE |
Note: Descriptions
prefixed with an asterisk (*) indicate fields that HCL Workload Automation for Z updates. |
- APPDESC
- Is the block descriptor and has the value APP.
- APPVER
- Is the version
number and has the value 02.
Note: You can continue to use existing buffers with version number 01, but you cannot include new requests or fields in these buffers.
- *
- Offset 6 (X'6'). Set this reserved field to binary zeros (X'00')
- APPTYPE
- Is the eye catcher and has the value DIA.
- APPFLAGS
- Set this reserved field to binary zeros (X'00').
- APPTOTSZ
- Is the total size of the buffer.
- APP_TYPE
- Is the request type that is the default for all requests. It is used if you do not provide a value for APPOBJ_TYPE in an object section of the buffer. If you set this field to blanks (X'40'), you must specify a request in each object section of the buffer.
- APP_OBJ_TRIPLET
- Contains the offset to the first APPOBJ section, the length of all sections, and the number of sections. If the APP_OBJ_NBR field contains binary zeros (X'00') for a GET request, HCL Workload Automation for Z returns a data dictionary. The data dictionary is a description of all objects and all fields that the API supports for a GET request. CREATE objects are not described.
- APP_RETCODE
- Is the return code that is set by HCL Workload Automation for Z. In the send buffer, set this field to binary zeros (X'00'). For more information, see Return codes and reason codes generated by HCL Workload Automation for Z.
- APP_RSNCODE
- Is the reason code that is set by HCL Workload Automation for Z. In the send buffer, set this field to binary zeros (X'00'). For more information, see Return codes and reason codes generated by HCL Workload Automation for Z.
- APP_ERR_OFF
- Is set by HCL Workload Automation for Z when APP_RSNCODE indicates an error that has an offset associated with it. It is the offset in the buffer where a verification error was found. In the send buffer, set this field to binary zeros (X'00').
- *
- Offset 48 (X'30'). Set this reserved field to binary zeros (X'00').
- APPTOKEN
- Is a value that your program can set to uniquely identify a buffer. It could be, for example, a time stamp. APPTOKEN can be useful if there is more than one active request from your ATP at a time.
- *
- Offset 72 (X'48'). Set this reserved field to binary zeros (X'00').