DESCRIPTIVE NAME = Web 2.0 Samples - Common macros
Licensed Materials - Property of IBM
CICS SupportPac CA8K
(c) Copyright IBM Corporation 2008 All Rights Reserved
US Government Users Restricted Rights - Use, duplication
or disclosure restricted by GSA ADP Schedule Contract
with IBM Corporation
FUNCTION = Common macros for use by SupportPac CA8K samples
DESCRIPTION
This copybook describes the layout of the Resource Layout
Mapping structure that is passed to the Resource Service
Routine from the Atom feed document generator sample
program (DFH$W2FD).
The RLM is used to specify the conversions from character-
based items, such as those in an XML file, into the equivalent
binary representations in a CICS resource, such as a TSqueue
or file, and the reverse transformation from binary to
character.
Table 1.
| Offset Hex |
Type |
Len |
Name (Dim) |
Description |
| (0) |
STRUCTURE |
80 |
DFHRLM_HEADER |
RLM header |
| (0) |
CHARACTER |
8 |
RLM_EYE_CATCHER |
>DFHRLM< eyecatcher |
| (8) |
FULLWORD |
4 |
RLM_VERSION_MAJOR |
Major version number |
| (C) |
FULLWORD |
4 |
RLM_VERSION_MINOR |
Minor version number |
| (10) |
FULLWORD |
4 |
* |
Reserved |
| (14) |
FULLWORD |
4 |
RLM_LENGTH |
Total length of RLM |
| (18) |
CHARACTER |
32 |
RLM_NAME |
Name of this RLM |
| (38) |
FULLWORD |
4 |
* |
Reserved |
| (3C) |
FULLWORD |
4 |
RLM_STRUCT_SIZE |
Size of described structure |
| (40) |
CHARACTER |
16 |
* |
Reserved |
Table 2.
| Offset Hex |
Type |
Len |
Name (Dim) |
Description |
| (0) |
STRUCTURE |
1 |
DFHRLM_ENTRY |
| (0) |
UNSIGNED |
1 |
RLM_ENTRY_TYPE |
---------------------------------------------------------------------
Type 1 record structure
Data entry structure defining a single field to be converted.
---------------------------------------------------------------------
Table 3.
| Offset Hex |
Type |
Len |
Name (Dim) |
Description |
| (0) |
STRUCTURE |
64 |
DFHRLM_DATA_ENTRY |
| (0) |
UNSIGNED |
1 |
RLM1_ENTRY_TYPE |
Data entry, type=X'01' |
| (1) |
UNSIGNED |
1 |
RLM1_CONVERT_TYPE |
Conversion type |
| (2) |
HALFWORD |
2 |
RLM1_DATA_COUNT |
Length, or decimal digit count |
| (4) |
UNSIGNED |
1 |
RLM1_DATA_FRACT |
Decimal fraction digit count |
| (5) |
UNSIGNED |
1 |
* |
Reserved |
| (6) |
HALFWORD |
2 |
RLM1_NAMESPACE_LEN |
Namespace URI length |
| (8) |
HALFWORD |
2 |
RLM1_LOCAL_NAME_LEN |
Local name length |
| (A) |
HALFWORD |
2 |
* |
Reserved |
| (C) |
HALFWORD |
2 |
RLM1_DEFAULT_LEN |
Length of default value |
| (E) |
BIT(8) |
1 |
RLM1_DATA_FLAGS |
Flag byte |
| (E) |
1... .... |
|
* |
Reserved |
| (E) |
.1.. .... |
|
RLM1_SIGN_LEADING |
Leading sign |
| (E) |
..1. .... |
|
RLM1_SIGN_SEPARATE |
Separate sign |
| (F) |
CHARACTER |
13 |
* |
Reserved |
| (1C) |
ADDRESS |
4 |
RLM1_NAMESPACE_PTR |
Address of namespace URI |
| (20) |
FULLWORD |
4 |
* |
Reserved |
| (24) |
ADDRESS |
4 |
RLM1_LOCAL_NAME_PTR |
Address of local name |
| (28) |
CHARACTER |
12 |
* |
Reserved |
| (34) |
ADDRESS |
4 |
RLM1_DEFAULT_VALUE_ PTR |
Address of default value |
| (38) |
CHARACTER |
8 |
* |
Reserved |
--------------------------------------------------------------------
Type 2 record structure - Fixed Repeat
--------------------------------------------------------------------
Table 4.
| Offset Hex |
Type |
Len |
Name (Dim) |
Description |
| (0) |
STRUCTURE |
56 |
DFHRLM_FIXED_REPEAT_ ENTRY |
| (0) |
UNSIGNED |
1 |
RLM2_ENTRY_TYPE |
Fixed repeat entry, type=X'02 |
| (1) |
BIT(8) |
1 |
RLM2_CONTENT_DESC |
Content description |
| (1) |
1... .... |
|
* |
Reserved |
| (1) |
.1.. .... |
|
RLM2_INLINE_VAR |
Separate count field |
| (1) |
..1. .... |
|
RLM2_CONTENT_MIXED |
Can contain mixed content |
| (1) |
...1 .... |
|
RLM2_CONTENT_STRUCT |
Content is a structure |
| (2) |
HALFWORD |
2 |
RLM2_CONTENT_COUNT |
Array dimension |
| (4) |
CHARACTER |
3 |
* |
Reserved |
| (7) |
UNSIGNED |
1 |
RLM2_STRUCT_NAME_LEN |
Length of structure name |
| (8) |
FULLWORD |
4 |
RLM2_VAR_COUNT_OFFSET |
Offset of optional |
| (C) |
ADDRESS |
4 |
RLM2_CONTENT_LEN |
Size of one element |
| (10) |
CHARACTER |
20 |
* |
Reserved |
| (24) |
ADDRESS |
4 |
RLM2_STRUCT_NAME |
| (28) |
CHARACTER |
16 |
* |
Reserved |
Table 5.
| Offset Hex |
Type |
Len |
Name (Dim) |
Description |
| (0) |
STRUCTURE |
8 |
DFHRLM_END_REPEAT_ ENTRY |
| (0) |
UNSIGNED |
1 |
RLM4_ENTRY_TYPE |
End Repeat entry, type=X'04' |
| (1) |
CHARACTER |
7 |
* |
Padding to doubleword |
-------------------------------------------------------------------
Type 5 record structure - End of File
-------------------------------------------------------------------
Table 6.
| Offset Hex |
Type |
Len |
Name (Dim) |
Description |
| (0) |
STRUCTURE |
8 |
DFHRLM_END_OF_FILE_ ENTRY |
| (0) |
UNSIGNED |
1 |
RLM5_ENTRY_TYPE |
End of File entry, type=X'05' |
| (1) |
CHARACTER |
7 |
* |
Padding to doubleword |