Journal objects

These object types represent CICS® Configuration Manager journal records:

You cannot create, update, or delete journal objects. Inquire and List are the only API commands that you can use with journal objects. These are also the only commands that do not create new journal objects. Every other command creates an EventStart object, followed by one or more EventData or BAImage objects, and then an EventEnd object.

Figure 1. Journal objects created by an API command

EventStart and EventEnd mark the start and end of a command. Between these, there will be one BAImage or EventData object for each object processed by the command. Only the following API command create BAImage objects:

All other journalled commands create EventData objects.

API command requests that fail API command security checking are not journalled. If, while an API command request is being processed, a resource definition fails resource definition security checking, then the journal object for that resource definition contains return code 8 (failed) and reason code X'15' (security failure). For information about security checking, see Restricting access to API commands and resource definitions.

Common journal object data

Every journal object contains the following common data:

<EventID> event_ID </EventID>  1 
<Sequence> sequence </Sequence>  2 
<RecType> journal_record_type </RecType>
<CreateTime> time_stamp </CreateTime>
<ObjType> object_type </ObjType>
<ObjGroup> resource_group </ObjGroup>
<ObjName> object_name </ObjName>
<CConfig> CICS_configuration </CConfig>
<API_Command> API_command_name </API_Command>
<UserID> user_ID </UserID>
<CPID> change_package_ID </CPID>
<Scheme> migration_scheme </Scheme>
<CSD> CSD_DSN </CSD>
<Context> context </Context>
<CCVRel> CCV_release </CCVRel>
<CICSRel> CICS_release </CICSRel>
<Ret_Code> return_code </Ret_Code>
<Res_Code> reason_code </Res_Code>
<A_CRC> checksum </A_CRC>
<B_CRC> checksum </B_CRC>
 1 
All of the journal objects for a particular instance of a command have the same event ID.
 2 
The sequence number identifies the relative order of each journal object within an event.

Information Information

Feedback


Timestamp icon Last updated: Friday, 8 February 2013


http://pic.dhe.ibm.com/infocenter/cicsts/v5r1/topic//ccv-api-obj-jnl.htm