IBM Cloud Pak for Business Automation

https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1
Admin
IBM Cloud Pak for Business Automation is an enterprise platform for building, deploying, and...
Tokens:2,062,983
Snippets:7,170
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Script Output Example

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=suc-recommended-option-1-setting-up-cluster-by-running-script

This is an example of the output you might see from the `cp4a-clusteradmin-setup.sh` script, indicating the successful application of the operator catalog source and the start of installing related operators.

```bash
[INFO] Applying the latest IBM CP4BA Operator catalog source...
[✔] IBM CP4BA Operator catalog source Updated!
[INFO] Starting to install IBM Cert Manager and IBM Licensing Operator ...
```

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

### GET method request example

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=dsr-get-method

This example demonstrates how to construct the URI for the GET method to fetch the deployment status of a case solution. Ensure the solution name and target object store are correctly specified.

```http
https://example.com:9443/CaseManager/CASEREST/v1/solution/TestSolution/deploymentstatus?TargetObjectStore=tos
```

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

### Install Cert-Manager and License-Manager

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=deployment-optional-mirroring-installing-your-own-curated-catalog

Execute the setup script to install cert-manager and license-manager services. Use the `--license-accept` and `-c v4.2` flags as shown.

```bash
./setup_singleton.sh --license-accept --enable-licensing -v 1 -c v4.2
```

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

### Task Start Response Example

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=tics-get

An example of the XML response received after starting a task, containing status and task-specific data.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bpm:ResponseData xmlns:bpm='http://rest.bpm.ibm.com/v1/data'>
  <status>200</status>
  <data xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:type='tsk:TaskClientSettings' xmlns:tsk='http://rest.bpm.ibm.com/v1/data/task'>
    <url>http://localhost:9080/teamworks/process.lsw?zWorkflowState=1&amp;zTaskId=53</url>
  </data>
</bpm:ResponseData>
```

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

### Example Task Start Response

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=ta-get

An example of the XML response received after initiating a task, showing task identifiers and available actions.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bpm:ResponseData xmlns:bpm='http://rest.bpm.ibm.com/v1/data'>
  <status>200</status>
  <data xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:type='tsk:TaskActions' xmlns:tsk='http://rest.bpm.ibm.com/v1/data/task'>
    <identifier>tkiid</identifier>
    <tasks>
      <tkiid>53</tkiid>
      <actions>ACTION_GETTASK</actions>
      <actions>ACTION_GETUISETTINGS</actions>
      <actions>ACTION_CREATEMESSAGE</actions>
    </tasks>
    <tasks>
      <tkiid>56</tkiid>
      <actions>ACTION_GETTASK</actions>
      <actions>ACTION_GETUISETTINGS</actions>
      <actions>ACTION_CREATEMESSAGE</actions>
    </tasks>
    <tasks>
      <tkiid>57</tkiid>
      <actions>ACTION_GETTASK</actions>
      <actions>ACTION_GETUISETTINGS</actions>
      <actions>ACTION_CREATEMESSAGE</actions>
    </tasks>
  </data>
</bpm:ResponseData>
```

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

### Example Pod Status Output

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=tasks-workflow-process-service-authoring

This is an example of a successful pod status output for a small profile installation. It shows various components running or completed.

