Function
Add a new TD queue object to the target CICS region control file.
Syntax

ADD TDQUEUE
.---,REPLACE(-NO-)----.
>>-ADD TDQUEUE(tdqid)--+---------------------+------------------>
'-,REPLACE(-+-YES-+-)-'
'-NO--'
>--+-----------------------------------------------------------------------------------------+-->
'-,EXCLUDE(-+-YES--)--,EXCLUDEACTION(-+-IGNORE--)-------------------------------------+-+-'
| +-TERMINATE--)----,EXCLUDERETCODE(returncode)---+ |
| '-ABEND--)----,EXCLUDEABCODE(abendcode)---------' |
'-NO--)---------------------------------------------------------------------'
>--+----------------------------------+------------------------->
'-,STARTUPOPTS(-+-COLD---------+-)-'
+-WARM---------+
+-EMER---------+
+-COLDWARM-----+
+-COLDWARMEMER-+
+-COLDEMER-----+
+-WARMEMER-----+
'-USECICS------'
>--+---------------------------------------------+-------------->
'-,TRANSIDS(transid-1[,transid-2…,transid-n])-'
>--+------------------------------------------+----------------><
'-,PROGRAMS(progid-1[,progid-2…,progid-n])-'
Description
You can define a set of customized properties for a TD queue object.
These properties determine how TD queue objects are to be processed
by CICS BAC during CICS region initialization.
Parameters
- EXCLUDE({NO | YES})
- Specifies that CICS BAC is to exclude this TD queue from all processing,
including batch request utility processing and CICS state monitoring.
- NO
- CICS BAC is not to exclude this TD queue.
- YES
- CICS BAC is to exclude this TD queue from all processing. If
you specify YES, also specify the action that CICS BAC is to take if
it encounters a batch request utility command for this TD queue (see
the EXCLUDEACTION parameter).
- EXCLUDEABCODE(abendcode)
- Specifies the numeric abend code CICS BAC is to use if you specify
EXCLUDEACTION(ABEND). You can specify an abend code value in the range
1 through 4095.
- EXCLUDEACTION({IGNORE|TERMINATE|ABEND})
- Specifies the action CICS BAC is to take if you specify EXCLUDE(YES).
You can choose one of the following three options:
- IGNORE
- CICS BAC is to ignore the command as if it was not present and
continue processing with the next command.
- TERMINATE
- CICS BAC is not to process any further commands in the job step,
and the batch request utility job step is to terminate with the specified
return code (see the EXCLUDERETCODE parameter).
- ABEND
- CICS BAC is not to process any further commands in the job step,
and the batch request utility job step is to abend with the specified
abend code (see the EXCLUDEABCODE parameter).
- EXCLUDERETCODE(returncode)
- Specifies the numeric return code CICS BAC is to use if you specify
EXCLUDEACTION(TERMINATE). You can specify a return code value in the
range 1 through 4095.
- PROGRAMS(progid-1[,progid-2…,progid-n])
- Specifies one or more programs to be added to the list of programs
in the TD queue object record in the CICS region control file. Program
names must be valid CICS application program names up to a maximum
of 8 characters.
If you enter more than one program name, separate
the names with a comma or a blank. The maximum number of program names
you can add is 512.
These are programs to be processed by the
batch request utility when it processes a SET TDQUEUE command for
this TD queue. If the command sets the TD queue state to OPENSTATUS(OPEN)
and ENABLESTATUS(ENABLED), the specified programs are set to ENABLESTATUS(ENABLED).
If the batch request utility command sets the TD queue state to OPENSTATUS(CLOSED)
or ENABLESTATUS(DISABLED), the programs are set to ENABLESTATUS(DISABLED).
For more information, see the PROCESSPROGRAMS parameter on
the SET TDQUEUE command on page SET TDQUEUE.
- REPLACE({NO|YES})
- Specifies the action the file maintenance utility is to take if a TD queue object
record already exists for the TD queue name you are trying to add.
- NO
- If there is already a TD queue object in the CICS region control
file for this TD queue name, reject the ADD TDQUEUE command.
- YES
- If there is already a TD queue object in the CICS region control
file for this TD queue name, replace it with the information in this
ADD TDQUEUE command.
- STARTUPOPTS({COLD|WARM|EMER|COLDWARM|COLDWARMEMER| COLDEMER|WARMEMER|USECICS})
- Specifies the types of CICS startups during which CICS BAC should
set the state of this TD queue to its last requested state, including
its open status and enable status. If you specify any of the startup
types, CICS BAC resets this TD queue to its last requested state at
the end of that type of CICS region initialization. The options are
as follows:
- COLD
- CICS BAC is to restore the last requested state of the TD queue
during a cold start of the CICS region.
- WARM
- CICS BAC is to restore the last requested state of the TD queue
during a warm start of the CICS region.
- EMER
- CICS BAC is to restore the last requested state of the TD queue
during an emergency restart of the CICS region.
- COLDWARM
- CICS BAC is to restore the last requested state of the TD queue
during cold and warm starts of the CICS region.
- COLDWARMEMER
- CICS BAC is to restore the last requested state of the TD queue
during cold, warm, and emergency starts of the CICS region.
- COLDEMER
- CICS BAC is to restore the last requested state of the TD queue
during cold and emergency starts of the CICS region.
- WARMEMER
- CICS BAC is to restore the last requested state of the TD queue
during warm and emergency starts of the CICS region.
- USECICS
- Depending on the type of startup, CICS BAC is to use the CICS
region default startup property (as defined by the region properties
record for the CICS region) to determine whether or not it should
reset a TD queue to its last requested state.
- TDQUEUE(tdqid)
- Specifies the name of the TD queue object that you are adding
to the CICS region control file.
- TRANSIDS(transid-1[,transid-2…,transid-n])
- Specifies one or more transactions to be added to the list of
transaction in the file object record in the CICS region control file.
Transaction IDs must be valid CICS transaction IDs up to a maximum
of 4 characters.
If you enter more than one transaction ID, separate
the IDs with a comma or a blank. The maximum number of transaction
IDs you can add is 512.
These are transactions to be processed
by the batch request utility when it processes a SET TDQUEUE command
for this TD queue. If the command sets the TD queue state to OPENSTATUS(OPEN)
and ENABLESTATUS(ENABLED), the specified transactions are set to ENABLESTATUS(ENABLED).
If the batch request utility command sets the TD queue state to OPENSTATUS(CLOSED)
or ENABLESTATUS(DISABLED), the transactions are set to ENABLESTATUS(DISABLED).
For more information, see the PROCESSTRANSIDS parameter on
the SET TDQUEUE command on page SET TDQUEUE.