How to set up the CAP feature with the REST API

Products

• Endevor

Issue/Introduction

Submit package through Endevor submit option allows to turn on/off CAP.
Is there an option on Submit or execute REST API call allowing to turn on/off CAP.

Environment

Release : 18.1

Component : CA Endevor Software Change Manager, RESTful API

Resolution

To enable Concurrent Action Processing (CAP) feature with Webservices, follow these guidelines;

Add an additional STC/Procedure with EN$CAP DD statement.
For Execute action, define additional Webservices STC (BC1PAPI0).
For Submit action, define additional Package procedure (C1BM3000).

Execute action

For example, define the following STC:
1 - Default ENDEVOR STC without CAP feature.
2 - ENDECAP STC with CAP feature enabled.

Follow these steps to define ENDECAP STC:

1. Create a new STC/datasource definition file: TomcatDir/webapps/endevor/ENDECAP.cfg
2. Add ENDECAP SERVICE and PROCESS statements to ENF (CA EVENT NOTIFICATION FACILITY) OPTLIB member
3. Create ENDECAP Webservices STC in the PROCLIB with following DD statement:
//EN$CAP   DD DUMMY

How to execute package:

To execute a package without CAP:

Use the following request: 
PUT /ENDEVOR/packages/packageName
{
  "action": "execute"
}

Execute package with CAP feature:

PUT /ENDECAP/packages/packageName
{
  "action": "execute"
}

Submit action

For submit action, define 2 package procedures:

Note:
For submit action, add a DD statement into the package procedure (C1BM3000).
CAP feature for submit action won't work with Webservices STC ENDECAP from 1st example.

For example, define the following procedure:
1 - Default procedure EPDEFLT without CAP feature.
2 - EPCAP procedure with CAP feature enabled.

Follow these steps to define EPCAP procedure:

1. Add EPCAP SERVICE and PROCESS statements to ENF (CA EVENT NOTIFICIATION  FACILITY) OPTLIB member
2. Create EPCAP JCL procedure in your PROCLIB with following DD statement:
//EN$CAP   DD DUMMY

How to submit package:

Submit a package without CAP:

Use following request: 
PUT /ENDEVOR/packages/packageName
with option jclProc:
{
  "action": "submit",
  "fromDSN": "USERID.DSN",
  "fromMember": "JOBCARD",
  "jclProc": "EPDEFLT"
}

Submit a package with CAP feature:

PUT /ENDEVOR/packages/packageName
with option jclProc:
{
  "action": "submit",
  "fromDSN": "USERID.DSN",
  "fromMember": "JOBCARD",
  "jclProc": "EPCAP"
}

Summary:

As a result, 2 STCs and 2 procedures have been built:

2 Webservices STCs (BC1PAPI0) for Package execute action:

ENDEVOR
ENDECAP

2 Package procedures (C1BM3000) for Package submit action:

EPDEFLT
EPCAP

Additional Information

See "Package Actions for RESTful API" Chapter "Submit Package"