```text
NAME                                                              READY   STATUS      RESTARTS      AGE
flink-kubernetes-operator-54c6f8df77-c4p76                        2/2     Running     0          93m
iaf-system-entity-operator-594bb4869d-2xnkn                       2/2     Running     0          117m
iaf-system-kafka-0                                                1/1     Running     0          118m
iaf-system-zookeeper-0                                            1/1     Running     0          119m
iam-config-job-cccxh                                              0/1     Completed   0          126m
ibm-ads-operator-64d8bb999d-lq9cj                                 1/1     Running     0          149m
ibm-bts-cp4ba-bts-316-deployment-6678b9b69c-j994q                 1/1     Running     0          103m
ibm-bts-cp4ba-bts-316-deployment-6678b9b69c-qlt49                 1/1     Running     0          103m
ibm-bts-operator-catalog-v3-35-hj88t                              1/1     Running     0          156m
ibm-bts-operator-controller-manager-7b8c566669-2c54p              1/1     Running     0          104m
ibm-common-service-operator-76888bd554-h2sxm                      1/1     Running     0          149m
ibm-commonui-operator-6cb99988bb-fq6ds                            1/1     Running     0          133m
ibm-content-operator-dddbb4478-jhwkc                              1/1     Running     0          142m
ibm-cp4a-operator-catalog-djbnw                                   1/1     Running     0          156m
ibm-cp4a-operator-f67896cdd-pf5tj                                 1/1     Running     0          142m
ibm-cp4a-wfps-operator-6b5bf5cbb8-c5b8q                           1/1     Running     0          142m
ibm-cs-install-catalog-v4-15-0-wmvvw                              1/1     Running     0          156m
ibm-dpe-operator-6f9df8b744-wdfsj                                 1/1     Running     0          149m
ibm-events-operator-catalog-v5-2-1-2hw6w                          1/1     Running     0          155m
ibm-events-operator-v5.2.1-fd94bf4c7-948sr                        1/1     Running     0          119m
ibm-fncm-operator-catalog-g4tqv                                   1/1     Running     0          155m
ibm-iam-operator-7c67cb9bc7-8v6vn                                 1/1     Running     0          137m
ibm-iam-operator-catalog-4-14-0-vtfpm                             1/1     Running     0          155m
ibm-im-db-migration-zkrqv                                         0/1     Completed   0          136m
ibm-insights-engine-operator-8846d44d6-kjz85                      1/1     Running     0          142m
ibm-nginx-f5b4b464f-49wzm                                         2/2     Running     0          127m
ibm-nginx-tester-5b6f6cbbfb-d6cw2                                 2/2     Running     0          127m
ibm-odm-operator-858fd6d6d6-89rkk                                 1/1     Running     0          149m
ibm-opencontent-flink-qgcd2                                       1/1     Running     0          155m
ibm-opensearch-operator-catalog-6rc5j                             1/1     Running     0          156m
ibm-opensearch-operator-controller-manager-78675fc6b5-m2dtj       1/1     Running     0          113m
ibm-pfs-operator-56788565b8-ptnr5                                 1/1     Running     0          142m
ibm-workflow-operator-8547ffcfd8-cpj26                            1/1     Running     0          142m
ibm-zen-operator-65474d646b-d67cv                                 1/1     Running     0          137m
ibm-zen-operator-catalog-6-2-0-8c6mv                              1/1     Running     0          155m
icp4a-foundation-operator-588588875f-f7g7g                        1/1     Running     0          142m
icp4adeploy-bai-bpmn-c5p9f                                        0/1     Completed   0          86m
icp4adeploy-bai-setup-jr6v5                                       0/1     Completed   0          87m
icp4adeploy-bastudio-bootstrap-8vrr8                              0/1     Completed   0          95m
icp4adeploy-bastudio-deployment-0                                 1/1     Running     0          91m
icp4adeploy-bastudio-ltpa-4zfcl                                   0/1     Completed   0          94m
```

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

### GET method request example

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=cnar-get-method

This sample code requests the launch step information for an AUTO_ContactCustomer activity. Remember to call the GET method if the RequiresLaunchInfo property is true.

```http
GET http://example.com:9080/CaseManager/CASEREST/v1/case
/12345678-abcd-dcba-4321-12345678/tasktype/
AUTO_ContactCustomer?TargetObjectStore=MyTOS HTTP/1.1
Host: www.example.net
```

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

### Define environment variables for silent installation

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=suc-option-4-setting-up-cluster-in-silent-mode

Set these environment variables before running the cluster setup script for silent installation. The example provided is for Red Hat OpenShift Kubernetes Service (ROKS) on IBM Cloud.

```bash
export CP4BA_AUTO_PLATFORM="OCP"
export CP4BA_AUTO_DEPLOYMENT_TYPE="production"
export CP4BA_AUTO_FIPS_CHECK="No"
export CP4BA_AUTO_PRIVATE_CATALOG="No"
export CP4BA_AUTO_NAMESPACE="silent-install"
export CP4BA_AUTO_CLUSTER_USER="username"
export CP4BA_AUTO_ENTITLEMENT_KEY="XXXXXXXXXXXXX"
export CP4BA_AUTO_AIRGAP_MODE="No"
export CP4BA_AUTO_SEPARATE_OPERATOR="No"
```

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

### Example server-configurations.json

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=access-optional-user-configurations

This example shows how to configure both a Decision Runner for tests and simulations and a RuleApp deployment server using OIDC authentication.

```json
[
 {
   "name": "Test and Simulation Execution (BASIC)",
   "kind": "DECISION_RUNNER",
   "authenticationKind": "BASIC_AUTH",
   "url": "https://cpd-odm.apps.XXX.XXX/odm/DecisionRunner",
   "loginServer": "odmAdmin",
   "loginPassword": "odmAdmin",
   "builtIn": false,
   "description": "Use this server to run tests and simulationsfor decision services.",
   "groups": ["*"]
 },
 {
   "name": "Decision Service Execution (OIDC)",
   "kind": "RES",
   "authenticationKind": "OAUTH",
   "authenticationProvider": "frlab",
   "url": "https://cpd-odm.apps.XXX.XXX/odm/res",
   "loginServer": "odmAdmin",
   "loginPassword": "odmAdmin",
   "builtIn": false,
   "description": "Use this server to deploy decision services that you want to execute.",
   "groups": ["*"]
 }
]
```

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

