Configuring custom case extensions for a container environment

In IBM Business Automation Workflow, you can configure custom case extensions for a container environment.

Procedure

  1. If you configured IBM Cloud Pak® for Business Automation with a custom context root for Case Client, you must update the custom extension to use that context root and rebuild it before deployment. For example, in the following URL, icn is the custom context root:
    http://server:port/icn/navigator/?desktop=bawadmin

    As outlined in the IBM® Case Manager v5.2.1 documentation (in the example for customizing the properties view by using a Yes/No checkbox editor extension), you must update the context root in the following files:

    • Extensions.json
    • CustomEditor.js
    Any reference to /navigator/... must be replaced with /<custom-context-root>/navigator/....

    After these updates are complete, rebuild the custom extension and proceed with the remaining configuration steps.

  2. Copy the custom case extension package .zip file to the IBM Content Navigator custom plug-ins directory specified by the plug-in persistent volume claim (PVC) configured for your deployment.
  3. Specify the name of each custom case extension package .zip file as a comma-separated list in the custom_extension_names property under spec.workflow_authoring_configuration.case or spec.baw_configuration.case in the Custom Resource (CR) YAML file.

    For authoring environments, add the following lines to the CR YAML file:

    Single extension package:

    spec:
      workflow_authoring_configuration:
        case:
          custom_extension_names: "CustomExtension.zip"

    Multiple extension packages:

    spec:
      workflow_authoring_configuration:
        case:
          custom_extension_names: "CustomExtension.zip,MyExtensions.zip"

    For runtime environments, add the following lines to the CR YAML file:

    Single extension package:

    spec:
      baw_configuration:
        case:
          custom_extension_names: "CustomExtension.zip"

    Multiple extension packages:

    spec:
      baw_configuration:
        case:
          custom_extension_names: "CustomExtension.zip,MyExtensions.zip"
  4. Apply the custom resource definition to your OpenShift® environment.
  5. If you modified your custom extension package after initial deployment and you want to redeploy the package, complete the following steps:
    1. Delete the custom_extension_name.ok file from the following folder:
      custom_plugins_Navigator_persistent_volume/properties”
    2. Delete the case Init job in OpenShift and the system reruns the case Init job and redeploy your custom extensive package.

What to do next

If you want to see a visual representation of the extended history for a case, see Optional: Enabling the Timeline Visualizer widget to display Business Automation Workflow process activity flow.

Complete the optional steps and deploy the custom resource (CR) file. Prepare for each capability that you want to install. For more information, see Creating a production deployment.