TDQDEFAggregateRecordType

TD Queue Definitions aggregate record

Fields

CSDGroup (StringAggregationType)

The name of the CSD group for this CICS resource definition. This field is ignored for BAS definitions.

TDQType (EnumAggregationType)

The type of queue:

  • EXTRA - A queue that is outside the CICS region is allocated to CICS.
  • INDIRECT - An indirect queue is a queue that does not point to an actual data set, but to another queue. An indirect queue can be extrapartition, intrapartition, remote, or even another indirect queue.
  • INTRA - A queue for data that is to be stored temporarily.
  • REMOTE - A queue that is located on a remote system.
atifacility (EnumAggregationType)

The type of destination the queue represents:

  • TERMINAL - The transient data queue is to be associated with the terminal. The terminal must be defined to CICS. If you do not specify TERMINAL, it defaults to the value of FACILITYID. If ATI is used, as specified in the TRANSID and TRIGGERLEVEL attributes, the transaction that is initiated is associated with the specified terminal, which must be available before the transaction can be initiated.
  • FILE - The transient data queue is to be used as a file of data records that are not associated with a particular terminal or system. ATI does not require a terminal to be available.
  • SYSTEM - The transient data queue is to be associated with the specified system identifier. The system must be defined to the local CICS system using an RDO CONNECTION definition.
blockformat (EnumAggregationType)

(Extrapartition queues only) The block format of the data set. There is no default. If you specify the record format (RECORDFORMAT attribute) as undefined (or allow it to default), you cannot specify anything for the BLOCKFORMAT attribute. Options are:

  • BLOCKED - Blocked record format.
  • UNBLOCKED - Unblocked record format.
  • NOTAPPLIC - No block format is defined for this data set.
blocksize (LongAggregationType)

(Extrapartition queues only.) The length of the block, in bytes. The block length should be in the range 0 through 32767. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.

changeAgent (EnumAggregationType)

The change agent identifier that made the last modification.

  • CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
  • CSDBATCH - The resource was last changed by a DFHCSDUP job.
  • DREPAPI - Resource was last changed by a CICSPlex SM API command.
  • N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
changeAgentRelease (StringAggregationType)

The CICS release level of the agent that made the last modification.

changeTime (DateAggregationType)

The local date and time when the definition was last changed.

changeUserID (StringAggregationType)

The user ID that made the last modification.

createTime (DateAggregationType)

The local date and time when the definition was created.

databuffers (LongAggregationType)

The number of buffers to be provided, up to a maximum of 255. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.

ddname (StringAggregationType)

A 1 to 8 character value that refers to the data definition (DD) statement associated with the extrapartition TD queue. If a DD statement of this name is not coded in the JCL of the CICS region, then this name will be used to dynamically allocate the data set or sysout file.

desccodepage (LongAggregationType)

The code page of the description field. This field is ignored for CICS CSD resource definitions.

description (StringAggregationType)

A description of the transient data queue definition.

disposition (EnumAggregationType)

The disposition of the data set (extrapartition queues only):

  • MOD - CICS first assumes that the data set exists. For an existing sequential data set, MOD causes the read/write mechanism to be positioned after the last record in the data set. The read/write mechanism is positioned after the last record each time the data set is opened for output.
  • OLD - The data set existed before this job step.
  • SHR - The data set existed before this job step and can be read by other concurrent jobs
dsname (StringAggregationType)

A 1 to 44 character value that identifies the data set (DS) name to be dynamically allocated to the extrapartition TD queue. This value will be ignored if the DD name value specified is coded as a DD statement in the JCL of the CICS region.

erroroption (EnumAggregationType)

The action to be taken if an I/O error occurs (extrapartition queues only). This can be one of the following:

  • IGNORE - The block that caused the error is accepted.
  • SKIP - The block that caused the error is skipped.
facilityid (StringAggregationType)

A 4-character field that contains either:

  • The system identifier for an intrapartition queue that specifies ATIFACILITY as SYSTEM.
  • The terminal identifier where ATIFACILITY is TERMINAL. If you do not specify anything in the FACILITYID field, it defaults to the name of the queue in each case. This field must be left blank if FILE is specified for the ATIFACILITY attribute.
indirectname (StringAggregationType)

The name of a transient data queue. The queue can be intrapartition, extrapartition, remote, or indirect.

jobuserid (StringAggregationType)

If the USER= option is not specified on the JOB card for JCL submitted to the JES internal reader using this TDQ a USER= option with the value specified will be added to the JOB card used. If the value is blank the region user ID will be used. (extrapartition queues only).

name (StringAggregationType)

The name of the transient data queue definition.

opentime (EnumAggregationType)

(Extrapartition queues only.) The initial status of the data set. Options are:

  • DEFERRED - The data set remains closed until you indicate that you want to open it by using the CEMT INQUIRE|SET TDQUEUE command.
  • INITIAL - The data set is to be opened at install time.
printcontrol (EnumAggregationType)

(Extrapartition queues only.) The control characters to be used:

  • ASA - ASA control characters.
  • MACHINE - Machine control characters.
  • N/A - The Printcontrol value does not apply to this definition and should not be validated.
recordformat (EnumAggregationType)

Indicates whether the queue has fixed- or variable-length records:

  • FIXED - The queue has fixed-length records.
  • UNDEFINED - The queue is not open or is not extrapartition.
  • VARIABLE - The queue has variable-length records.
recordsize (LongAggregationType)