### Date Picker On Load Event Example

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=api-date-picker-deprecated

This event is triggered when the datepicker control is loaded. It demonstrates how to get the current date and set it as the start date.

```javascript
var workerStart = ${StartDate}.getDate();  me.setStart(workerStart);
```

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

### Sample Output and Next Steps for Mirroring

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=o1mcpcprm-option-1a-mirroring-catalogs-private-registry-bastion-server

Illustrates the expected output after generating mirror manifests for a non-curated catalog and provides the command to execute for mirroring.

```bash
oc ibm-pak generate mirror-manifests ibm-cp-automation --version $CASE_VERSION target_registry/cp4ba2501
ibm-cloud-native-postgresql done
ibm-licensing done
ibm-cs-install done
ibm-cs-flink done
ibm-elasticsearch-operator  done
ibm-cp-automation done
ibm-events-operator  done
ibm-cert-manager  done
ibm-cs-iam  done
ibm-zen  done
ibm-bts-bundle  done
ibm-cp-fncm-case done
ibm-ba-insights  done

Generating mirror manifests of CASE: ibm-cp-automation, version: $CASE_VERSION is complete.

Next steps
- To mirror the non curated catalog:
oc mirror --config /root/cp4ba2501/.ibm-pak/data/mirror/ibm-cp-automation/25.1.0/image-set-config.yaml docker://targer_registry/cp4ba2501 --dest-skip-tls --max-per-registry=6
```

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

### Example ServerAccessToken GET Response Content

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=serveraccesstoken-get

This is an example of the JSON content returned by the ServerAccessToken GET method. It shows a successful response with an access token and a success message.

```json
{
  "status": "200",
  "data": {
    "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im50LWVrX1FIY1JOand6SWZTUlNxcG1VeGJSQk1jZ3BpX0N2RmlZZk5haEkifQ.eyJ1c2VybmFtZSI6ImNwNGFkbWluIiwicm9sZSI6IlVzZXIiLCJwZXJtaXNzaW9ucyI6WyJjYW5fYWRtaW5pc3RyYXRlX2J1c2luZXNzX3RlYW1zIl0sImdyb3VwcyI6WzEwMDAwXSwic3ViIjoiY3A0YWRtaW4iLCJpc3MiOiJLTk9YU1NPIiwiYXVkIjoiRFNYIiwidWlkIjoiMTAwMDMzMTAwMiIsImF1dGhlbnRpY2F0b3IiOiJleHRlcm5hbCIsImlhbSI6eyJhY2Nlc3NUb2tlbiI6IkpIUHBTTkxwUUN2VHhTYW1JZ1EySUxyd2d6cXJuNWVrUDlobXlPN3dHbFRyNE5wekhqUlBxZG5tWGxNUnh6RnNtODZkT2tlRU16TUxxV05YRlBja0xhT1AycXVtbVZTVWh5ZUZ0M1lQZENPZUpsazBFNzZJdk5YbzM3dFI4cnl1SlVGWnp2dzhGWFltZlVqckN1emN4czJtNjBjRWs3aVhrNzg5T3UyZ0I5U2RuMlEzaVdvS2lSZnAyR0F4R1hzeWhBMVo0cFVzR0pqSnVnaU96WnRiTTBkR3FObmFmVEtIdlpOVFdQRGlWUk1CaVZqN0ttTnpoWHIxTWlpdHU4ZVFtdW8yWjNjQXZMQ3FXSTVQTUxvZHRGOUdVMFZ6NllNdkxGZjRSb3ZFdTA3a2Jra1VnRU1rMEVTb2tNUFVmckZFZ20wdkxKZ1JjVkxFTHB4ZmNoQzF0V205cjA0b0U4ZjFqcHNNQ2h3Sm9XMm5MMXdwcnFTNndzZ0kyWlR4QU1xbWdTUWtDaWdmSElkWWpIckt0VkY1OUlqeEVncHNpbmRwTXE5dnc5MUZJR0tLZ3RPTmk1OUJGem5taDdKTGc0RTY1dnFjZFppUGpPNENoR3llVDZNRXNHREpUT3RTS3RKaU0zRG5aT3lqZ3NmazhJQWhFTmR2In0sImRpc3BsYXlfbmFtZSI6ImNwNGFkbWluIiwiaWF0IjoxNjY5MDQ1Mjk5LCJleHAiOjE2NjkwODg0NjN9.LjM9LLYZjFSfoEBYhMuJoZ-UaRLkVP4gp7ulepVsUCxuUd6gqZi39TUHMksqSU2oikQCfOb2hssJAMloa9T3fmAnWIjgb0gxe6mVexhZebvC7wwHebNNHg1g0mLaDig9vR9r-uwISXid5SAWls-ijXFFFVplO2RQpRYBZl4JYYkjuQaQW6XTihelO01mEO56pj60gYUTKzbmki8LEHzAyUEs4eC2jDQVn1FMiWzUC--iR98_T09rMko6gTebZFOd2ZSQ28yOEBqcntEt11uTYFVqUB_je-zE8vWTvdkYgKaUmnibwdG1m7JEwshVGPAtRp-CAiHSS2mL6SsnWGXbuQ",
    "message": "success"
  }
}

```

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

