Table 35 summarizes the CICS® catalog domains’ specific gate. It
shows the level-1 trace point IDs of the modules providing the functions for
the gate, the functions provided by the gate, and whether or not the functions
are available through the exit programming interface (XPI).
Table 35. CICS catalog domains’ specific gate
Gate |
Trace |
Function |
XPI |
CCCC |
CC 2010
CC 2050
|
ADD
DELETE
GET
WRITE
GET_UPDATE
PUT_REPLACE
START_BROWSE
GET_NEXT
END_BROWSE
TYPE_PURGE
START_WRITE
WRITE_NEXT
END_WRITE
|
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
|
The domain identifier part of the point
ID, shown in the table as CC, appears in a trace as either LC (local catalog
domain) or GC (global catalog domain). |
In many of the functions to be described, an input parameter NAME is listed.
This name is used in the construction of a VSAM key which is then used to
identify a specific record in the catalog. The record may, or may not, already
exist. The key is a string concatenation of the calling domain, the type,
and the name. The type is a block of records for a domain. The choice of
type and name for a specific domain is at the discretion of the calling domain.
The ADD function of the CCCC gate is used to add a record.
Input parameters
- DATA_IN
- is the data to be added to the record.
- TYPE
- identifies a block of data.
- NAME
- is used to construct a record key, together with the domain and the
type.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
DUPLICATE
INVALID_DATA_LENGTH
IO_ERROR
CATALOG_FULL
|
The DELETE function of the CCCC gate is used to delete a record.
Input parameters
- TYPE
- identifies a block of data.
- NAME
- is used to construct a record key, together with the domain and the
type.
- [WRITE_TOKEN]
- is an optional token corresponding to a START_WRITE. This avoids the
need for additional connects or disconnects.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
RECORD_NOT_FOUND
IO_ERROR
BAD_TOKEN
|
The GET function of the CCCC gate is used to get a record.
Input parameters
- DATA_OUT
- If the response is OK, this contains a copy of the specified record.
- TYPE
- identifies a block of data.
- NAME
- is used to construct a record key, together with the domain and the
type.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
RECORD_NOT_FOUND
INVALID_DATA_LENGTH
IO_ERROR
|
The WRITE function of the CCCC gate is used to write a record.
Input parameters
- DATA_OUT
- is the data to be written to the specified record.
- TYPE
- identifies a block of data.
- NAME
- is used to construct a record key, together with the domain and the
type.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_DATA_LENGTH
IO_ERROR
CATALOG_FULL
|
The GET_UPDATE function of the CCCC gate is used to get a record and to
establish a thread. This thread, identified by a token, is used in a corresponding
PUT_REPLACE.
Input parameters
- DATA_OUT
- If response is OK, this contains a copy of the record.
- TYPE
- identifies a block of data.
- NAME
- is used to construct a record key, together with the domain and the
type.
Output parameters
- UPDATE_TOKEN
- Token to be used by the corresponding PUT_REPLACE.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
RECORD_NOT_FOUND
INVALID_DATA_LENGTH
IO_ERROR
|
The PUT_REPLACE function of the CCCC gate is used to replace a record.
Input parameters
- DATA_IN
- is the data to be copied to the record.
- UPDATE_TOKEN
- is the token obtained from a previous GET_UPDATE, used to identify an
existing record in the catalog.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
BAD_TOKEN
INVALID_DATA_LENGTH
IO_ERROR
CATALOG_FULL
|
The START_BROWSE function of the CCCC gate is used to start a browse session.
Input parameters
- TYPE
- identifies a block of data. The browse positions itself before the
first record for that type.
Output parameters
- BROWSE_TOKEN
- is the token identifying this browse session.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. It has this value:
IO_ERROR
The GET_NEXT function of the CCCC gate is used to get the next record.
Input parameters
- BROWSE_TOKEN
- is the token identifying this browse session.
- DATA_OUT
- is a copy of the next record within the browsed type.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_DATA_LENGTH
BAD_TOKEN
BROWSE_END
IO_ERROR
|
The END_BROWSE function of the CCCC gate is used to end a browse session.
Input parameters
- BROWSE_TOKEN
- is the token identifying this browse session.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
BAD_TOKEN
IO_ERROR
|
The TYPE_PURGE function of the CCCC gate is used to purge records. This
deletes all records within the specified TYPE block for that domain.
Input parameters
- TYPE
- identifies a block of data.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
TYPE_NOT_FOUND
IO_ERROR
|
The START_WRITE function of the CCCC gate is used to start a write session.
Input parameters
None.
Output parameters
- WRITE_TOKEN
- is the token identifying a unique file string (thread).
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. It has this value:
IO_ERROR
The WRITE_NEXT function of the CCCC gate is used to write the next record.
Input parameters
- WRITE_TOKEN
- is the token corresponding to the token from START_WRITE.
- DATA_IN
- is the data to be copied to the record.
- TYPE
- identifies a block of data.
- NAME
- is used to construct a record key, together with the domain and the
type.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_DATA_LENGTH
IO_ERROR
CATALOG_FULL
BAD_TOKEN
|
The END_WRITE function of the CCCC gate is used to end a write session.
Input parameters
- WRITE_TOKEN
- Token corresponding to a START_WRITE.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
IO_ERROR
BAD_TOKEN
|
[[ Contents Previous Page | Next Page Index ]]