CICS Batch Application Control for z/OS

https://www.ibm.com/docs/en/cics-bac/1.1.1
Admin
CICS Batch Application Control for z/OS is an IBM product that enables batch application control and...
Tokens:55,286
Snippets:306
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Grant Update Access to APPLDEV Group (RACF Command)

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=profiles-examples-facility-class-definitions

This RACF command grants the APPLDEV group UPDATE access to all resources defined under the $CBK.CICSPROD.ADMIN.** profile. This allows the development group to create, view, and modify these specific resources.

```shell
PERMIT $CBK.CICSPROD.ADMIN.** CLASS(FACILITY) ID(APPLDEV) UACC(UPDATE)
```

--------------------------------

### Deny All Access to CICSPROD Resources (RACF Command)

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=profiles-examples-facility-class-definitions

This RACF command sets a default policy to deny all access to any resource within the CICSPROD application ID. It's the initial step before granting specific permissions.

```shell
RDEFINE FACILITY $CBK.CICSPROD.** UACC(NONE)
```

--------------------------------

### Define Specific Admin Object Profile (RACF Command)

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=profiles-examples-facility-class-definitions

This RACF command defines a specific profile for the ADMIN object type within CICSPROD. This profile takes precedence over the general CICSPROD profile, allowing for more granular control.

```shell
RDEFINE FACILITY $CBK.CICSPROD.ADMIN.** UACC(NONE)
```

--------------------------------

### Sample Migration Utility Assembler Procedure

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=utility-overview-sample-migration

This snippet shows a JCL procedure for running the CICS BAC sample migration utility. It includes copyright information and is intended to be modified for specific use cases. The procedure outlines the steps to execute the migration utility.

```assembler
//********************************************************************
//*                                                                  *
//* Copyright (c) 2004 HLA Software, LLC. All Rights Reserved.       *
//*                                                                  *
//********************************************************************
//*                                                                  *
//* You can use the following procedure, suitably modified, to       *

```

--------------------------------

### Execute CICS BAC Migration Utility JCL

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=utility-overview-sample-migration

This JCL procedure executes the CICS BAC sample migration utility (CBKMIGRT). It requires specific data sets to be defined and available, including a load library, input statements for migration, and output for system dumps and printing. The PARM parameter allows passing migration options.

```JCL
//CBKMGJCL PROC P=''
//*                 
//CBKMIGRT EXEC PGM=CBKMIGRT,PARM='&P'
//*                 
//STEPLIB    DD DISP=SHR,DSN=your.cicsbac.loadlib
//SYSUDUMP   DD SYSOUT=*
//PRINT      DD SYSOUT=*
//INPUT      DD DISP=SHR,DSN=your.statements.to.be.migrated
//         PEND
```

--------------------------------

### ADD APPLIST Command Parameters

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=utility-add-applist

This section details the parameters for the ADD APPLIST command, used to specify application lists and their associated groups.

```APIDOC
## ADD APPLIST Command Parameters

### Description

This section details the parameters used with the ADD APPLIST command to manage application lists and their constituent application groups.

### Parameters

#### Path Parameters

*(No path parameters are defined for this command)*

#### Query Parameters

*(No query parameters are defined for this command)*

#### Request Body

*(This command does not use a request body; parameters are passed directly)*

### Command Parameters:

*   **APPLIST** (_listname_)
    *   **Description**: Specifies the name of the application list that is to contain one or more application group names.
    *   **Type**: String
    *   **Required**: Yes

*   **GROUPS** (_groupname-1_[,_groupname-2, ...,groupname-n_])
    *   **Description**: Specifies the names of the application groups that are to comprise the application list. If you specify more than one group name, separate the names with a comma or a blank. The maximum number of group names you can add is 512.
    *   **Type**: String (comma or space-separated list)
    *   **Required**: Yes

*   **REPLACE** ({NO|YES})
    *   **Description**: Specifies the action the file maintenance utility is to take if an application list object record already exists for the application list name you are trying to add.
        *   **NO**: If there is already an application list object in the CICS region control file for this application list name, reject the ADD APPLIST command.
        *   **YES**: If there is already an application list object in the CICS region control file for this application list name, replace it with the information in this ADD APPLIST command.
    *   **Type**: Enum (NO, YES)
    *   **Required**: No (Defaults to NO)

### Request Example

```
ADD APPLIST(MYAPPLIST) GROUPS(GROUP1,GROUP2) REPLACE(YES)
```

### Response

#### Success Response (200)

*(Success response details are not provided in the source text.)*

#### Response Example

*(Response example is not provided in the source text.)*

```

--------------------------------

### Set CICSSTARTMODE Parameter via INITPARM

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=region-using-cics-bac-pltpi-program

This snippet demonstrates how to configure the CICSSTARTMODE parameter for CBKCMNDS using the INITPARM system initialization parameter. This allows specifying the startup behavior, such as 'UPDATE' mode.