### Example: Create and build a design automation

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=reference-automation-decision-services-command-line-tool

This example demonstrates the workflow for creating a design automation, building it with the Automation Decision Services build-maven-plugin, and running the decision engine. It covers creating data and task models, adding references, generating build files, and generating sample input.

```bash
# create a data model automation with a sample class
> ads new datamodel --groupId org.acme --output DataModel
```

```bash
# create a task model automation with a sample ruleflow and a rule printing a parameter
> ads new taskmodel --groupId org.acme --output TaskModel
```

```bash
# adds a BOM entry in the task model referencing the data model
> ads add TaskModel reference DataModel
```

```bash
# generate the pom.xml files required to build the design automation
> ads make decisionservice --groupId org.acme
```

```bash
# mvn build the decision archive using ADS build-maven-plugin
> mvn clean install
```

```bash
# generate a sample input file for the decision operation
> ads run TaskModel operation --inputSample --output input.json
```

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

### History Get API Example Response

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=history-get

An example JSON response from the History Get API, illustrating the structure and content of change histories for various persistent objects.

```json
{
    "status":"200",
    "data":{
        "snapshotIds":["2064.af2ea748-b6e6-4c85-a9eb-49ed08c2cd7e"
        ],
        "baseSnapshotId":"2064.088c3f8f-16d1-41e0-a058-68905dd5973a",
        "histories":{
            "1.30397b90-a06d-4970-8f0c-ba8058c1271b":{
                "poSubType":"Installation Service",
                "changes":[{
                        "userName":"Internal TW Admin user",
                        "actionType":"change",
                        "modified_on":1316830087300,
                        "branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
                        "branchName":null,
                        "branchAcronym":null
                    }
                ],
                "name":" Installation Service"
            },
            "63.4f12afdb-4ee4-4e74-b053-305c70e3a7b2":{
                "changes":[{
                        "userName":"Internal TW Admin user",
                        "actionType":"change",
                        "modified_on":1316830087300,
                        "branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
                        "branchName":null,
                        "branchAcronym":null
                    }
                ],
                "name":"Process App Settings"
            },
            "1.f388ec60-d401-42bc-ab3e-a1ffcfe169df":{
                "poSubType":"General System Service",
                "changes":[{
                        "userName":"Internal TW Admin user",
                        "actionType":"add",
                        "modified_on":1316830087300,
                        "branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
                        "branchName":null,
                        "branchAcronym":null
                    }
                ],
                "name":"gss1"
            },
            "1.551dd543-a770-4d6c-b0e0-1c9d61242e55":{
                "poSubType":"Human Service",
                "changes":[{
                        "userName":"Internal TW Admin user",
                        "actionType":"change",
                        "modified_on":1316830087300,
                        "branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
                        "branchName":null,
                        "branchAcronym":null
                    }
                ],
                "name":"Submit Requisition"
            },
            "12.f3a52cf9-83c9-4900-9730-1229d8b37b43":{
                "changes":[{
                        "userName":"Internal TW Admin user",
                        "actionType":"change",
                        "modified_on":1316830087300,

```

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

### Generate Case Solution Deployment Configuration (Example)

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=ds-deploying-legacy-case-solution-production-target-object-store-by-using-command-line

Example of generating a `deploysolution.n.xml` file for a profile named `deploy_solution`.

```bash
configmgr_cl generateConfig \
 -task deploysolution \
 -profile deploy_solution
```

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

### Settings Get API Example Content

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=settings-get

This is an example of the JSON content returned by the Settings Get API. It demonstrates the structure and typical values for project defaults, dependencies, and environment variables.

