Camunda custom workflows

The purpose of this page is to describe different methods that can be used to include a custom BPMN workflow to ONAP SO (Casablanca Release)

Add workflows to source code

• 1. Add the custom BPMN files to "so/bpmn/so-bpmn-infrastructure-flows/src/main/resources/process/".
  2. Add the groovy files to "so/bpmn/so-bpmn-infrastructure-common/src/main/groovy/org/onap/so/bpmn/infrastructure/scripts/".
  3. Build the SO project as described earlier.
  4. You should be able to observe your workflows in Camunda cockpit.

This option might be useful case you have several SO project customization and you are already building your own SO project.

Case you need to add a custom workflow to a running ONAP instance, you can use on of the below methods :

Prerequisite : For ONAP casablanca release, Camunda apps are not exposed by default, so in order to be able to access Camunda applications (rest-engine, cockpit, tasklist,..), you need to expose the so-bpmn-infra deployment in your running ONAP instance.

Using Camunda Modeler deploy option

1. 1. Open the workflow using the Camunda modeler application.
   2. Click "deploy" button.
   3. Enter the deployment name (can be any name you like to use).
   4. Enter ONAP-SO camunda REST engine URI :
      1. Use your ONAP IP address & "so-bpmn-infra" deployment exposed port number.

      2. Note that for ONAP-SO casablanca release, the URI path is

         http://{{onap_LB@}}:{{camunda_Pod_Port}}/sobpmnengine/deployment/create

         instead of the original Camunda URI "engine-rest/deployment/create".

   5. Select "None" for authentication.
   6. Click Deploy.
      
   7. For successful deployment you should receive " Deployment Successful" message.
      
   8. Use the Camunda cockpit application to view your custom workflow.

Using cURL

1. 1. This method is useful in case you need to include some script files in your deployment.
   2. Specify Script format (JavaScript, groovy,..).
   3. Specify Script type as "External Script" in your script task.
   4. Refer to the script name using URI "deployment://{{script_file_name}}".
      

   5. Use below cURL command to deploy the BPMN file and its associated scripts to your running ONAP instance

      curl -w \ -H "Accept: application/json" \ -F "deployment-name=rest-test" \ -F "enable-duplicate-filtering=false" \ -F "deploy-changed-only=falses" \ -F "ExternalScript.bpmn=@/PATH_TO_BPMN_File/ExternalScript.bpmn" \ -F "externalScript.js=@/PATH_TO_SCRIPT_File/externalScript.js" \ http://{{onap_LB@}}:{{camunda_Pod_Port}}/sobpmnengine/deployment/create

   6. Use the Camunda cockpit application to view your custom workflow.

Running the custom workflows

You can run the workflow directly using below URI

The above link will bypass the API handler and run the required workflow directly.

How SO links a Service or VNF to a workflow ?

To be able to run the workflows via the APIhandler, you first need to manually create a link between the service UUID and the associated workflow in the service, service_recipe and vnf_recipe tables in SO db (catalogdb) , in order to have SO trigger the custom workflow when the createinstance action is triggered to so API handler.

For example below, you can see in the screenshot how a custom workflow is added and linked to a specific service model in the SO service_recipe table.

You can find the SERVICE_MODEL_UUID from the services table, when a new service model is distributed from SDC to SO, a new row with the service model UUID will be created there.

Where are the BPMN workflows in SO ?

If you check the camunda database schema here https://docs.camunda.org/manual/latest/user-guide/process-engine/database/

 The process definitions are in the act_re_procdef table in camunda db:

Inside so-bpmn-infra /app/app.jar, if we follow the path from the table above, we can find all the bpmn, e.g. BOOT-INF/classes/process/CreateVfModuleInfra.bpmn, as shown in the screenshot below.