```assembler
INITPARM=(CBKCMNDS='CICSSTARTMODE(UPDATE)')
```

--------------------------------

### TD Queue Configuration Parameters

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=utility-add-tdqueue

This section details the parameters used to configure TD queues in CICS BAC. These parameters control exclusion, associated programs, replacement logic, startup behavior, and identification.

```APIDOC
## TD Queue Configuration Parameters

This section details the parameters used to configure TD queues in CICS BAC. These parameters control exclusion, associated programs, replacement logic, startup behavior, and identification.

### Parameters

- **EXCLUDE** (YES | NO) - Specifies whether to exclude this TD queue from all CICS BAC processing. If set to YES, `EXCLUDEACTION` must also be specified.
- **EXCLUDEABCODE** (_abendcode_) - Specifies the abend code (1-4095) to use if `EXCLUDEACTION` is set to ABEND.
- **EXCLUDEACTION** ({IGNORE | TERMINATE | ABEND}) - Specifies the action CICS BAC takes if `EXCLUDE` is set to YES.
  - **IGNORE**: Ignores the command and continues processing.
  - **TERMINATE**: Terminates the job step with a specified return code (`EXCLUDERETCODE`).
  - **ABEND**: Abends the job step with a specified abend code (`EXCLUDEABCODE`).
- **EXCLUDERETCODE** (_returncode_) - Specifies the return code (1-4095) to use if `EXCLUDEACTION` is set to TERMINATE.
- **PROGRAMS** (_progid-1_[,_progid-2…,progid-n_]) - Specifies one or more programs (max 8 characters each, up to 512) to be associated with the TD queue. These programs' enable status will be set based on the TD queue's state.
- **REPLACE** (YES | NO) - Specifies whether to replace an existing TD queue object record if it already exists. Defaults to NO.
- **STARTUPOPTS** ({COLD | WARM | EMER | COLDWARM | COLDWARMEMER | COLDEMER | WARMEMER | USECICS}) - Specifies the CICS startup types during which CICS BAC should restore the TD queue's last requested state.
- **TDQUEUE** (_tdqid_) - Specifies the name of the TD queue object being added or managed.
- **TRANSIDS** (_transid-1_[,_transid-2…,transid-n_]) - Specifies one or more transaction IDs (max 4 characters each) to be associated with the TD queue.
```

--------------------------------

### UPDATE FILE Command Parameters

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=utility-update-file

Details the parameters available for the UPDATE FILE command, including options for adding/removing programs and transaction IDs, and conditional file addition.

```APIDOC
## UPDATE FILE Command Parameters

### Description
This section details the parameters for the UPDATE FILE command, focusing on differences from the ADD command. Parameters common to both commands are described in the ADD FILE command documentation.

### Method
UPDATE

### Endpoint
Not applicable (Command-line interface)

### Parameters
#### Command Parameters

- **ADDIFNEW** ({NO|YES}) - Optional - Specifies whether to add a new file object if the file specified in the UPDATE FILE command does not exist in the CICS region control file.

- **ADDPROGRAMS** (_progid1,progid2…,progidn_) - Optional - Specifies one or more programs to be added to the list of programs within the file object record in the CICS region control file. Program names should be separated by a comma or a space. This is equivalent to the PROGRAMS parameter on the ADD FILE command.

- **ADDTRANSIDS** (_transid-1,transid-2…,transid-n_) - Optional - Specifies one or more transaction IDs to be added to the list of transactions within the file object record in the CICS region control file. Transaction IDs should be separated by a comma or a space. This is equivalent to the TRANSIDS parameter on the ADD FILE command.

- **REMOVEPROGRAMS** (_progid-1,progid-2…,progid-n_]) - Optional - Specifies one or more programs to be removed from the list of programs within the file object record in the CICS region control file. Program names should be separated by a comma or a space. Refer to the PROCESSPROGRAMS parameter on the SET file command for more information.

- **REMOVETRANSIDS** (_transid1,transid2…,transidn_]) - Optional - Specifies one or more transaction IDs to be removed from the list of transactions within the file object record in the CICS region control file. Transaction IDs should be separated by a comma or a space. Refer to the PROCESSTRANSIDS parameter on the SET file command for more information.

### Request Example
```
UPDATE FILE("MYFILE") ADDPROGRAMS("PROG1,PROG2") REMOVETRANSIDS("TRANS1")
```

### Response
#### Success Response (200)
Operation successful. Specific output may vary based on CICS environment.

#### Response Example
```
FILE("MYFILE") UPDATED SUCCESSFULLY.
```
```

--------------------------------

### Sample JCL for CICS BAC Batch Request Utility Job Step

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=utility-cics-bac-batch-request-job-step