The record length (in bytes) for queues having fixed-length records, or the maximum record length for queues having variable-length records. This field applies only to extrapartition queues; for others, -1 is returned.

recovstatus (EnumAggregationType)

The type of recovery defined for the queue (intrapartition queues only):

  • LOGICAL - The queue is logically recoverable. If a transaction that accessed this queue was in-flight at the time of abnormal termination, or in the subsequent emergency restart or dynamic transaction backout, the queue is restored to the status it was in before the in-flight UOW modified it.
  • NOTAPPLIC - The queue is not intrapartition.
  • NO - The queue is not recoverable.
  • PHYSICAL - The queue is physically recoverable. If emergency restart occurs, this queue is to be recovered to its status at the time CICS terminated.
remotelength (LongAggregationType)

(Optional.) The length in bytes, in the range 1 through 32767. The default value is 1. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.

remotename (StringAggregationType)

the 4-character name of this queue in the remote CICS region in which the queue is defined (from the RMTNAME option in its definition). REMOTENAME applies only to queues defined as remote; for other queues the value returned is blanks.

remotesystem (StringAggregationType)

(Optional.) Specifies, if the transient data queue resides on a remote system, the name of the connection that links the target (local) system to the related (remote) system where the transient data queue resides. If this attribute is not supplied, it is derived directly from the CICS system ID of the related system, and the connection that links the target system to the related system must have the same name as the CICS system ID of the related system.

rewind (EnumAggregationType)

The disposition of a tape data set (extrapartition queues only). The disposition can be one of the following:

  • LEAVE - The current tape is positioned at the logical end of the data set.
  • REREAD - The current tape is positioned at the logical start of the data set.
  • NOTAPPLIC - This is not applicable for this resource.
sysoutclass (StringAggregationType)

Instead of allocating an extrapartition queue to a physical data set, you can allocate it to a system output data set (referred to as SYSOUT). Use the SYSOUTCLASS attribute to specify the class of the SYSOUT data set.

  • A..Z|0..9 - A single alphabetic or numeric character that represents an output class that has been set up on the z/OS system on which the CICS job is to run.
  • ***** - This is the default class. SYSOUTCLASS defaults to an asterisk (*) if you leave the DSNAME attribute blank and specify OUTPUT for the TYPEFILE field.
  • blank - SYSOUTCLASS defaults to a blank character if you leave the DSNAME attribute blank and specify INPUT or RDBACK for the TYPEFILE attribute.
termid (StringAggregationType)

The ID of the terminal.

transid (StringAggregationType)

The name of the transaction that is to be automatically initiated when the trigger level is reached. Transactions are initiated in this way to read records from the queue. If the TRANSID attribute is not specified (or if 0 is specified for the TRIGGERLEVEL attribute), you must use another method to schedule transactions to read records from transient data queues.

triggerlevel (LongAggregationType)

The number of records to be accumulated before a task is automatically initiated to process them. Specify a trigger level of 0 if you want to disable ATI processing. If you do not specify a transaction ID, the trigger level is ignored. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.

typefile (EnumAggregationType)

The type of data set the queue is to be associated with:

  • INPUT - An input data set.
  • OUTPUT - An output data set.
  • RDBACK - An input data set that is to be read backward.
userdata1 (StringAggregationType)

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.

userdata2 (StringAggregationType)

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.

userdata3 (StringAggregationType)

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.

userid (StringAggregationType)

The user ID you want CICS to use for security checking when verifying the trigger-level transaction specified in the TRANSID field (intrapartition queues only).

version (LongAggregationType)

The version number of the BAS resource definition, from 1 to 15. This field is ignored for CICS CSD resource definitions.

wait (EnumAggregationType)

Specifies whether an in-doubt unit of work (UOW) that has modified a logically recoverable queue should wait for resynchronization with its coordinator to determine whether to commit or back out the changes (intrapartition queues only):

  • NO - The UOW is not to wait. Any changes made to recoverable resources are to be backed out or committed, as specified by the ACTION attribute on the TRANSACTION resource definition.
  • YES - The UOW is to wait, and any action required while waiting is determined by the WAITACTION attribute.
  • N/A - The Wait field does not apply to this definition.
waitaction (EnumAggregationType)

The action CICS is to take for an in-doubt unit of work (UOW) if the definition for this queue specifies WAIT(YES) (intrapartition queues only). The possible actions are:

  • QUEUE - The UOW is in-doubt and waiting; any locks held by the UOW for this queue remain active until the final state of the UOW is known. This means that tasks are suspended rather than receiving the LOCKED response. When the final state of the UOW is known, any changes that it has made are committed or backed out. Until then, any further requests of the following types that need one of the active locks must wait: READQ, if the in-doubt UOW had issued READQ or DELETEQ requests. WRITEQ, if the in-doubt UOW had issued WRITEQ or DELETEQ requests. DELETEQ, if the in-doubt UOW had issued READQ, WRITEQ or DELETEQ requests.
  • REJECT - The UOW is in-doubt and is waiting. Any lock held by the UOW for this queue is retained until the final state of the UOW is known. When the final state is known, any changes the UOW has made are committed or backed out. Until then, any further request that needs one of the retained locks is rejected, and a LOCKED response is returned. WAITACTION=REJECT causes LOCKED to be raised in exactly the same circumstances as those in which QUEUE causes a transaction to wait.
  • N/A - This field does not apply to this definition and should not be validated.