PUBLIC SAP Cloud Platform Workflow
PUBLIC SAP Cloud Platform Workflow
PUBLIC SAP Cloud Platform Workflow
4 Administrator Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
4.1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
4.2 Configure the Workflow Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85
Configure SAP Fiori Launchpad Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
4.3 Manage Workflows Using the Monitor Workflows App. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
4.4 Export Workflow Service Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
5 User Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
5.1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
5.2 Working with Tasks in My Inbox. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Accessing the My Inbox Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
The release notes give you an overview of new and enhanced features and functions of the SAP Cloud Platform
Workflow.
Table 1:
New
Clients now have the option to also authenticate using OAuth 2.0 when using workflow service APIs.
For more information, see Access Workflow APIs Using OAuth 2.0 Authentication (Client Credentials) [page 73] and Ac
cess Workflow APIs Using OAuth 2.0 Authentication (Authorization Grant) [page 74].
Table 2:
Enchanced
You can create JavaScript files directly from Script Task Properties.
Table 3:
Enhanced
You can set the priority while configuring a user task. The priority will be displayed in My Inbox and can also be accessed
using the API to filter and sort tasks.
Table 4:
Enhanced
You can configure the user interface properties in a user task using a lookup provided for the SAPUI5 projects in your work
space.
Table 5:
New
You can export runtime data related to workflow definitions and workflow instances. You can use this data to address, for
example, audit needs.
For more information, see Export Workflow Service Data [page 93].
Table 6:
New
In the REST API, task-related execution log entries contain the task instance ID of the respective task.
Table 7:
Changed
Table 8:
New
You can model an intermediate timer event that allows you to pause and resume after a specified interval of time.
For more information, see Configure Intermediate Timer Events [page 28].
Table 9:
New
You can model a boundary timer event for a user task, when you want an alternative flow to be triggered, if the user task is
not completed within the specified time duration.
For more information, see Configure Boundary Timer Events [page 35].
Table 10:
New
The workflow deployment errors are displayed in the Problems view of SAP Web IDE Full-Stack.
New
You can configure the My Inbox application to consume tasks from another TCM-compliant OData Provider.
For more information, see Configure My Inbox to Consume Tasks from Another TCM-Compliant OData Provider [page 88].
Table 12:
Enhanced
Table 13:
New
In the Monitor Workflows app as well as in the REST API, you can also search workflow instances by their business keys.
For more information, see Manage Workflows Using the Monitor Workflows App [page 89].
Table 14:
New
Workflow errors are displayed in the Problems view of SAP Web IDE Full-Stack.
Table 15:
New
You can view and edit scripts used in workflow using the Code Editor of SAP Web IDE Full-Stack.
Table 16:
Enhanced
Table 17:
New
With the REST API, you can change the context of a workflow instance to recover erroneous instances.
Table 18:
New
You can model an intermediate message event using workflow editor. Intermediate message events are process steps where
the respective workflow instance waits for a message before the flow commences in the respective control flow branch.
Table 19:
New
With the REST API, you can send message events to specific workflow instances.
Table 20:
Enhanced
You can use not only concrete user assignments for user tasks, but also group assignments, containing multiple users.
Table 21:
New
Table 22:
Enhanced
With the REST API, you can suspend and resume a workflow instance.
Table 23:
Important Note
“Claim” actions on task instances and “Suspend” actions on workflow instances reflect in the REST APIs. For example, in
instance lists or execution logs. If you have built applications that use these APIs, you should check whether the new sta
tuses are handled appropriately.
Table 24:
Enhanced
Workflow admins have permissions to retrieve the workflow logs for a given workflow instance.
Table 25:
New
The business key is a nontechnical unique identifier of a workflow instance. Workflow developers can model the business key
in the workflow editor, which is then displayed in the Monitor Workflows app to administrators.
For more information, see Define Workflows [page 24] (SAP Web IDE workflow editor) and the standalone workflow editor.
Table 26:
New
The workflow service is available as a free tile for your trial account.
Table 27:
New
You can model workflows using the workflow editor feature in SAP Web IDE.
Table 28:
Enhanced
Table 29:
Enhanced
With the REST API or the Monitor Workflows app, workflow administrators have the following options:
Table 30:
Enhanced
With the REST API workflow administrators can filter workflow instances.
Table 31:
Enhanced
In the execution log of a workflow instance you can inspect the recipient users of a user task as well as the error message of
a failed script or service task. These details are available in the Monitor Workflows app and when using the REST API.
Enhanced
For each user task you can decide whether to display the respective execution log information in the inbox.
Table 33:
Enhanced
The task count on the My Inbox tile is refreshed automatically every 15 seconds. The administrator has to republish the con
tent in the SAP Fiori launchpad to make this change available.
Table 34:
New
You can inspect details of a service task in the execution history of a workflow instance. These details are available in the
Monitor Workflows app and when using the REST API.
Table 35:
Enhanced
You can see the number of tasks for processing by you in the My Inbox tile.
Table 36:
New
You can inspect the execution history of a workflow instance by viewing the execution log displayed as part of the Monitor
Workflows app.
For more information, see Manage Workflows Using the Monitor Workflows App [page 89].
Table 37:
Enhanced
Table 38:
New
You can inspect the execution history of a workflow instance by viewing the workflow log in My Inbox. Moreover, you can use
the REST API to integrate the execution history into your custom application.
The execution history starts with this release. Workflows started before this date will have an incomplete history. Some his
tory entries will be missing, for example, the Workflow Started entry. An incomplete history has no impact on the exe
cution of the workflow.
For more information, see Using Workflow APIs [page 72] and Workflow Execution Log [page 78].
Table 39:
Enhanced
Table 40:
Enhanced
Table 41:
New
You can navigate to a section of the workflow using the diagram overview in the workflow service editor.
Table 42:
Enhanced
The speed buttons available while modeling a workflow are grouped together under tasks and gateways.
For more information, see Accelerated Modeling with Speed Buttons [page 48].
Table 43:
New
You can view the technical IDs of the workflow artifacts, which helps you uniquely identify the artifact during deployment
failure.
Table 44:
New
In destinations, service tasks support the proxy type OnPremise. Developers can use version 2 of SAP Cloud Platform cloud
connector to route the service calls to on-premise systems.
Table 45:
New
Administrators also have the permissions to retrieve the context of a workflow instance using the REST API.
Table 46:
Enhanced
You can use context variables using JUEL expressions in a unified way in theworkflow service editor.
This document defines the functional scope of SAP Cloud Platform Workflow.
Further restrictions may apply based on your license agreement with SAP. Functions and capabilities described in
the documentation of this product may exceed the functional scope of the product to explain the integration with
other SAP products, which must be licensed separately.
Target Groups
The SAP Cloud Platform Workflow offers state-of-the-art process automation capabilities.
This lightweight workflow service orchestrates automated steps and steps requiring user interaction. Typical
examples for user interaction are single or multi-step approvals or requests for form-based user input.
Features
Feature Description
Model workflows Using the workflow editor in SAP Web IDE Full-Stack based on the Business Process
Model and Notation editor you design workflows with a graphical user interface.
Manage workflow instances Either with an API or with a user interface, you can manage workflows and tasks. You
can, for example, start, cancel, or retry workflows.
Process tasks in an inbox Workflow participants can view their assigned tasks in their inboxes and complete them.
For the UIs of the workflow service, the following browsers are supported on Microsoft Windows PCs and where
mentioned on Mac OS X.
Note
The workflow editor does not support Microsoft Internet Explorer and Safari.
Browser Versions
2.4 Availability
3.1 Introduction
Developer tasks for the SAP Cloud Platform Workflow service that are executed in the workflow editor or in the
workflow runtime.
Related Information
3.2 General
The SAP Cloud Platform Workflow offers state-of-the-art process automation capabilities.
This lightweight workflow service orchestrates service calls and user interaction steps. Typical examples for user
interaction are single or multi-step approvals or requests for form-based user input.
The workflow service is tightly integrated with the SAP Cloud Platform infrastructure. This is true for the concepts
such as multitenancy and subscriptions, destinations, role assignments, and scaling and for the services, for
example, SAP Fiori launchpad, My Inbox, and the SAP Cloud Platform Integration service.
For on-premise systems, customers can integrate all relevant parts of the service, including identity provider
integration and system orchestration, using standard SAP Cloud Platform means, for example, the cloud
connector.
Caution
SAP Cloud Platform Workflow does not provide any support for storing and processing personal or sensitive
data in the workflow context. It is the responsibility of the developers on customer side to decide what kind of
data is stored in the workflow context.
Features
The end user and the developer at the customer site work on subscriptions of the workflow service and SAP Web
IDE Full-Stack. The workflow service itself resides in the SAP Cloud Platform subaccount.
1. The developer at the customer site creates an application, which can include multiple services, in the SAP
Cloud Platform customer subaccount.
2. In the SAP Cloud Platform customer subaccount, the developer accesses the SAP Web IDE Full-Stack and
enables the workflow feature to create workflows.
3. The developer accesses his or her browser to define a start event in the editor and start the workflow using the
REST API or the Monitor Workflows app.
Related Information
A workflow is a collection of linked automatic or human activities that serve a certain goal.
The workflow service differentiates between workflow definitions and workflow instances. A workflow definition
specifies:
The actual execution of these actions is called a workflow instance. So, a single workflow definition can have
multiple workflow instances. This differentiation is essential for monitoring and troubleshooting. Additionally, you
can define a subject for a workflow that helps the business users to track these instances using monitoring
application. For more information, see Manage Workflows Using the Monitor Workflows App [page 89].
These different notions of "workflow"are both used in the workflow service. In the context of design time, workflow
relates to a workflow definition. In the runtime context, workflow refers to a workflow instance.
The same holds true for tasks. In the context of design time, "task" refers to the specification of a certain type of
activity. Whereas a runtime task, for example, a task in My Inbox, relates to a particular activity to be performed
instantiated from the corresponding specification.
There are many ways to create, change, or delete variables in the context of a process.
For example, when starting the process, using script tasks, updating the process context manually.
In all cases the names of the variables in the process context must adhere to the following rules:
Duration
When expressions are used to specify duration, they must resolve to ISO 8061 format during runtime. For more
information, see ISO 8061 .
● The smallest units which the duration specification supports are minutes.
● The "Week" unit ("W") is not supported.
● The duration specification supports integers only.
You can model a workflow using the workflow editor in SAP Web IDE Full-Stack, which enables IT specialists to
create workflows using the graphical Business Process Model and Notation (BPMN) standard. The BPMN
workflow model also allows users to describe the flow of activities, events, and decision gateways.
Note
● The workflow editor is available only in regions where the SAP Cloud Platform Workflow service is offered.
● The workflow editor does not support Microsoft Internet Explorer and Safari.
Modeling a workflow includes the following steps, which you can perform using workflow editor in SAP Web IDE
Full-Stack:
● Defining a start point of the workflow: Define a start point of the workflow using the start event. For more
information, see Events [page 26].
● Defining workflow steps and their sequence: Define the process steps using the following graphical objects:
○ Tasks: There are user tasks that are performed by a human and service or script tasks that are performed
by the system. For more information, see Tasks [page 29].
○ Gateways: Gateways control the flow of execution in a workflow. For more information, see Gateways
[page 44].
● Defining an endpoint of the process: Defines an endpoint of the process using end event or terminate end
event. For more information, see Events [page 26].
Prerequisites
Procedure
You must use the SAP Web IDE Full-Stack version. For more information, see Opening SAP Web IDE.
2. From the left sidebar, open the Preferences perspective by choosing (Preferences).
3. Choose Features.
4. Enable the Workflow Editor feature by using the toggle.
5. Choose Save.
6. Reload SAP Web IDE by choosing Refresh.
You have a subscription to workflow service, and are modeling workflows using the standalone workflow service
editor. You must perform the following steps to import workflows from standalone workflow service editor to the
workflow editor in SAP Web IDE Full-Stack version:
Related Information
Import a JSON workflow model from the workflow service editor and convert it to a .workflow file, which makes the
model consumable in SAP Web IDE.
Prerequisites
Create a workflow project. For more information, see Create a New Workflow Project [page 22].
Procedure
2. In the context menu of the project, choose File Import From File System .
Note
The name of the JSON file you want to convert cannot contain any spaces. For example, you'll be unable to
convert Employee Onboarding Scenario.json; you must rename it without using spaces, for example,
EmployeeOnboardingScenario.json.
3. In the Import dialog, browse for the .JSON file from local file system.
4. Choose the folder where you want to import the .JSON file.
5. Choose OK.
8. In the context menu of the renamed workflow, choose Open With Workflow Editor .
If you have subscribed to the workflow service, and are using the standalone workflow service editor, you must
manually add the additional properties while configuring destinations in the SAP Cloud Platform Workflow cockpit
to complete the importing process.
Context
To deploy workflows from the SAP Web IDE, add the following information.
Procedure
Context
A workflow project can hold one or more workflows. We recommend that you package all workflows for one
scenario into a single project. You can only deploy workflows created within this project; that is, you cannot deploy
the workflow project itself.
Procedure
Note
To create multiple workflows, you can select a workflow project or the workflow folder and choose New
Workflow . By providing the name for the workflow, you can create another workflow within a project or the
workflow folder.
Recommendation
We recommend that you create workflows in the workflow folder.
Results
The project wizard creates a project structure in the workspace. The project contains a workflow folder with a new
sample workflow file. The workflow file contains the name that you have provided in the previous steps. .
Open existing workflow files in the workflow editor to view the workflow or modify it.
Procedure
3. Right-click the workflow file and choose Open With Workflow Editor .
● Canvas: The canvas renders and models the workflow, which connects flow objects such as events, tasks, and
gateways.
● Palette: The palette contains flow objects, for example, events, tasks, and gateways. You can easily model your
workflow by selecting the required flow object in the palette and placing it on the canvas using click and drop.
● Properties: The properties view provides configuration options for flow objects.
● Diagram Overview: When a workflow model is bigger than the canvas layout, diagram overview can help you
visualize where the current view is in the diagram. Also, you can navigate to the required part of the workflow.
Procedure
For more information, see Open Workflow Files in the Workflow Editor [page 23].
2. In the Subject field of Workflow Properties pane, provide the text that helps you identify the workflow instances
started for this workflow definition.
Example
For employee onboarding process, you can consider a Subject like “Employee onboarding process
initiated for ${context.employeename}”. For more information, see Expressions [page 49].
3. In the Business Key field of the Workflow Properties pane, provide an optional identifier for workflow instances
based on business data.
The business key can include static text as well as expressions similar to the workflow subject. With the
business key, you can later identify a workflow instance without knowing the technical instance ID.
Example
For the employee onboarding process, you can consider a business key based on the unique employee ID,
for example, "${context.employeeid}". With this you can, for example, search for a specific workflow
instance using the employee ID instead of the technical workflow instance ID.
Note
In SAP Cloud Platform Workflow uniqueness is not enforced for business keys neither globally nor within a
specific workflow definition. If you require a one-to-one relationship between a business key value and a
workflow instance, make sure that you use business data within your business key expression that uniquely
identifies the entities processed within the workflow. You can, for example, use the order ID or the employee
ID.
4. To model the start event of a workflow, select Events Start Event and drop it onto the canvas from the
palette.
5. In the Start Event Properties pane, provide a name and documentation for the start event.
Note
A unique ID gets generated for every workflow artifact. This ID is in read-only mode.
10. To connect two flow elements, choose the icon from the first flow element to be connected first, keep the
mouse button pressed and move your cursor to the next flow element that needs to be performed in the
workflow.
Note
If you choose a flow element using the speed button, and the connection automatically appears. In this case
the above step is not required.
11. To model the end event of a workflow, choose Events End Event and drop it onto the canvas from the
palette.
12. In the End Event Properties pane, provide a name and documentation for the end event.
13. To model the end of a workflow as a terminate end event, choose Events Terminate End Event and
drop it onto the canvas from the palette.
For more information on the terminate end event, see Events [page 26].
Note
You can also model a terminate end event using the speed buttons. For more information, see Accelerated
Modeling with Speed Buttons [page 48].
14. In the Terminate End Event Properties Properties pane, provide a name and description for terminate end
event.
15. Choose Save.
Recommendation
We recommend that you save the changes before exiting. If you do not, your changes will be lost.
Note
○ To rename any of the flow objects, select the flow object and choose F2 .
○ You can view the errors while designing a workflow in the Problems view. For more information, see
Using the Problems View.
○ Choose Undo or Redo to undo or redo an action. Alternatively, you can choose the following key
combinations:
○ Undo: Ctrl + Z
○ Redo: Ctrl + Y
3.3.4.1 Events
Start event: It indicates where a workflow starts and what triggers a workflow. Start events have no incoming
sequence flow. Each workflow has one start event.
Intermediate Message Event: Intermediate message events are process steps where the respective workflow
instance waits for a message before the flow commences in the respective control flow branch.
Intermediate Timer Event: It allows a workflow to pause and resume after a specified interval of time.
End event: An end event means that this event has no specific result. End events have no outgoing sequence flow.
Consider a workflow that has several branches, the workflow terminates only after all the branches gets executed.
Intermediate message events occur when a workflow instance waits for a message before the flow commences in
the respective control flow branch.
Prerequisites
Configure a business key for your workflow. For more information about business keys, see Define Workflows
[page 24].
Context
Clients can send messages via the REST endpoint. For more information about how to send messages, refer to
Workflow Service API Reference.
The messages received via this endpoint are synchronously correlated to workflow instances based on the
business key. The message can be delivered to one or more instances of the same workflow definition, which has a
matching business key and an active execution branch waiting at the intermediate message event.
Procedure
1. Select Events Intermediate Message and drop it onto the canvas from the palette.
2. In the Intermediate Message Event Properties area, choose the General tab.
3. Fill in the Name and Documentation fields for the intermediate message event.
4. In the Intermediate Message Event Properties area, choose the Details tab.
5. In the Message Name field, provide a name of the message.
6. (Optional) Provide a Response Variable link to a workflow context node, which holds the context data passed
by the incoming message.
Note
○ If you use a response variable, it must adhere to the syntax defined by the Java Unified Expression
Language (JUEL).
○ If you don't provide a response variable, the message is consumed by matching workflow instances.
However, the context data passed by the message is not considered.
Example
Equipment must be procured for a new hire. In this case, the employeeID of the new hire can be configured
as business key. The workflow calls an external service to trigger the asynchronous procurement
process.The workflow instance must wait until the procurement process is completed.
You can model an intermediate message event, which blocks the execution of the workflow in this branch
until a message is received. When the procurement process completes, the external system can send a
message that includes details about the equipment ordered. This message is then delivered to one of the
waiting workflow instances, and the execution moves to the next flow step.
Configure an intermediate timer event to allow a workflow to pause and resume after a specified interval of time.
Context
In a few business scenarios, a workflow may need to wait for a certain interval of time before proceeding with the
flow; for example, a workflow that updates multiple systems of record. You can add an intermediate timer event
that delays the workflow for a few minutes, to ensure that all records have been updated before the workflow
continues.
Procedure
1. Select Events Intermediate Timer and drop it onto the canvas from the palette.
2. Fill in the Name and Documentation fields for the intermediate timer event.
3. In the Intermediate Timer Event Properties area, choose the Details tab.
4. Provide the waiting time interval in the Duration field.
○ To use expressions, select Use Expression.
Note
Provide an expression in the Duration field using ISO 8061 format. For example, PT$
{context.minutes}M. The JUEL expression ${context.minutes} is evaluated at runtime. You can
provide multiple duration attributes by using multiple JUEL expressions. For more information about
the duration formats that are supported in ISO 8061, see Conventions [page 19].
○ To use a static value, provide the Duration as a numeric value, and choose a Unit of Time.
5. Choose Save.
3.3.4.2 Tasks
● User Task: A user task is a flow object in the process that illustrates a task that a human performs. These tasks
then appear in My Inbox where processor of the task can complete the task instance, and view description of
the task.
● Service Task: A service task is a flow object in the process that illustrates a task that a system performs, for
example, calling an external service. The task that you configure is performed immediately, when the process
execution arrives at the service task.
● Script Task: A script task is a flow object in the process that illustrates a script that gets executed when the
process execution arrives at the script task. This is an automated activity.
Related Information
You must use this procedure when you want a user to perform a particular task in the workflow.
Prerequisites
The following configuration steps are required to ensure that end users can view tasks in custom UIs in My Inbox:
● Deploy a custom task UI application and ensure that it is up and running in the consumer subaccount.
● Ensure that the application contains the SAPUI5 component, which is used as custom task UI.
As a workflow developer, you must be able to associate a custom task UI in the customer application with a
workflow user task. In this way, when an end user opens his or her task on My Inbox, the custom task UI is
rendered.
Procedure
1. Choose (Tasks), then User Task from the palette and drop it on to the canvas.
2. Select the user task icon that you dropped on the canvas.
3. In the User Task Properties area, choose the General tab.
4. Provide a Name and Documentation for the user task.
Note
A unique ID gets generated for every workflow artifact. This ID is in read-only mode.
5. (Optional) To display information about the task execution in the inbox workflow log, select Show in inbox
workflow log.
6. From User Task Properties area, choose the Details tab.
7. Depending on the priority of the user task, choose one of the following options from the Priority menu:
○ Low
○ Medium (default)
○ High
○ Very High
Note
Priority is reflected in My Inbox using which the end user can sort, filter, and group the tasks. For more
information, see Working with Tasks in My Inbox [page 95].
Note
○ Subject, Description, Users and Groups can also refer to the dynamic workflow context. For example, if
you want to provide a Subject that references a variable from dynamic context, you can specify the
expression in Subject field as "Approval for ${context.employee.name}". For more information, see
Expressions [page 49].
○ To provide multiple users or groups of users to process the task, separate each unique ID with a
comma.
10. To embed a custom task user interface, perform one of the following steps:
○ To embed a custom task UI for projects that are available in the workspace, perform the following:
1. In the User Interface section, choose the Select option.
2. In the Choose User Interface window, choose the Project Name from the list of projects that are
available in the workspace.
Note
○ Based on the selected Project Name, an Application Name is predicted. You can also provide a
different application name by editing this field.
○ Application Name is the name of the deployed application on SAP Cloud Platform.
Note
SAPUI5 Component is added automatically, which is editable.
○ To manually provide the custom task UI details, provide following details in the User Interface section:
There are two examples provided based on whether the Grunt build is triggered for the SAPUI5 project or
not. The configuration of the above User Interface properties is illustrated below with examples.
Example
Example 1: Grunt build is not enabled for the SAPUI5 project.
Example
Example 2:An SAPUI5 project is built using Grunt. For more information, see Building Applications. The
sample screenshot for this and the corresponding User Interface properties are shown in the table
below:
Component URL
Note
Component URL in this case is the location of the Component.js file, relative to the webapp folder.
11. (Optional) Add a boundary timer event to include a timer for the user task. For more information, see
Configure Boundary Timer Events [page 35].
12. Connect the user task to the required flow elements.
13. Choose Save.
14. To embed a custom task user interface, provide the following details in the User Interface section:
○ HTML5 App : Name of the HTML5 application.
○ Component URL : Location of <Component.js> in the HTML5 project.
○ SAPUI5 Component : SAPUI5 component name without the <.component> suffix.
There are two examples provided based on whether the Grunt build is triggered for the SAPUI5 project or not.
The configuration of the above User Interface properties is illustrated with examples.
Example
Example 1: Grunt build is not enabled for the SAPUI5 project.
Open the component.js file of the UI5 application. The sample screenshot is given and the corresponding
User Interface properties are below:
Component URL
Note
Component URL in this case is the location to the Component.js file relative to the webapp folder.
Related Information
Configure a boundary timer event to trigger an alternative flow if a user task doesn't finish within a specified time
duration.
Context
Boundary timer events are attached to a user task. Some user tasks may need to be completed during a certain
time interval. You can add a boundary timer event to define the duration of time for which the flow can wait at the
user task before starting an alternative flow. There are two types of boundary timer events:
● Canceling Boundary Event: When this event is triggered, it cancels the user task it is attached to.
● Non-Canceling Boundary Event: When this activity is triggered, it does not cancel the user task it is attached
to.
Example
In an employee onboarding scenario, the equipment assignment to a new hire must be confirmed by the
buddy assigned to the new hire. The buddy is responsible for confirming the equipments that need to be
procured for the new hire.
A non-canceling boundary timer event can be modeled on the "Confirm or Change Equipment" user task to
send a reminder mail to the buddy if the task is not completed in three days. Similarly, a canceling boundary
timer event can be modeled where the duration is such that the timer elapses two days before the joining
date of new hire. Additionally, an alternative escalation flow, such as an escalation email, must be sent to
the manager of the buddy to take required action; in this case, the original "Confirm or Change Equipment"
task becomes irrelevant. Hence, the 'Confirm or Change Equipment' user task is canceled.
Procedure
1. Choose Boundary Timer from the speed button of the required user task.
2. Provide a Name and Documentation for the boundary timer event.
3. In the Boundary Timer Event Properties area, choose the Details tab.
4. Provide the waiting duration for the flow in the Duration field. You can use one of the following ways to
configure this field:
○ To use expressions, select Use Expression checkbox.
Note
You must provide an expression in the Duration field using ISO 8061 format. For example, PT$
{context.minutes}M. The JUEL expression ${context.minutes} is evaluated at runtime. You can
provide multiple duration attributes by using multiple JUEL expressions. For more information about
the duration formats that are supported in ISO 8061, see Conventions [page 19].
Note
○ You can add multiple boundary timer events to a user task, which gets triggered when the
corresponding timers are fired. When a canceling boundary event is triggered, any boundary events
attached to the same task that haven't yet triggered are canceled.
○ One specific case needs to be taken into account: namely, suspending and resuming a workflow
instance with several boundary timer events on an active user task. If such an instance is resumed and
it has been suspended for a time period longer than the corresponding timer durations, there is no
deterministic order in which the events are triggered.
○ When you add multiple boundary timer events, they are placed on the same position at the bottom of
the user task. This may lead to several events on top of each other. However, these events can be
moved along the boundary of the user task.
Configure a service task if you want the system to perform a particular task in the workflow.
Procedure
1. Choose (Tasks), then Service Task from the palette and drop it on to the canvas.
2. Select the service task icon that you dropped on the canvas.
3. In the Service Task Properties area, choose the General tab.
4. Provide a Name and Documentation for service task.
Documentation is optional.
Note
A unique ID gets generated for every workflow artifact. This ID is in read-only mode.
○ HTTP Method: Specify one of the following HTTP methods: GET, POST, PUT, or DELETE.
Note
If the HTTP method is POST, DELETE, or PUT, then thePath to XSRF Token field appears. XSRF token is
used for modifying operations that are protected against XSRF (cross-site request forgery) attacks. For
more information, see SAP Cloud Platform.
○ Path to XSRF Token: The resource path that needs to be appended to a specified destination, while calling
the service to fetch an XSRF token.
○ Request Variable: Link to a workflow context node that populates the body of the HTTP request. The
referenced node is used 1:1 as content for the request body.
Note
○ The referenced node is used 1:1 as content for the request body.
○ If the HTTP Method is POST and PUT, then the Path to XSRF Token field appears.
○ Response Variable: Link to a workflow context node that is created or overwritten to finally store the body
of the HTTP response.
Note
The referenced node is used to store the response body.
Example
This example shows how to call a REST service to store employee's leave requests. This service is XSRF
protected.
○ Destination is created in the SAP Cloud Platform subaccount with the following URL: http://
<host>:<port>.
○ Path: /leaverequest.
○ HTTP Method: POST.
○ Path to XSRF Token: /leaverequest/v1/xsrf-token
○ Request variable: ${context.leaveRequest.request}
○ Response Variable: ${context.leaveRequest.response}
Sample Code
leaverequest
{
"request":
{
"employeeId":"000001",
"startDate": "2016-10-10T00:00:00.000Z",
"endDate": "2016-10-19T00:00:00.000Z",
"reason":"vacation"
}
}
At runtime, context gets added with the response variable when the service task is invoked. Once the
service task is invoked, the context gets appended with the response variable and would look like:
Sample Code
leaverequest
{
"request":
{
"employeeId":"000001",
"startDate": "2016-10-10T00:00:00.000Z",
"endDate": "2016-10-19T00:00:00.000Z",
"reason":"vacation"
}
"response":
{
status: "Successfully stored"
}
}
Next Steps
The workflow developer can deploy the workflow model into the workflow service runtime.
To make the workflow operational, the administrator must create and configure the destination mentioned by the
workflow developer. For more information, see Destinations [page 101].
Related Information
Configure a script task if you want the system to run a script to perform a task in the workflow.
Context
Note
If you have previously modeled script task using the workflow editor, then your existing script files are converted
into .js files automatically. Create a JavaScript file only for new script tasks you want to model.
Recommendation
We recommend that you export and import workflow projects, rather than individual workflows, as additional
script resources are added to the workflow project.
Procedure
1. Choose (Tasks), then Script Task from the palette and drop it on to the canvas.
2. In the Script Task Properties area, provide a name and documentation (optional) for script task.
Note
A unique read-only ID is automatically generated for every workflow artifact.
Note
The filename must have a “.js” extension.
3. Choose OK.
4. In the JavaScript file, provide the script.
Note
○ You can view/edit the JavaScript file by selecting the Script File link.
○ For more information about Code Editor, see Developing Applications.
4. Choose OK.
5. Save the workflow.
Related Information
You can insert scripts to use library functions to manipulate the workflow context.
To interact with the workflow context, use the predefined identifier '$.context'. Data that is stored in the
workflow context, for example, during the workflow start or from a previous script task, can be read, modified, or
enhanced using a dot-notation as shown in the examples below. Such data might consist of either primitive data
types that are supported by JavaScript (for example, a string or numeric value), or complex structures (for
example, objects or arrays).
In general, the workflow context can only contain data that can also be represented using the JavaScript Object
Notation (JSON). That is, the workflow context cannot store:
● Functions
● Prototype objects
● Special numbers, such as NaN (Not a Number), positive infinity, or negative infinity
Context changes are committed at the end of the script execution. Therefore, if the execution of the script task
runs into an error, data that has been modified before within the same script task is not visible to subsequent
activities in the workflow. This section describes how to interact with primitive variables in the workflow context.
For complex structures, see Related Information.
Setting Variables
Removing Variables
// The workflow context can be cleared completely. The $.context API will continue
to exist, but all variables will have been removed.
$.context = null.
// The workflow context can be completely overwritten, by setting it to an object,
whose properties are becoming the new context variables.
$.context = {newField: "new value"};
Complex structures can be, for example, objects and arrays and you can create and use to manipulate such
structured data. For more information, see the Related Links.
You can insert scripts to modify the workflow context, for example, to transform data from one representation to
another, and also to read and set values.
For working with objects in JavaScript, the following sample scripts are available:
Constructing Objects
Object Conversions
You can insert scripts to modify the workflow context, for example, to transform data from one representation to
another, and also to read and set values.
For working with arrays, the following sample scripts are available:
Constructing Array
Manipulating Array
Script tasks cannot modify the $.info API. All its properties are provided by SAP Cloud Platform Workflow and
are read-only.
3.3.4.3 Gateways
A gateway controls the flow of execution, and is represented visually as a diamond shape with an icon inside. The
icon shows the type of gateway.
SAP Cloud Platform Workflow editor supports the following gateway types:
● Exclusive gateway: Use an exclusive gateway to model a decision in the process. When the execution arrives
at this gateway, all outgoing sequence flows are evaluated in the order in which they are defined. The sequence
flow with a condition that evaluates to true is selected for continuing the process.
If multiple sequence flow have a condition that evaluates to true, the first one defined is selected for
continuing the process. If none of the conditions defined for the sequence flow evaluate to true, then the one
marked as default flow is selected and the execution proceeds along that path.
Note
If you use an exclusive gateway to split flow into multiple sequence flows, then the same type of gateway
should be used to merge as well.
Note
Parallel gateway works on a logical level, it does not speed up the technical execution.
Note
If you use a parallel gateway to split flow into multiple paths, then the same type of gateway should be used
to merge as well.
Procedure
1. From the palette, choose Gateways Exclusive Gateway drop it on to the canvas.
2. In the Exclusive Gateway Properties area, provide a Name and Documentation for the gateway.
Note
A unique ID gets generated for every workflow artifact. This ID is in read-only mode.
3. On the canvas, create a sequence flow from the Exclusive Gateway icon to other flow objects.
Note
If there are more than one outgoing sequence flows from an exclusive gateway, then it is considered as a
split in the flow. Only in this case, you can view and configure the Sequence Flow Properties . The next step
of configuring a condition is only possible in case of a split scenario.
Related Information
Procedure
Note
A unique ID gets generated for every workflow artifact. This ID is in read-only mode.
3. From an exclusive gateway, provide a Condition to the outgoing sequence flow or mark the sequence flow as
Default.
Note
○ You can mark only one outgoing sequence flow as the default.
○ If you want a certain path to execute, for example, only if an employee does not belong to Germany. You
need to configure the sequence flow condition as ${context.employee.region!= “Germany”}. For more
information, see Expressions [page 49].
4. Choose Save.
Procedure
1. From the palette, choose Gateways Parallel Gateway , and drop the icon on to canvas.
2. In the Parallel Gateway Properties area, provide a name and documentation for the gateway.
Note
A unique ID gets generated for every workflow artifact. This ID is in read-only mode.
3. If you are creating a split, then create multiple outgoing sequence flows from the parallel gateway.
4. If you are creating a join, then create multiple incoming sequence flows to the parallel gateway.
5. Choose Save.
Procedure
1. In your workspace, choose Export from the context menu of the workflow project.
Note
You must also use this procedure to import any custom task UIs that are used in workflows .
Prerequisites
You have the WorkflowDeveloper role. For more information, see Authorization Configuration [page 99].
Procedure
A new workflow instance automatically uses the latest deployed version of a given workflow definition.
Workflow instances that have been started with a previous version of the workflow definition are not affected
by this change.
Note
○ Ensure that you save the workflow before deploying a workflow.
○ When deployment fails, you can view errors in the Console.
○ If the deployment fails, you can view the errors in the Problems view. For more information, see Using
the Problems View.
○ You can deploy a single workflow at a time.
In addition to the palette, you can use the speed buttons for quick and easy modeling. The speed buttons are
displayed around the flow objects. In the following figure you see a start event with the speed buttons around it.
The number and type of speed buttons that are displayed vary depending on the model element.
The following table contains all the different types of speed buttons and explains their function:
Table 49:
Note
When you select the sequence flow speed button, you must
drag it on the element that you want to connect to. If the
area is highlighted in green, then the element can be con
nected using a sequence flow. If the area is not highligted,
then the element cannot be connected using the sequence
flow.
3.3.8 Expressions
There are several places in the editor where you can enter expressions to extract data from the workflow context.
● To combine static texts and variables. These are, for example, shown as texts to the user to provide contextual
information (text expressions).
● To determine major task properties dynamically (property navigation)
● To determine the next steps when the control flow arrives at gateways (conditions)
The expressions you use must adhere to the syntax defined by the Java Unified Expression Language (JUEL). The
syntax to access data in the workflow context within a JUEL expression and via the Script Task API is aligned. The
following statements would address the same attribute stored in the workflow context:
For more information about the script task API, see Creating and Reading Workflow Context Structures [page 40].
Property navigation and text expressions typically occur in user tasks. See Configure User Tasks [page 29].
Example
Sample Code
{
"context": {
"employee": {
"name" : "Peter",
"peers" : [
{
"name": "Mary"
}
],
"region": "Germany",
"userId": "9899"
}
}
}
Besides the already described types of expression, there are several other types:
Notices
● When there are multiple expressions in a single field: if one of the expressions is incorrect or refers to a field
that does not exist, then none of the expressions in that field are replaced. For example, in the text expression
"Approval for ${context.employee.firstname} ${context.employee.lastname}", if the
employee's last name field does not exist, none of the expression is replaced.
● Once expressions in texts are resolved, that is, they are replaced with the actual text at runtime, the texts are
not changed if the process context changes at later point in time.
Recipient users
HTML5 App
Component URL
SAPUI5 Component
Related Information
As the workflow service includes REST-based APIs that let you access the workflow service runtime, you can
develop scenario-specific user interfaces (UIs) on top of these APIs.
The main use cases for such UIs include the following:
● Start UI: Triggers new workflow instance for a defined workflow definition.
● Task UI: Is plugged into My Inbox to represent a user task in the workflow definition.
Both types of UIs can be developed and deployed as HTML5 applications on SAP Cloud Platform. For more
information about developing HTML5 applications using the workflow editor, see SAP Web IDE.
The following diagram depicts the relationships between the involved HTML5 applications and the respective
subscriptions for My Inbox and the workflow service runtime. The different applications and subscriptions are
wired using destinations.
My Inbox includes two predefined routes, which you can use when developing UIs:
● /bpmworkflowruntime
/bpmworkflowruntime maps to the bpmworkflowruntime destination, which is configured by default for
your subaccount.
For more information, see Read Task Context Data [page 55].
For more information about routes, see Application Descriptor File.
● /html5apps
You can integrate the UIs into any HTML5 app and access them using /html5apps/<name_of_app>.
Related Information
With the custom task user interface (UI), endusers can access their workflow tasks in their inboxes.
Related Information
This is an overview of the series of steps you have to execute to create the custom task UI.
Procedure
1. Create an HTML5 application. For more information, see Creating an HTML5 Application in the SAP Cloud
Platform documentation.
2. Create a project using the SAPUI5 Application template.
For more information, see Creating a Project in the SAP Cloud Platform documentation but use XML as view
type.
3. Extend the application by modifying the webapp/Component.js file by doing the following:
a. Get the Task Instance ID [page 55]
b. Read Task Context Data [page 55]
c. Bind a UI Element to an Attribute of the Task Context JSON Model [page 56]
d. Adding Task Completion Buttons [page 57]
e. Get the Task Description [page 59]
The page element of the webapp/view/<view name>.view.xml should look similar to the following:
Sample Code
Sample Code
init: function() {
UIComponent.prototype.init.apply(this, arguments);
this.setModel(models.createDeviceModel(), "device");
startupParameters.inboxAPI.addAction({
action: "Reject",
label: "Reject"
}, function(button) {
this._completeTask(taskId, false);
}, this);
startupParameters.inboxAPI.addAction({
action: "Approve",
label: "Approve"
}, function(button) {
this._completeTask(taskId, true);
}, this);
},
Sample Code
_fetchToken: function() {
var token;
$.ajax({
url: "/bpmworkflowruntime/rest/v1/xsrf-token",
method: "GET",
async: false,
headers: {
"X-CSRF-Token": "Fetch"
},
success: function(result, xhr, data) {
token = data.getResponseHeader("X-CSRF-Token");
}
});
return token;
},
_refreshTask: function(taskId) {
this.getComponentData().startupParameters.inboxAPI.updateTask("NA", taskId);
}
Procedure
To get the task ID, add the following lines to the init function:
Sample Code
Procedure
1. Read the task context data via a REST service and create a JSON model from it.
For more information, see Task Data in the SAP Cloud Platform, Workflow Service API Documentation .
2. After the model has been created, set it as default model of the component so it can be used for data binding.
Procedure
1. Write the task context data via a REST service and create a JSON model from it.
For more information, see Task Data in the SAP Cloud Platform, Workflow Service API Documentation.
2. After the model has been created, set it as default model of the component so it can be used for data binding.
Procedure
1. To display a field of the task context on the custom task UI, add a text element to webapp/view/<view
name>.view.xml and bind it to the text attribute of the JSON model.
2. Replace the page element with this content:
Sample Code
This is an overview of the series of steps you have to execute to add task completion buttons.
Procedure
To call the task completion REST API, you have to retrieve an XSRF token first. You could, for example, use the
following function:
Sample Code
_fetchToken: function() {
var token;
$.ajax({
url: "/bpmworkflowruntime/rest/v1/xsrf-token",
method: "GET",
async: false,
headers: {
"X-CSRF-Token": "Fetch"
},
success: function(result, xhr, data) {
token = data.getResponseHeader("X-CSRF-Token");
}
});
return token;
}
Procedure
Example
In this example, the data contains a field named approved to indicate whether the task was approved or
rejected.
Sample Code
Procedure
To add buttons to the footer of the custom task UI, add these lines to the init function of webapp/Component.js:
Sample Code
startupParameters.inboxAPI.addAction({
action: "Reject",
label: "Reject"
}, function(button) {
this._completeTask(taskId, false);
}, this);
Results
The previously created function _completeTask is called in both actions but with different approval status.
Procedure
1. Refresh the Master view of the inbox after a task has been completed, so the completed task disappears from
the list.
Sample Code
_refreshTask: function(taskId) {
this.getComponentData().startupParameters.inboxAPI.updateTask("NA",
taskId);
}
Sample Code
init: function() {
UIComponent.prototype.init.apply(this, arguments);
this.setModel(models.createDeviceModel(), "device");
startupParameters.inboxAPI.getDescription("NA",
taskId).done(function(dataDescr){
contextModel.setProperty("/context/task/Description",
dataDescr.Description);
}).
fail(function(errorText){
contextModel.setProperty("/context/task/Description", "");
jQuery.sap.require("sap.m.MessageBox");
sap.m.MessageBox.error(errorText, { title: "Error"});
});
},
Sample Code
onInit: function() {
var startupParameters = this.getComponentData().startupParameters;
startupParameters.inboxAPI.setShowFooter(false);
},
You can show, hide, and customize the Back navigation button in the header of a custom task UI.
● To show the Back navigation button in the header of a custom task UI, your onInit function of the View
controller should be the following:
Sample Code
onInit: function() {
var startupParameters = this.getComponentData().startupParameters;
Passing only the first parameter true will start the default button handler, which will execute
window.history.back().
In some cases, this does not lead to the desired behavior. Therefore, you need to provide a custom handler, as
shown in the next example
○ If you want to further customize your back navigation handler, you can edit your onInit function of the
View controller as follows:
Sample Code
onInit: function() {
var startupParameters = this.getComponentData().startupParameters;
startupParameters.inboxAPI.setShowNavButton(true, function(){
alert("You are about to leave this task");
window.history.back();
});
},
● To hide the Back navigation button in the header of a custom task UI, your onInit function of the View
controller should be the following:
Sample Code
onInit: function() {
var startupParameters = this.getComponentData().startupParameters;
startupParameters.inboxAPI.setShowNavButton(false);
},
To show, for example, contextual information that is not available in the workflow context, you want to call the
REST service, which you developed yourself, from within a custom task UI.
Prerequisites
Your REST service is deployed on SAP Cloud Platform or is reachable from your customer account.
Procedure
1. In your HTML5 application containing the custom task UI, define an additional route in the neo-app.json file,
which targets a destination pointing to your service, for example, deployed as a Java application on SAP Cloud
Platform.
…
{
"path": "/external-service",
"target": {
"type": "destination",
"name": "external-service",
"entryPath": "/"
},
"description": "External Service"
}
…
2. In your account that is subscribed to the workflow service, create a new destination with the name you
specified in the previous step.
3. Configure the destination against your deployed service.
Note
If you want to propagate the user from My Inbox to your REST service, select App2App SSO as the
authentication type to use.
4. In your custom task UI application, call your REST service using an Ajax call. The service is then available at the
following URL: /html5apps/<taskui_application>/<destination_name>/<relative_api_path>
Sample Code
_callService: function() {
$.ajax({
url: "/html5apps/custtakui/external-service/v1/external-data",
method: "GET",
contentType: "application/json",
async: false,
data: ""
});
}
You deploy your HTML5 app using standard SAP Cloud Platform procedures.
Procedure
For more information, see Deploying Your App to SAP Cloud Platform in the SAP Cloud Platform documentation.
The use case here is as follows. There is a particular workflow definition deployed into the workflow service
runtime. A user interface is needed which would allow the end users to start the instances of the corresponding
workflow. In addition, the users must be able to specify some arbitrary values that will be used in the contexts of
the started instances.
Prerequisites
Procedure
Related Information
You create your HTML5 app using standard SAP Cloud Platform procedures.
Procedure
For more information, see Creating an HTML5 Application in the SAP Cloud Platform documentation.
2. Create a project using the SAPUI5 Application template.
For more information, see Creating a Project in the SAP Cloud Platform documentation.
You have to define the destination route for the workflow service in the application configuration file.
Procedure
In the neo-app.json file created in the webapp folder of your application, include the following destination route
element pointing to workflow service runtime into the routes array:
Sample Code
{
"path": "bpmworkflowruntime",
"target": {
"type": "destination",
"name": "bpmworkflowruntime",
"entryPath": "/workflow-service"
},
"description": "Workflow Service Runtime"
}
Context
The view contains an input field, a button, and a text field. By pressing the button, a user starts a workflow
instance. The value of the input field will be used in the workflow context. The response of the workflow start
request will be printed out in the text field.
Procedure
In the view XML file created in webapp/view folder of your application, substitute the existing page element with
the following code:
Sample Code
Procedure
In the controller JS file created in webapp/controller folder of your application, include the following functions
as the fields of the second parameter of the Controller.extend function call:
Results
Sample Code
{
onInit: function() {
this.getView().setModel(new sap.ui.model.json.JSONModel({
text: "",
result: ""
}));
},
startWorkflow: function() {
var token = this._fetchToken();
this._startInstance(token);
},
_startInstance: function(token) {
var model = this.getView().getModel();
var text = model.getProperty("/text");
$.ajax({
url: "/bpmworkflowruntime/rest/v1/workflow-instances",
method: "POST",
async: false,
contentType: "application/json",
headers: {
"X-CSRF-Token": token
_fetchToken: function() {
var token;
$.ajax({
url: "/bpmworkflowruntime/rest/v1/xsrf-token",
method: "GET",
async: false,
headers: {
"X-CSRF-Token": "Fetch"
},
success: function(result, xhr, data) {
token = data.getResponseHeader("X-CSRF-Token");
}
});
return token;
}
}
During initialization a data model should be assigned to the view. In this example, the model is represented by an
object with two fields: text and result. The text field refers to the input of the user, which will be used in the workflow
instance context while starting. The result field refers to the string representation of the response to the workflow
start request:
Sample Code
onInit: function() {
this.getView().setModel(new sap.ui.model.json.JSONModel({
text: "",
result: ""
}));
}
To call the workflow start REST API, the request needs an XSRF token. The following function can supply the token:
Sample Code
_fetchToken: function() {
var token;
$.ajax({
url: "/bpmworkflowruntime/rest/v1/xsrf-token",
method: "GET",
async: false,
headers: {
"X-CSRF-Token": "Fetch"
},
success: function(result, xhr, data) {
token = data.getResponseHeader("X-CSRF-Token");
}
});
return token;
}
The workflow is started using the corresponding HTTP call to the workflow service REST API, see Workflow Service
API documentation. In this example, the input of the user is used in the context of the workflow instance: namely,
in its text field. In addition, the response of the call is assigned to the corresponding property in the data model:
Sample Code
_startInstance: function(token) {
var model = this.getView().getModel();
var inputValue = model.getProperty("/text");
$.ajax({
url: "/bpmworkflowruntime/rest/v1/workflow-instances",
method: "POST",
async: false,
contentType: "application/json",
headers: {
"X-CSRF-Token": token
},
data: JSON.stringify({
definitionId: <your workflow ID>,
context: {
text: inputValue
}
}),
success: function(result, xhr, data) {
model.setProperty("/result", JSON.stringify(result, null, 4));
}
});
}
Feel free to change the name of the text field of the workflow context to fit to the corresponding workflow
definition.
The logic described above is triggered when a user presses the button:
Sample Code
startWorkflow: function() {
var token = this._fetchToken();
this._startInstance(token);
}
You can associate a custom task UI to a workflow user task, which is then rendered in the detail view of My Inbox
for the task.
When you select a task, My Inbox instantiates the custom task UI application component and transfers a set of
data for the selected task.
Sample Code
startupParameters{
taskModel: JsonModel > ({InstanceID:<value>, TaskDefinitionID:<value>,.....}),
applicationPath: <string>,
queryParameters: {<key>:<value>,<key>:<value>,...... },
inboxAPI:{<APIs>}
}
Table 51:
applicationPath single-value string data Contains the path to the Task UI compo
nent using which the component is
loaded.
From the Task UI component, this data can be accessed as shown below:
Sample Code
var
startupParameters=this.getOwnerComponent().getComponentData().startupParameters;
Task data is transferred from My Inbox to the task application on startup using the property taskModel.
● SAP__Origin
● InstanceID
● TaskDefinitionID
● TaskDefinitionName
● TaskTitle
● Priority
● PriorityText
● Status
● StatusText
● CreatedOn
● Processor
PriorityText and StatusText contain translated texts that are specific to the My Inbox user's locale.
You can use a set of APIs to integrate your task application with My Inbox.
addAction
Properties:
● action : string
● label : string
● type : string (either Accept or Reject)
Return Value
getDescription
Retrieves the task description and returns a promise that is resolved when the task description is retrieved.
SAPOrigin string Value for the parameter SAP__Origin for the specific task
taskInstanceId string Value for the parameter InstanceId for the specific task
Return Value
Promise: A promise that is resolved when the task description is retrieved. It is rejected with an error if the
parameters SAPOrigin or taskInstanceId are passed with empty value or if the task description could not be
retrieved (due to network issues).
Return Value
success : A boolean representing successful removal of the button from the footer
updateTask
Updates the task in the master task list and returns a promise that is resolved when the task list is updated.
SAPOrigin string Value for the parameter SAP__Origin for the specific task
taskInstanceId string Value for the parameter InstanceId for the specific task
Return Value
Promise: A promise that is resolved when the task list is updated. It is rejected with an error if the parameters
SAPOrigin or taskInstanceId are passed with empty value or if the task list could not be updated (due to network
issues).
setShowFooter
showFooter boolean Flag representing whether to show or hide footer in the page.
The default value is false.
setShowNavButton
The REST-based API allows a tight integration of tasks on SAP Cloud Platform with SAP Cloud Platform Workflow.
With the workflow service you, as a developer, can integrate workflow-related operations into your applications.
The workflow service API supports the following functions:
For more information about who can execute these actions, see Authorization Configuration [page 99].
For more information about using these actions, see the Workflow Service API documentation on the product page
or the SAP Cloud Platform Workflow API hub documentation.
Clients must authenticate to use workflow service APIs. The following authentication types are supported:
● Basic authentication.
● SAML2
● OAuth2 (client credentials, authorization code, and SAML 2.0 Bearer Assertion Flow for OAuth 2.0)
Related Information
Call workflow service APIs using OAuth 2.0 authentication (client credentials flow).
Prerequisites
● Create a new client in SAP Cloud Platform cockpit for your subaccount using the following data:
Table 58:
Subscription <SAP provider account>/bpmwork Creates the OAuth 2.0 client in the con
flowruntime text of your workflow service subscrip
tion.
Authorization Grant Client Credentials Specifies the OAuth 2.0 flow that is
used to request the access token and
authenticate the API call.
For more information, see Register an OAuth Client in OAuth 2.0 Configuration.
● Assign the necessary role of the workflow service API that you want to use to call to a user named
oauth_client_<clientID>. For more information about roles, see Authorization Configuration [page 99].
Context
Note
The workflow service does not define any OAuth 2.0 scopes. Instead, assign the existing roles to the user who
executes the service calls.
Procedure
Example: https://oauthasservices-<your_account>.<landscape_host>/oauth2/api/v1/
token?grant_type=client_credentials
b. Authenticate the call using basic authentication, where the user name corresponds to your OAuth client ID
and the password to the client secret.
Call workflow service APIs using OAuth 2.0 authentication (authorization grant flow).
Prerequisites
● Create a new client in SAP Cloud Platform cockpit for your subaccount using the following data:
Table 59:
Subscription <SAP provider account>/bpmwork Creates the OAuth 2.0 client in the con
flowruntime text of your workflow service subscrip
tion.
Authorization Grant Authorization Code Specifies the OAuth 2.0 flow that is
used to request the access token and
authenticate the API call.
For more information, see Register an OAuth Client in OAuth 2.0 Configuration.
● Assign the necessary role of the workflow service API that you want to call to the user on whose behalf the call
to the workflow service API is executed. Typically, this is the user who authenticates the call to the OAuth 2.0
authorization endpoint below. For more information about roles, see Authorization Configuration [page 99].
Context
Procedure
The access token is sent to the URL that you specified as callback URL in the client details.
c. Copy the access token from the HTTP response.
2. Request an access token from the OAuth 2.0 authorization server.
a. Send a POST request to the token endpoint and specify the grant type as client credentials. To determine
the endpoint URL in the cockpit, see Security OAuth Branding OAuth URLs .
Example: https://oauthasservices-<your_account>.<landscape_host>/oauth2/api/v1/
token?grant_type=authorization_code&code=<access_token>
b. Authenticate the call using basic authentication, where the user name corresponds to your OAuth client ID
and the password to the client secret.
c. Copy the access token from the HTTP response.
3. Perform the call to the workflow service API by sending the access token as the header:
○ Header name: Authorization
○ Header value: Bearer <access token>
The URL of the host has the following format: https://<host>/workflow-service/rest. To work with the
API actions, you must determine the specific URL.
Context
Note
If you access the workflow APIs from an HTML5 app, you need to use another URL. Instead of directly referring
to the subscription URL defined in the destination shown above, you have to refer to an HTML5 destination
route.
If you develop a custom task UI, you can leverage the existing destination route in My Inbox. For an example of
how to access the workflow API from a custom task UI, see Creating an HTML5 Application for the Custom Task
UI [page 53].
If you develop an HTML5 app from scratch, you have to define a new destination route on your own. For more
information, see Define the Destination Route [page 64].
You can modify a context of a workflow instance in RUNNING, ERRONEOUS, or SUSPENDED status.
Note
● If the context of a workflow instance is in COMPLETED or CANCELED status, the system does not allow you
to modify it.
● We recommend suspending the workflow instance first and ensure that further entries are not written into
the corresponding execution log. Then the context modification is considered safe from collisions with any
ongoing workflow instance activities. After the necessary changes to the context are performed, you can
resume the workflow instance execution. See the section about suspending or resuming workflow instance.
For more information, see /v1/workflow-instances/{workflowInstanceId}.
Override Context
Overriding a context of the workflow instance removes the contents of the context before performing the override
operation. It is substituted with the payload of the operation.
Example
Context contents before overriding:
Sample Code
{
variableOnlyInOldContext: 1,
variableOverriden: "good bye!",
variableNestedObject: {
variableNested: true,
variableNestedInOldContext: 1000
}
}
Override operation payload:
{
variableOverriden: "hello!",
variableNestedObject: {
variableNested: false,
variableNestedNew: "new value"
Context contents after the override operation (equals the payload of the override operation):
Sample Code
{
variableOverriden: "hello!",
variableNestedObject: {
variableNested: false,
variableNestedNew: "new value"
},
variableNew: "I'm new"
}
Patch Context
Patching a context of the workflow instance merges the contents of the context before performing the override
operation with the payload of the operation.
● A variable is present in the workflow instance context and in the operation payload. After the operation is
performed, the value of this variable in the workflow instance context is equal to the corresponding value in
operation payload.
● A variable is present in the workflow instance context, but not in the operation payload. After the operation is
performed, the variable remains unchanged.
● A variable is not present in the workflow instance context before performing the operation, but it is present in
the operation payload. After the operation is performed, the variable is added in the workflow instance context
with the corresponding value.
Note
Merging happens at all levels of complex objects nesting.
Example
Context contents before patching:
Sample Code
{
variableOnlyInOldContext: 1,
variableOverriden: "good bye!",
variableNestedObject: {
variableNested: true,
variableNestedInOldContext: 1000
},
variableNew: "I'm new"
}
Sample Code
{
variableOverriden: "hello!",
variableNestedObject: {
variableNested: false,
variableNestedNew: "new value"
},
variableNew: "I'm new"
}
Sample Code
{
variableOnlyInOldContext: 1,
variableOverriden: "hello!",
variableNestedObject: {
variableNested: false,
variableNestedInOldContext: 1000,
variableNestedNew: "new value"
},
variableNew: "I'm new"
}
Consider the naming conventions for context variables. For more information, see Conventions [page 19].
The workflow execution log contains details about the execution history of a workflow instance.
The workflow execution log collects information that might be of use or interest to either a business user or an
administrator. However, it is not a technical log.
When working with the workflow service, you may encounter issues that prevent access or affect performance.
Related Information
End Users Can't Open SAP Fiori Launchpad Tiles [page 80]
Error When Clicking "Go to Service" on Portal Tile [page 82]
HTTP Status 403: User Doesn't Have Sufficient Privileges [page 82]
Tasks Not Appearing [page 82]
myinbox Application Not Found [page 83]
Error During Workflow Deployment in SAP Web IDE [page 83]
No Permissions Granted [page 84]
Error in JavaScript Files [page 84]
Symptom
When SAP provides a new version of an HTML5 UI component, for example, the Monitor Workflows app or My
Inbox, end users may no longer be able to open the tiles for these applications. Whether or not an updated tile can
be opened depends on the user’s HTML5 cache status in the SAP Fiori launchpad. The open action fails with an
error message, for example: Could not open app. Please try again later.
Cause
The cache in the SAP Fiori launchpad service component references a previously used version of the affected
HTML5 application. After an update, the previous version is no longer available.
Solution
Clear the cache using a user account that has permission to run the cockpit application and to edit the SAP Fiori
launchpad configuration for the given tenant.
1. In your browser, open the SAP Cloud Platform cockpit for the affected account.
2. In the navigation area, choose Services , then choose the Portal Service tile.
5. In the navigation area, choose Settings. Choose Actions, then choose Clear HTML5 Application Cache.
Result
End users can now reload their SAP Fiori launchpad and use the tiles again.
Symptom
When you chose Go to Service on the Portal tile in the services overview of the SAP Cloud Platform cockpit, . you
see the following error: The site cannot be displayed due to insufficient privileges as shown
below.
Solution
Result
When you now choose Go to Service on the Portal tile, the landing page of the Portal service opens.
Symptom
Solution
Symptom
You can't see the tasks you've created, even though you directly assigned your user as a recipient user.
Solution
Symptom
You can't find the myinbox app while you're configuring the app.
Solution
1. Log in as a user who is a subaccount member to the SAP Cloud Platform cockpit.
2. In the navigation area, choose Applications HTML5 Applications .
3. In the list of HTML5 applications, check whether a myinbox application is available.
4. Ensure that the app's state is started.
Symptom
You see the following error message while you are deploying the workflow editor on SAP Web IDE:
Solution
See the list of possible causes for the failure and the respective solutions:
● The workflow service isn't enabled. To enable the workflow service, see Configure the Workflow Service [page
85].
● The destination isn't configured correctly. To configure the destination, see Configure the Destination [page
22].
Result
After performing these steps, you should be able to deploy the workflow again.
Symptom
JavaScript files in the workflow project show an error on exceeding 10000 characters in the Problems view.
Workflow project also contains JavaScript files that are not used in a script tasks of workflow.
Solution
A rule is applied to all the JavaScript files used in the workflow project. This rule throws an error when the
JavaScript files exceed a character length of 10000. However, if you have JavaScript files that are not used in script
tasks in the workflow, you can manually disable this validation rule by following these steps:
Result
The Problems view should no longer throw this error on JavaScript files.
Symptom
You have assigned the appropriate roles in the SAP Cloud Platform cockpit; however, you still receive the following
message: No permission (forbidden).
Solution
Either log off using an action usually available in the top right corner and log on again, or clear your browser cache
to delete existing cookies.
New roles that are assigned to you are not applied to existing browser sessions; they do not take effect until after
you log in again to the SAP Cloud Platform Identity Authentication service.
4.1 Introduction
Related Information
Before you can use the workflow service, meet the prerequisites and execute the basic setup.
Prerequisites
Procedure
1. In the SAP Cloud Platform cockpit, enable the SAP Cloud Platform Portal and SAP Cloud Platform Workflow
services for your subaccount.
a. In the navigation area, choose Services.
b. Search for SAP Cloud Platform Portal.
c. On the Portal tile, choose Enable.
2. Search and enable the SAP Cloud Platform Workflow service.
Note
Both configurations are required to run the workflow service.
3. Decide which roles or permissions your users need, then assign those roles and permissions.
For more information about the available roles and permissions, see Authorization Configuration [page 99].
For more information, see Configure SAP Fiori Launchpad Objects [page 86].
Related Information
As an administrator, you can import SAP Fiori launchpad objects shared by the workflow service. These objects
include the Workflow and My Inbox catalogs.
Prerequisites
The configuration used for this procedure is only a sample. Depending on your requirements, the catalog
assignments and groups created might look different.
Procedure
1. Choose or create a site and prepare it to use standard workflow service content.
a. In the navigation area of the SAP Cloud Platform cockpit, choose Services Portal Service .
b. On the Portal Service tile, choose Enable, and then Go to Service.
c. In the navigation area, choose Site Directory.
d. Hover over the existing SAP Fiori launchpad site, and choose Edit.
2. To distribute the apps to all users, assign a role, for example, Everyone to the existing workflow catalog.
You can restrict access to apps using groups, so that, for example, only administrators can access the Monitor
Workflow and all users can access My Inbox.
a. In the navigation area, choose Content Management.
b. In the navigation area, choose Catalogs.
c. Select your Workflow Catalog, and choose Edit.
d. Choose Roles, and then choose the plus icon.
e. Select a role from the dropdown list, for example, Everyone.
For more information, see Creating and Configuring Roles in the SAP Cloud Platform documentation.
f. Confirm with OK, and choose Save.
3. For your users to see the newly created content, publish your site by choosing (Publish Site) in the upper
right corner.
4. To open the newly configured site, choose Site Directory, hover over the SAP Fiori launchpad site, and then
select the link on the site tile.
This is the link you typically share with your users so they can access the apps.
Results
The selected or created group name along with the app appears on the home page of the site.
To configure the SAP Fiori launchpad objects you need the TENANT_ADMIN role.
Procedure
1. In the navigation area of the SAP Cloud Platform cockpit, choose Services Portal Service .
2. Under Service Configuration, choose Configure Portal Service.
3. In the navigation area, choose Roles.
4. Select the TENANT_ADMIN role, and verify that your user is listed under User ID.
5. If your user ID is not listed, then assign this role to your user.
Context
By default, My Inbox application, as part of SAP Cloud Platform Workflow, is preconfigured to consume tasks from
the SAP Cloud Platform Workflow Service.
You can configure My Inbox to connect to another TCM-compliant OData service, different from the SAP Cloud
Platform Workflow Service.
This can be achieved by adding a new My Inbox application in the SAP Fiori Configuration Cockpit and maintaining
the respective tcmURL parameter.
Note
Please note that the URL parameter name is case sensitive.
Example
With the web-based administration Monitor Workflows app you can manage workflow instances and workflow
definitions.
The app offers two interlinked views, one for workflow instances and one for workflow definitions. Both can be
accessed using dedicated tiles in the SAP Fiori launchpad.
Prerequisites
● The SAP Fiori launchpad objects are configured. For more information, see Configure SAP Fiori Launchpad
Objects [page 86].
The workflow instances view shows a list of all running workflow instances.
● To search the workflow instances, use the following criteria: workflow ID, workflow definition ID, subject,
business key, or the initiator of the workflow instance.
● To display details about a workflow definition and to navigate to it, select a workflow instance.
● To retry the execution of failed steps of an erroneous workflow instance, choose Retry on the details screen of
the workflow instances.
● To cancel a running workflow instance, choose Cancel on the details screen of the workflow instances.
● To load more entries, scroll down to the end of the list and choose More.
● To filter the workflow definitions, use the following criteria: workflow definition ID, workflow definition name, or
the workflow definition version.
● To start a new workflow instance, select a workflow definition and choose Start New Instance.
When you start a new workflow instance, you can pass context data in form of a JSON string.
The JSON structure contains the content to be passed to the workflow context. In contrast to the workflow
service API a context node as a wrapper is not required.
Note
In the workflow context, use numbers where computations or comparisons on them are required. We do not
recommend to use numbers as IDs, especially not for business keys. Use a string instead.
For more information about using these actions, see Workflow Service API documentation.
● To navigate to the list of all instances of a definition, select the definition from the list and choose Show
Instances.
● To download the workflow model, select the definition from the list, then choose Download Workflow Model.
With this you retrieve the workflow model for the latest deployed version of a workflow definition.
Prerequisites
You have the WorkflowTenantOperator role that allows you to export runtime data related to workflow definitions
and workflow instances.
Context
Caution
The export does not contain technical details that are required to reimport the data to the workflow service.
There are two types of data that you can export from the workflow service:
Procedure
For more information, see Determine the Service Host [page 75].
2. To export the data, enter the following URL: https://<host>/workflow-service/rest/v1/export.
Results
Caution
To verify that the export completed successfully, please check that you can extract the zip archive. The archive
should not contain a file named error-log.txt. If there is an error-log.txt file, the exported data might
be corrupt. Check the file for details.
● A readme.txt file that contains meta information about this specific export.
● A workflow-definitions.json file that contains a list of the latest deployed workflow definitions.
● A workflow-instances.json file that contains a list of all workflow instances available on the system.
● A workflow-instance-data folder: For each workflow instance on the system one file (<workflow-
instance-ID>.json) is written. It contains the latest version of the context and the execution logs related to
this instance.
5.1 Introduction
The user guide for the SAP Cloud Platform Workflow service is for end-users and key-users.
You can process tasks from workflow service within My Inbox. My Inbox application runs on the SAP Fiori
launchpad. You can use My Inbox on your desktop or mobile.
A user task is a type of flow object in the process that appears in My Inbox. You can work on the task, complete the
task instance and view description of the task.
My Inbox displays the following information about the workflow and tasks:
● Task title
● Tasks with status Ready and Reserved
● Tasks with priority
Key Features
Note
When you claim a task, you become its processor and its other recipients will no longer see it in My Inbox. In
this case, the status of the task changes from Ready to Reserved.
Note
Please note that the filtering by due date and task type is not supported. The task list will be filtered by "All"
and "Standalone tasks" instead. The task list is limited to the first 1000 entries that match the filter.
Note
Please note that the grouping by task type is not supported. The task list will be grouped by
"TaskDefinitionName" instead.
Note
When you release a task, you are no longer assgined as a processor of this task and it becomes visible in My
Inbox for its other recipients. In this case, the status of the task changes from Reserved to Ready.
Prerequisites
● An SAP ID user and access to an SAP Cloud Platform trial or global account. For more information, see Getting
a Global Account.
● Assign the relevant workflow service runtime roles to the SAP ID user. For more information, see Authorization
Configuration [page 99]
● Subscribe to the SAP HANA Platform, Portal service.
● Enable My Inbox app in the SAP Fiori Launchpad for users to access the application. For more information, see
Configure SAP Fiori Launchpad Objects [page 86].
This guide provides an overview of the security-relevant information that applies to the SAP Cloud Platform
Workflow.
It does not replace the administration guide that is available for productive operation.
Related Information
6.1.1 Architecture
The architecture of the workflow service comprises several components and subservices.
For more information, see Multitenant Applications in the SAP Cloud Platform documentation.
● A subscription to the Portal Service respectively the SAP Fiori launchpad is required to use My Inbox.
● While the workflow service runtime exposes a set of REST-based application programming interfaces (APIs)
for managing workflow instances and task instances, the workflow editor, the Monitor Workflows app, and My
Inbox provide user interfaces (UIs) only.
● Access to all subservices of the workflow service requires a valid user identity in the corresponding identity
provider configured in the customer subaccount.
For more information, see Identity Provider and Identity Management [page 98].
● All UIs offer single sign-on authentication based on SAML assertions. The APIs of the workflow service runtime
can be accessed with SSO authentication using SAML as well as basic authentication. In addition, all APIs that
can lead to data manipulation in the workflow service runtime are protected against cross-site request forgery
(XSRF).
For more information, see the API documentation of the REST-based API.
For identity management and authentication, the workflow service relies on the identity provider (IdP) that is
configured in the customer subaccount that owns the respective subscriptions.
All requests handled by the workflow service subscriptions are authenticated against the identity provider of the
customer subaccount and authorized against the role assignments specified on the subscriptions in the customer
subaccount. All users who need to interact with the various subservices of the workflow service must be available
in the respective identity provider. You can replace the default SAP Cloud Platform Identity Authentication service
with your own corporate identity provider.
Note
For SAML-based authentication, you can use an additional corporate identity provider. Requests that use basic
authentication are still handled by the SAP Cloud Platform Identity Authentication service.
For more information about the concepts and the necessary configuration steps, see Identity and Access
Management in the SAP Cloud Platform documentation.
To assign the necessary roles to its users, the workflow service relies on the standard functionality of SAP Cloud
Platform and the My Inbox application relies on the authorization management of the back-end system.
For information about assigning roles and permissions, see Configure the Workflow Service [page 85].
Assign roles to specific users using the subscription to the workflow service runtime (Java application).
Table 61: Available Roles for Accessing the Workflow Service Runtime
Role Description
WorkflowInitiator ● Permission to start workflow instances (using the API or the Monitor Workflows
app)
● Retrieve an XSRF (cross-site request forgery) token as a prerequisite to start work
flow instances
WorkflowMessageSender Permission to send a message to a set of workflow instances for consumption in inter
mediate message events
Description
Access to the workflow editor application is secured by permissions. The WorkspaceUser permission grants
access to the workflow editor.
Note
You can create a group with the required users who can model and deploy workflows, and assign the following
roles to the group:
● WorkflowDeveloper role
● A role with WorkspaceUser permission
For more information about assigning permissions, see Configure the Workflow Service [page 85].
Note
Permissions are required to only access the standalone workflow service editor.
Note
If you configured your own custom identity provider (Identity Provider and Identity Management [page 98]) you
need to additionally change the role assigned for the workflow editor. For this, create a new role for the editor
subscription in the SAP Cloud Platform cockpit and assign users from your custom identity provider to the new
role.
Related Information
6.1.4 Destinations
The destinations are generated and configured when enabling the workflow service in a customer subaccount.
Principal Propagation
Communication between the different subservices uses principal propagation, which forwards the user who is
logged on to the user interface to the workflow service runtime. This lets all requests that are sent to the workflow
service runtime on behalf of the user (who initiated the request from the user interface) be posted.
Principal propagation is automatically enabled when you enable the workflow service in a customer subaccount
For more information about the concepts and the necessary configuration steps, see Application-to-Application
SSO Authentication in the SAP Cloud Platform documentation.
The workflow service supports outbound connectivity to orchestrate external services and systems. Destinations
decouple modeling service tasks in your workflow model from the configuration of the physical back-end systems
that are called in the service task at runtime.
While the standard destination concept in SAP Cloud Platform can be used for this purpose, there are several
limitations that apply to their usage in the context of the workflow service.
The following destination features are supported in SAP Cloud Platform Workflow:
To connect to on-premise back-end systems, you can use the SAP Cloud Platform cloud connector. For more
information on how to install and configure the SAP Cloud Platform cloud connector, see SAP Cloud Platform
Connectivity in the SAP Cloud Platform documentation.
Use the standard SAP Cloud Platform mechanisms in the SAP Cloud Platform cockpit to configure destinations.
For more information, see Configuring Destinations from the Cockpit.
Note
For server verification additional properties that were configured at the destinations as described in Server
Certificate Authentication are ignored. Consequently, you cannot turn off trust verification, and host names are
always verified in strict mode.
If you use the OnPremise proxy type to connect to an on-premise back-end system, make sure that you specify
the URL of the vitrual host maintained in the SAP Cloud Platform cloud connector as URL of the destination
instead of the actual URL of the back-end system. The scheme of the specified URL must be http://, not
https://.
While the configuration data of destinations are stored completely within the customer subaccount, the workflow
service runtime must temporarily access this data when executing a workflow instance. This data is not persisted
within the workflow service itself.
The workflow service applies the legally required data protection and privacy measures to data that is stored on
behalf of customers. These measures include, for example, the "need to know" principle during support processes,
or data isolation between tenants.
These measures apply to all technical subservices provided by SAP that make up the workflow service.
However, customers can define workflows that call external services that are outside SAP. These services must
implement appropriate data protection and privacy measures to avoid externally exposing critical data from SAP
systems. These services must also be integrated in an appropriate way into the workflows that are running on the
workflow service.
Caution
SAP Cloud Platform Workflow does not provide any support for storing and processing personal or sensitive
data in the workflow context. It is the responsibility of the developers on customer side to decide what kind of
data is stored in the workflow context.
The workflow service generally supports customers who are executing workflows in which employees or other
persons in a suitable contractual relation with the customer take part. Customers might require explicit consent
from workflow participants outside of such contractual relations, if their data is to be processed through the
service. Depending on how the data that is generated while using the service is used, customers might need to
require explicit consent from persons with contractual relations.
● Consider the workflow context to be a temporary storage. That is, data can remain in the workflow service only
for shorter periods than defined by company policies or mandated by law in systems of record
Suitable data deletion mechanisms that conform with company policies and applicable laws must be supplied.
● Authorization checks applied to a data item when accessed using the workflow service may differ from checks
performed when the item is accessed from a system of record, for example, with respect to role-based
authorizations.
Recommendation
Be aware of the following recommendations with respect to data protection and privacy:
● Configure destinations to use secure communication protocols, such as HTTPS, wherever possible.
● Working copies of data from systems of record that are stored in a workflow context should be limited to the
very minimum required for the processing.
● SAP does not provide any support for storing and processing personal or sensitive data in the workflow
context; the customer or developer is responsible for providing any of this support that is required.
Coding Samples
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system
environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and
completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, unless damages were caused by SAP
intentionally or by SAP's gross negligence.
Accessibility
The information contained in the SAP documentation represents SAP's current view of accessibility criteria as of the date of publication; it is in no way intended to be a
binding guideline on how to ensure accessibility of software products. SAP in particular disclaims any liability in relation to this document. This disclaimer, however, does not
apply in cases of willful misconduct or gross negligence of SAP. Furthermore, this document does not result in any direct or indirect contractual obligations of SAP.
Gender-Neutral Language
As far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as "sales
person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun does not
exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible.
Internet Hyperlinks
The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does not
warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any damages
caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. All links are categorized for transparency (see:
http://help.sap.com/disclaimer).