Configure the Integration with SAP Workflow Management

Prerequisites

Prerequisites for using SAP Workflow Management with Operation Automation are the following:

  • You have subscribed to a SAP Business Technology Platform account with activated Workflow Management Service in one of the sub accounts.
  • You are developing in your workflow management account workflows that either resolve error situations or alerts detected by SAP Cloud ALM or orchestrate and automate regular operational tasks. These workflows should be triggered automatically or manually from SAP Cloud ALM for Operations as a follow up action to an alert.
  • You have enabled access to workflow APIs using OAuth 2.0 Authentication (Client Credentials Grant) as described here.
  • You have enabled technical authentication as described here and granted the following authorizations: {    "authorities": [ "WORKFLOW_INSTANCE_START", "WORKFLOW_DEFINITION_GET", "WORKFLOW_DEFINITION_GET_SAMPLE_CONTEXT", "WORKFLOW_INSTANCE_GET" ],    "defaultCollectionQueryFilter": "shared" }

Configuration

Define an endpoint to the workflow management service subaccount

An end point in SAP Cloud ALM Landscape Management pointing to the workflow service in the remote sub account is required to request the list of workflow definitions, trigger a new workflow instance and check the status of executed workflow instances. Proceed as follows to create the endpoint:


Determine the service configuration parameters of the SAP Workflow Management service in the external SAP BTP workflow management service account.

  1. Open SAP BTP Cockpit and navigate to the global account --> subaccount --> space where the workflow management service is active
  2. Select Instances
  3. Select the workflow service instance
  4. Select Actions (3 dots icon) besides the bound workflow application
  5. Select View
  6. Download the JSON or copy workflow_rest_url, clientid, clientsecret , url


Define a workflow management cloud service in Landscape Management

If the workflow management subaccount is already known to Landscape Management, skip these steps and proceed directly with the end point creation. Otherwise, define the workflow management cloud service as below:

  1. Open SAP Cloud ALM Landscape Management
  2. Select Add
  3. Enter the workflow management subaccount name into fields Name and Tenant ID
  4. Enter any description
  5. Select Cloud Service Type "SAP Workflow Management"
  6. Select the correct tenant type (Production, Test, Development)
  7. Enter the root URL of the workflow management application (https://....hana.ondemand.com) into field root url
  8. Enter the subdomain id into field external id.
  9. Select Save

Add an endpoint

  1. Open SAP Cloud ALM Landscape Management
  2. Select the relevant cloud service of type "SAP Workflow Management"
  3. Select the endpoints tab
  4. Select Add
  5. Enter the following data:

a.       Use Case:  Operation Automation
b.       Root Url: <workflow_rest_url> (overwrite existing data if required)
c.       Authentication type:  OAuth2ClientCredentials
d.       Client ID: <Client ID>
e.       Client secret: <client secret>
f.        Token Service URL: <URL>/oauth/token

6  Select Save


Register operation flow definitions

The registration step is required to make the relevant workflow definitions known to SAP Cloud ALM for Operations as Operation Flows.

Perform the following for each workflow that should be triggered manually or automatically from SAP Cloud ALM for Operations.

  1. Select the operation automation tile.
  2. Select "Register Operation Flow --> SAP Workflow Management".
  3. Choose the right endpoint from the value help.
  4. Select the workflow id that should be triggered.
  5. Assign a use case corresponding to the planned usage of this workflow. Example: If the workflow resolves problems or alerts detected by Integration Monitoring, assign Integration Monitoring.
  6. Select Ok.

As a result, the new workflow definition will appear in the list of registered operation flows.


Define event processing rules to trigger operation flows automatically

If the operation flow should be triggered automatically from an event, for example an alert, you need to define an event processing rule

  1. Select the intelligent event processing tile
  2. Select "Add Rule" (+ icon)
  3. Define a rule name
  4. Select the event type according to the alert for which it should be triggered
  5. Enter the alert name as visible in alert inbox
  6. Optional: if the action should be triggered only for specific alert context enter the alert context name here. Otherwise leave the field empty.
  7. Select action type Start Operation Flow
  8. Select one of the workflow definitions from the value help. If the value help is empty, you need to register a workflow definition and assign it to the selected use case
  9. Select save
  10. Activate the new rule