```json
{
    "status":"200",
    "data":{
        "projDefaults":{
            "projectDefaultsId":"63.4f12afdb-4ee4-4e74-b053-305c70e3a7b2",
            "defaultXsl":"CoachDesigner.xsl",
            "defaultXslRef":"7692552a-ea18-49ce-bd93-a1dd62100cd9/61.140920b1-a53c-4d72-b6bb-60776f49f7f2",
            "name":"Process App Settings",
            "acronym":"HSS",
            "isIidOptimized":false
        },
        "projDeps":[{
                "projectId":"2066.1b351583-e5cb-43b7-baee-340a63130ea7",
                "projectName":"System Data",
                "snapshotId":"2064.74f9ea10-a351-4c42-ada5-b3dce7145330",
                "snapshotName":"7.5.1"
            },
            {
                "projectId":"2066.03167964-4fe5-4611-8ae7-a71c2a4eb9e0",
                "projectName":"TestToolkit1",
                "snapshotId":"2064.3adf10fe-7947-43b6-8c96-d0c019b80008",
                "snapshotName":"v1"
            }
        ],
        "envVars":[{
                "name":"var1Key",
                "varDefaults":[{
                        "type":"development",
                        "value":"var1Development"
                    },
                    {
                        "type":"test",
                        "value":"var1Test"
                    },
                    {
                        "type":"staging",
                        "value":"var1Staging"
                    },
                    {
                        "type":"production",
                        "value":"var1Production"
                    }
                ],
                "default":"var1Default"
            },
            {
                "name":"var2Key",
                "varDefaults":[{
                        "type":"development",
                        "value":"var2Development"
                    },
                    {
                        "type":"test",
                        "value":"var2Test"
                    }
                ],
                "default":"var2Default"
            },
            {
                "name":"",
                "default":""
            }
        ]
    }
}

```

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

### GET Method Request Example

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=chr-get-method

An example of a GET request to retrieve a summary of case comments and detailed audit comments for case folders, demonstrating the use of path and query parameters.

```APIDOC
## Example: GET method request
This sample code requests a summary of the entries for case comments and detailed audit comments for case folders:
```
#Request to get comment history of a particular case
GET http://example.com:9080/CaseManager/CASEREST/v1/case
/19278CB3-C71C-4DE5-95FE-7C7544020A31/history
?TargetObjectStore=ATOSME&BatchSize=5
&ObjectTypes=CmAcmCaseComment+CmAcmWorkItemComment+ 
&ObjectTypes=CmAcmVersionSeriesComment&EventTypes=CreationEvent
HTTP/1.1
Host: www.example.net
```
```

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

### Install Case Event Emitter (Basic)

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=configuration-automated-deployment

Basic installation of the Case Event Emitter using wsadmin. Ensure the paths to the WAR and JSON configuration files are correct.

```shell
C:\Program Files (x86)\IBM\WebSphere\AppServer\profiles\Dmgr01\bin>wsadmin.bat -lang jython 
-f C:/Workflow/CaseManagement/analytics/EnableCaseBAI.py 
--war=C:/Workflow/CaseManagement/analytics/CaseEventEmitter.war 
--config=C:/Workflow/CaseManagement/analytics/CaseEventEmitter.json 
--operation=install
```

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

### Get Blackout Start Date

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=api-datetime-picker

Retrieves the disabled start date for the DatePicker control.

```javascript
me.getBlackoutDateStart();
```

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

### Example Output and Mirroring Commands

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=deployment-optional-mirroring-installing-your-own-curated-catalog

This is sample output from the `generate mirror-manifests` command, showing the progress and completion of manifest generation. It also provides example `oc mirror` commands for both curated and non-curated catalogs.

```bash
oc ibm-pak generate mirror-manifests ibm-cp-automation --version 25.1.0 target_registry/cp4ba2501
ibm-elasticsearch-operator done
ibm-cp-automation done
ibm-cs-flink done
ibm-licensing done
ibm-bts-bundle done
ibm-ba-insights done
ibm-events-operator done
ibm-cert-manager done
ibm-zen done
ibm-cp-fncm-case done
ibm-cs-iam done
ibm-cs-install done
ibm-cloud-native-postgresql done
Generating Catalog  done
Generating mirror manifests of CASE: ibm-cp-automation, version: 25.1.0 is complete

Next steps

To mirror the curated catalog:
oc mirror --config /root/.ibm-pak/data/publish/latest/image-set-config.yaml docker://target_registry/cp4ba2501 --dest-skip-tls --max-per-registry=6

To mirror the non curated catalog:
oc mirror --config /root/.ibm-pak/data/mirror/ibm-cp-automation/25.1.0/image-set-config.yaml docker://target_registry/cp4ba2501 --dest-skip-tls --max-per-registry=6

Note: oc mirror arguments are recommendations and may not be valid on all versions of the oc-mirror plug-in.
```

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

### Create and Initialize Integration Server

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=enterprise-installing-app-connect

Command to create and start an integration server. Specify a unique name and the work directory created previously. The output shows the initialization process.

```bash
C:\Program Files\IBM\ACE\12.0.4.0>IntegrationServer --name ADPIntegrationServer --work-dir c:\myaceworkdir\ADP101
2022-06-08 15:18:21.575832: BIP1990I: Integration server 'ADPIntegrationServer' starting initialization; version '12.0.4.0' (64-bit)
2022-06-08 15:18:21.623506: BIP9905I: Initializing resource managers.
2022-06-08 15:18:28.740468: BIP9906I: Reading deployed resources.
2022-06-08 15:18:28.755718: BIP9907I: Initializing deployed resources.
...
2022-06-08 15:18:30.981410: BIP1991I: Integration server has finished initialization.

```

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