This JCL defines a job step to execute the CICS BAC batch request utility (CBKBMAIN). It includes necessary DD statements for load libraries, parmlib, input commands, and output messages. The CBKGROUP DD is optional, and SYSMDUMP can be uncommented for system dumps.

```JCL
//CBKBTCH  EXEC PGM=CBKBMAIN
//STEPLIB  DD DISP=SHR,DSN=hlq.SCBKLOAD
//         DD DISP=SHR,DSN=hlq.SDFHEXCI
//CBKPARMS DD DISP=SHR,DSN=hlq.CBKPARMS
//CBKGROUP DD DISP=SHR,DSN=your.cicsgrps.dataset
//SYSABEND DD SYSOUT *
//*****************************************************************
//* Un-comment the following DD statement if you need to add a     
//* SYSMDUMP DD statement. You might need to modify this statement 
//* to meet your installation’s requirements.                      
//*****************************************************************
//*SYSMDUMP DD DISP=(,CATLG),DSN=hlq.sysmdump.dataset,
//*         UNIT=SYSDA,SPACE=(CYL,(50,25)), 
//*         DCB=(DSORG=PS,RECFM=FBS,LRECL=4160, 
//*         BLKSIZE=24960 
//CBKPRINT  DD SYSOUT *
//CBKIN     DD *
DEFAULT CICS(CICSHUR1),NOTACTIVE(TERMINATE)
SET FILE(FILEA),OPENSTATUS(CLOSED),ENABLESTATUS(DISABLE)

```

--------------------------------

### Sample Program for File Operations

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=facilities-cics-bac-request-server-callable-api

Provides information about a sample program available in the SCBKSAMP data set for invoking the CICS BAC request server to perform file operations, specifically closing and disabling a file and setting it to read-only status.

```APIDOC
## Sample Program for File Operations

### Description
Details a sample program provided for invoking the CICS BAC request server to manage file status.

### Method
N/A (Reference to a sample program)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

### Details:
- The sample program is located in member `CBKCAPI` of the `SCBKSAMP` data set.
- It demonstrates how to use the CICS BAC request server to:
  - Close a file.
  - Disable a file.
  - Set a file to read-only status.
```

--------------------------------

### Grant Access to FACILITY Class Profiles - RACF

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=definitions-example-2

These RACF commands grant specific access levels to the FACILITY class profiles for the PRODOPS group. The first command grants UPDATE access to the EXECUTE profile, while the second grants READ access to the ADMIN profile, demonstrating how to manage permissions for different object types.

```JCL
PERMIT $CBK.CICSPROD.EXECUTE.** CLASS(FACILITY) ID(PRODOPS) UACC(UPDATE)
PERMIT $CBK.CICSPROD.ADMIN.** CLASS(FACILITY) ID(PRODOPS) UACC(READ)
```

--------------------------------

### Sample JCL for File Maintenance Utility

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=processing-file-maintenance-utility-jcl

This JCL defines a job step to execute the CBKFMAIN program for file maintenance. It includes DD statements for load libraries, control parameters, input commands, and output messages. The SYSABEND and optional SYSMDUMP DD statements are also shown.

```JCL
//CBKFMU EXEC PGM=CBKFMAIN,PARM='APPLID(CICSPROD)'
//STEPLIB  DD DISP=SHR,DSN=hlq.SCBKLOAD
//         DD DISP=SHR,DSN=hlq.SDFHEXCI
//CBKPARMS DD DISP=SHR,DSN=hlq.CBKPARMS
//CBKPRINT DD SYSOUT=*
//SYSABEND DD SYSOUT=*
//*****************************************************************
//* Un-comment the following DD statement if you need to add a     
//* SYSMDUMP DD statement. You might need to modify this statement 
//* to meet your installation’s requirements.                      
//*****************************************************************
//*SYSMDUMP DD DISP=(,CATLG),DSN=hlq.sysmdump.dataset,
//* UNIT=SYSDA,SPACE=(CYL,(50,25)),
//* DCB=(DSORG=PS,RECFM=FBS,LRECL=4160,
//* BLKSIZE=24960 //CBKPRINT DD SYSOUT=*
//CBKIN DD *
ADD FILE(FILEA),RLSOPTIONS(TERMINATE),RLSRETCODE(12)

```

--------------------------------

### Add Files to Application Group

Source: https://www.ibm.com/docs/en/cics-bac/1.1.1/index_topic=utility-update-appgroup

Specifies the name of one or more files to be added to the application group. File names must be valid CICS file names up to a maximum of 8 characters.

```APIDOC
## ADDFILES

### Description
Adds one or more files to the application group.

### Method
Not applicable (Command-line utility or API call)

### Endpoint
Not applicable

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
ADDFILES(MYFILE1,MYFILE2)
```

### Response
#### Success Response (0)
Command executed successfully.

#### Response Example
None specific, indicates successful execution.

### Error Handling
- Invalid file names or file name length.
```
Tokens:
Raw