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

ADD PROGRAM
.---,REPLACE(-NO-)----.
>>-ADD PROGRAM(progname)--+---------------------+--------------->
'-,REPLACE(-+-YES-+-)-'
'-NO--'
>--+-----------------------------------------------------------------------------------------+-->
'-,EXCLUDE(-+-YES--)--,EXCLUDEACTION(-+-IGNORE--)-------------------------------------+-+-'
| +-TERMINATE--)----,EXCLUDERETCODE(returncode)---+ |
| '-ABEND--)----,EXCLUDEABCODE(abendcode)---------' |
'-NO--)---------------------------------------------------------------------'
>--+----------------------------------+------------------------><
'-,STARTUPOPTS(-+-COLD---------+-)-'
+-WARM---------+
+-EMER---------+
+-COLDWARM-----+
+-COLDWARMEMER-+
+-COLDEMER-----+
+-WARMEMER-----+
'-USECICS------'
Description
You can define exclude and startup properties for a program object.
These properties determine how program objects are to be processed
by CICS BAC during CICS region initialization.
Parameters
- EXCLUDE({NO|YES})
- Specifies that CICS BAC is to exclude this program from all processing,
including batch request utility processing and CICS state monitoring.
- NO
- CICS BAC is not to exclude this program.
- YES
- CICS BAC is to exclude this program 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 program (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.
- PROGRAM(progname)
- Specifies the name of the program object you are adding to the
CICS region control file.
- REPLACE({NO|YES})
- Specifies the action the file maintenance utility is to take if a program object
record already exists for the program name you are trying to add.
- NO
- If there is already a program object in the CICS region control
file for this program name, reject the ADD PROGRAM command.
- YES
- If there is already a program object in the CICS region control
file for this program name, replace it with the information in this
ADD PROGRAM 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 program to its last requested enabled state.
If you specify any of the startup types, CICS BAC resets this program
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 program
during a cold start of the CICS region.
- WARM
- CICS BAC is to restore the last requested state of the program
during a warm start of the CICS region.
- EMER
- CICS BAC is to restore the last requested state of the program
during an emergency restart of the CICS region.
- COLDWARM
- CICS BAC is to restore the last requested state of the program
during cold and warm starts of the CICS region.
- COLDWARMEMER
- CICS BAC is to restore the last requested state of the program
during cold, warm, and emergency starts of the CICS region.
- COLDEMER
- CICS BAC is to restore the last requested state of the program
during cold and emergency starts of the CICS region.
- WARMEMER
- CICS BAC is to restore the last requested state of the program
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 program to its last requested state.