### Service Get API Example Response

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=service-get

Provides a sample JSON response from the Service Get API. This example illustrates the data structure for an advanced integration service, including its properties and variables.

```json
{
    "status":"200",
    "data":{
        "name":"AIS",
        "desc":"AIS documentation",
        "poId":"1.daa71e26-f8ef-4438-9c00-3dcfc2948f28",
        "poVersionId":"a2c07628-3e78-4c91-b335-3b1918cdc5ac",
        "id":"1.daa71e26-f8ef-4438-9c00-3dcfc2948f28",
        "item":{
            "isAsyncInvocation":false,
            "guid":"guid:4d136293f40cc951:-157548c5:1328766f77f:-7f55",
            "versionId":"7ecc26d0-969f-4a07-9b42-7c5c2482f2f5"
        },
        "variables":[
            {
                "poName":"String",
                "snapshotId":null,
                "branchId":null,
                "isList":true,
                "type":"input",
                "name":"input1"
            },
            {
                "poId":"12.f3a52cf9-83c9-4900-9730-1229d8b37b43",
                "poName":"Person",
                "snapshotId":"2064.e1d396eb-8e73-4bb6-bd35-a84c6e8527fb",
                "branchId":null,
                "isList":false,
                "type":"input",
                "name":"input2"
            },
            {
                "poName":"String",
                "snapshotId":null,
                "branchId":null,
                "isList":false,
                "type":"output",
                "name":"output1"
            },
            {
                "poName":"Boolean",
                "snapshotId":null,
                "branchId":null,
                "isList":false,
                "type":"private",
                "name":"isImplemented"
            },
            {
                "poName":"Boolean",
                "snapshotId":null,
                "branchId":null,
                "isList":false,
                "type":"private",
                "name":"isInSync"
            },
            {
                "poName":"Boolean",
                "snapshotId":null,
                "branchId":null,
                "isList":false,
                "type":"private",
                "name":"isDeployed"
            },
            {
                "poName":"Boolean",
                "snapshotId":null,
                "branchId":null,
                "isList":false,
                "type":"private",
                "name":"isProcessCenter"
            },
            {
                "poName":"Boolean",
                "snapshotId":null,
                "branchId":null,
                "isList":false,
                "type":"private",
                "name":"modifedExecutionSaveState"
            }
        ]
    }
}
```

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

### Accessing Workplace Desktop URL Example

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=deployment-optional-enabling-common-ui

This is an example URL format for accessing the Workplace desktop after configuration. Replace `cpd_hostname` with your actual Cloud Pak for Data hostname.

```text
https://cpd_hostname/icn/navigator/?desktop=workplace
```

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

### Example URL for opening a specific solution page

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=deployment-opening-pages-using-urls

This example shows how to append page information to a base URL to open a specific static solution page.

```url
http://MyServer:Port/navigator/?desktop=baw&feature=Cases&tos=TOS03_ccp00010&solution=ABC123&page=MyWork&pageType=staticPage
```

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

### Example setData Method Invocation (GET)

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=instance-put-setdata

This is an example of how to invoke the setData method using a GET request with query parameters. Ensure the 'action' is set to 'setData' and 'params' contains a valid JSON expression for variable settings.

```http
PUT /rest/bpm/wle/v1/task/{taskId}?action={string}&params={string}[&parts={string}][&failureMode={string}]
```

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

### Example Response for Available Actions

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=actions-get

An example XML response indicating available actions, such as viewing and starting an activity.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bpm:ResponseData xmlns:bpm="http://rest.bpm.ibm.com/v1/data">
    <status>200</status>
    <data xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns8="http://rest.bpm.ibm.com/v1/data/activity" xsi:type="ns8:AvailableActions">
        <actions>ACTION_VIEW_ACTIVITY</actions>
        <actions>ACTION_START_ACTIVITY</actions>
    </data>
</bpm:ResponseData>
```

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

### Example of configuration inheritance

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=rulesets-custom-configuration-references

Demonstrates how global web and XU configurations are inherited by dedicated runtime pods, and how specific overrides can be applied.

```yaml
odm_configuration:
  decisionServerRuntime:
    webConfigRef: "GlobalWebConfig"  # Applied to main runtime and inherited by dedicated runtimes
    xuConfigRef: "GlobalXUConfig"    # Applied to main runtime and inherited by dedicated runtimes
  
    dedicated:
      - name: miniloan
        paths:
          - /miniloan
        # No webConfigRef specified, will use "GlobalWebConfig" from parent
        xuConfigRef: "MiniloanXUConfig"  # Override global XU config for this runtime only
      
      - name: loan-validation
        paths:
          - /loan-validation
        webConfigRef: "LoanWebConfig"  # Override global web config for this runtime only
        # No xuConfigRef specified, will use "GlobalXUConfig" from parent

```

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

### Check Installation Status on Offline Server

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=installing-offline-server-by-calling-rest-apis

Check the status of the application installation on the offline server by querying the URL returned after the installation request. This uses a GET request to the system queue.

```curl
curl -X GET -H "$ACCESS_TOKEN_HEADER" -H "$CSRF_TOKEN_HEADER" -H 'Accept: 
application/json' 
'https://zen-front-door-hostname/instance_prefix/ops/system/queue/9?key=d2772760f7bd30006e877164ba8a6ee9
'
```

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

### Instance Following Resource - POST Method

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=following-post

Use this method to start following a specific process instance.

```APIDOC
## POST /rest/bpm/wle/v1/social/instance/{instanceId}/following

### Description
Use this method to start following a specific process instance.

### Method
POST

### Endpoint
/rest/bpm/wle/v1/social/instance/{instanceId}/following

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **followed** (boolean) - If the user is following the given process instance or task

### Response Example
```json
{
    "followed": false
}
```
```

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

### Start Following a Process Instance

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=resources-instance-following

Use this method to start following a specific process instance.

```APIDOC
## POST /instances/{instanceId}/following

### Description
Starts following a specific process instance.

### Method
POST

### Endpoint
/instances/{instanceId}/following
```

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

### Example Kafka configuration in custom resource

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=baip-kafka-parameters

This example shows the syntax for configuring Kafka parameters within the `bai_configuration.kafka` section of a custom resource.

```yaml
spec
...
  bai_configuration:
    kafka:
      auto_offset_reset: earliest
```

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

### Retrieve Installed Toolkits

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=toolkits-get

This snippet shows how to call the GET method to retrieve a list of all installed toolkits for which the user has read permissions.

```APIDOC
## GET /rest/bpm/wle/v1/toolkit

### Description
Retrieves the toolkits that are installed in the system. Only toolkits for which the calling user has read permission are returned.

### Method
GET

### Endpoint
/rest/bpm/wle/v1/toolkit

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **processAppsList** ([object]) - List of process apps installed in the system.
  - **ID** (string) - The ProcessApp identifier.
  - **shortName** (string) - The ProcessApp short name.
  - **name** (string) - The ProcessApp name.
  - **description** (string) - The ProcessApp description.
  - **defaultVersion** (string) - For the Process Center, this is the name of the default workspace. For the Process Server, this is the name of the default snapshot.
  - **installedSnapshots** ([object]) - The list of installed snapshots associated with this ProcessApp.

### Response Example (application/json)
```json
{
   "status":"200",
   "data":{
      "processAppsList":[
         {
            "shortName":"TWP",
            "name":"Process Portal",
            "description":"",
            "defaultVersion":"Main",
            "installedSnapshots":[
               {
                  "name":"7.5.0",
                  "acronym":"7.5.0",
                  "active":true,
                  "activeSince":"2011-04-26T18:49:13Z",
                  "ID":"2064.64bbda3f-b456-486a-9679-87d81c4366dd"
               }
            ],
            "ID":"2066.23d3ecec-6fdb-4033-9c57-e931aa13761f"
         },
         {
            "shortName":"HSS",
            "name":"Hiring Sample",
            "description":"Hiring Sample",
            "defaultVersion":"Main",
            "installedSnapshots":[
               {
                  "name":"Hiring Sample 3",
                  "acronym":"HS3",
                  "active":true,
                  "activeSince":"2011-04-26T18:50:06Z",
                  "ID":"2064.30c63e29-aacd-4b3b-803f-a09ce65486d2"
               }
            ],
            "ID":"2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0"
         }
      ]
   }
}
```
```

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

### Navigate to Installer Scripts Directory

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=deployment-optional-mirroring-installing-your-own-curated-catalog

Change your current directory to the location of the CP4BA installation scripts. The path must be absolute and start with '/'.

```bash
cd <absolute path to files>/cert-kubernetes/scripts/cpfs/installer_scripts/cp3pt0-deployment
```

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

### Launch precondition checker utility

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=application-validating-preconditions

Use this command to start the precondition checker utility. It requires connection details for Content Platform Engine, user credentials, the target object store, and optionally, the solution name and batch/thread pool sizes.

```bash
preconditionChecker launch -cews_uri http://myserver:9080/wsi/FNCEWS40MTOM 
-username administrator -password mypassword 
-target_os MyTargetOS -solution 'credit card dispute'
```

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

### Example BAIConfigure.properties File

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=pibaw-retrieving-your-kafka-connection-information-generating-bpmeventemitteryml-file

This properties file demonstrates the configuration for connecting IBM Business Automation Workflow to a Kafka topic on Red Hat OpenShift. Adjust values according to your environment.

```properties
#CommonConfigurations
DeploymentEnvironmentName=De1
bootstrapServers=iaf-system-kafka-bootstrap-ku2103.apps.kuocp.cp.fyre.ibm.com:443
topicName=icp4ba-bai-ingress
#Customized name for BPM server displayed in BAI
bpmCellName=PCCell1

type=scram_sha_512
trustStore=/tmp/truststore.jks
trustStore.password=secret
username=icp4ba-kafka-auth
password=dc5gk0oCS2vs
```

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

### Get DatePicker Start Date

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=api-date-picker-deprecated

Retrieves the start date of the currently set calendar. This method is useful for checking the earliest selectable date.

```javascript
me.getStart();
```

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

### Retrieve Installation Metadata

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=resources-systems-metadata

Retrieves metadata about one or more IBM Business Automation Workflow installations, supporting both single server and cluster setups.

```APIDOC
## GET /systems/metadata

### Description
Retrieve metadata about one or more IBM Business Automation Workflow installations (single server or cluster).

### Method
GET

### Endpoint
/systems/metadata
```

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

### Verify Foundational Services Installation

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=ppd-option-2-setting-up-cluster-in-openshift-console

Use this command to verify that the foundational services are successfully installed. Replace <namespace> with your project name.

```bash
oc -n <namespace> get csv
```

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

### GET Method Response Example

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=spcr-get-method

This snippet shows a typical HTTP 200 OK response for a GET request, detailing the status and metadata of a case.

```http
#Response
  HTTP/1.1 200 OK
  Content-Type: application/json;charset-UTF-8
{
    "Status": "Working",
    "CaseIdentifier":"MY_Case_000000100105",
    "DateCreated":" 2010-07-16T21:50:36Z",
    "DateLastModified":"2010-07-16T21:50:36Z"
}
```

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

### Build the decision service with Maven

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=services-building-deploying-from-cicd-stack

Navigate to the project directory and run the Maven clean install command to build the decision service. This command fetches dependencies, compiles the service, and installs the archive into your local Maven repository. Replace `<repo_name>` and `<project_name>` with your repository and project names.

```bash
cd <repo_name>/<project_name> ; mvn clean install
```

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

### Start Task Method (Alternative)

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=instance-put-start-task

This snippet shows an alternative way to start a task instance using the POST method.

```APIDOC
## POST /rest/bpm/wle/v1/task/{taskId}?action={string}[&parts={string}]

### Description
Use this method to start a task. The input variables defined on the task are set according to the definitions in the associated business process instance. The task proceeds until the first coach is encountered.

### Method
POST

### Endpoint
/rest/bpm/wle/v1/task/{taskId}

### Parameters
#### Query Parameters
- **action** (string) - Required - Action to be performed for the specified task instance. Value: 'start' - Start the specified task.
- **parts** (string) - Optional - A string indicating which parts of the response data should be returned. You can use the following values: data, actions, all (default), none.

### Request Body
None

### Response
#### Success Response (200)
- **return** (object) - A list of attribute/value pairs which make up the task start data.

### Response Example
```json
{
  "return": {}
}
```
```

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

### Example JSON Response for Task Summaries

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=summary-get

This is an example of the JSON response returned by the task summary GET method, showing a list of tasks with their details.

```json
{
    "status": "200",
    "data": {
        "total": 2,
        "tasks": [{
            "tkiid":"15",
            "name": "Task 2",
            "status": "Received",
            "owner": null,
            "assignedTo": "All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.2b2d811b-4ff7-4232-9e26-d8232e65f5e1",
            "assignedToDisplayName": "All Users",
            "assignedToType": "group",
            "dueTime": "2010-01-01T05:00:00Z"
            }, {
            "tkiid": "14",
            "name": "Task 1",
            "status":"Closed",
            "owner": "tw_admin",
            "assignedTo": "tw_admin",
            "assignedToDisplayName": "tw_admin",
            "assignedToType": "user",
            "dueTime": "2015-05-05T05:00:00Z"
        }]
    }
}
```

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

### Retrieve Installed Toolkits

Source: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.1?topic=resources-toolkits

Use this GET method to retrieve the toolkits that are installed in the system. Only the toolkits for which the calling user has read permission are returned in the response.

```APIDOC
## GET /toolkits

### Description
Retrieves a list of installed toolkits accessible by the current user.

### Method
GET

### Endpoint
/toolkits

### Response
#### Success Response (200)
- **toolkits** (array) - A list of toolkit objects.
  - **id** (string) - The unique identifier of the toolkit.
  - **name** (string) - The name of the toolkit.
  - **version** (string) - The version of the toolkit.

#### Response Example
{
  "toolkits": [
    {
      "id": "toolkit-123",
      "name": "Business Process Toolkit",
      "version": "1.0.0"
    }
  ]
}
```
Tokens:
Raw