Configure the SAP Cloud Platform connector in Bizagi

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Integrating external applications from Bizagi > SAP integration > SAP Cloud Platform using OData >

Configure the SAP Cloud Platform connector in Bizagi


Bizagi can be integrated with the SAP Cloud Platform using an out-of-the-box connector. This article explains how can you configure the SAP Cloud Platform connector in a Bizagi Studio project.


Before you start

To configure the connector you must have configured the services and connections in the SAP Cloud Platform. See How to configure SAP Cloud Platform for on-premises systems.


From this configuration, you must obtain the Application Route within the Cloud Foundry. See get the Application Route.


Bizagi has a Proxy configuration option available to connect with external services such as the SAP Cloud platform connector.


Configuration in Bizagi Studio

To set the SAP Cloud Platform connector, open the expert view and select the External Systems module. Open the SAP main node. You find two SAP connectors:


SAP Connector: R/3 and ECC systems using BAPIs.

SAP Cloud Platform: SAP Cloud Connector using OData services.


Right-click the SAP Cloud Platform, and select New SAP Cloud Platform Configuration.




In the Dispatcher Host, register the Application Route. Select the Basic Authentication type, select the SAP destination that points to your SAP System. When all parameters are configured, click Save.




You can edit or delete the configuration any time, right clicking the name of the configuration. To delete, there must be no dependencies with processes in Bizagi. That means, that the configuration is not being used in any process.


Define SAP Actions available for Bizagi Processes

Your SAP system can expose multiple OData endpoints. Each endpoint can contain multiple actions, that Bizagi processes can invoke. You can define these actions in your connector. To do so, right click the name of your SAP configuration, and select Add new actions.




Bizagi displays the endpoints available through the OData layer of your SAP system. Each endpoint contains entity sets, and each entity set has actions that you can use in your Bizagi Processes. You can search for endpoints using the filter text box.





Open the endpoint to see the different entity sets. You can select each entity set by clicking the check box.





If you want to take out a service from the list, you can click the ( X ) icon next to each service name. After you review all the services , click Next.



If there is an error displaying the services after selecting them, can be because the service is exposed as metadata, but the entity set is not available.


Configure Actions

SAP exposes actions within Entity Sets. One Entity Set can have different HTTP actions that you can enable. Each entity set is configurable in the following aspects:


Change Entity set Name

Duplicate an Entity Set

Delete duplicated an Entity Sets

Define the Action type


Change the entity list Name

Clicking the pencil icon, you can edit the action name. This name is displayed when you set the action in a process.




After changing the name, click the check icon to save the name.





Duplicate an Entity Set

In the Entity Set list, on the left-hand side, you can see the duplicate icon next to each entity set. When you click the duplicate icon, all actions configured in that entity list are duplicated.




Delete duplicated Entity Sets

Only duplicated Entity Sets can be deleted. Next to the duplicated Entity List, you see the delete icon.




You can undo the deletion in the message box, located at the lower-right corner.




Define the Action Type and attributes

Similar to HTTP requests, each action has a set of possible execution types, that let either consult, update, or delete records associated with the entity set. For example, you can consult (GET) the information of SAP users.


Bizagi lets use the following action types:







When you click each action, Bizagi displays all the action types available for that entity set.  You can select ONE of the available Action Types. If you want different action types related to the same Entity Set, you can duplicate it.






An action type can be disabled due to SAP Cloud Platform restrictions. Disabled action types are displayed in grey.




When you click each action type, for example, GET, Bizagi displays two lists of attributes. These lists are attributes that can be obtained in the invocation of an action.


1. Optional attributes: These attributes can be added by the Bizagi user configuring the action. They can be added, or deleted in the configuration phase.

2. Fixed attributes: Bizagi displays these attributes as read-only, and shows the name of each attribute and the attribute type.


You can add optional attributes by clicking the plus symbol (+) next to the name of the attribute. When added, Bizagi displays them at the end of the attributes list. You can remove the attribute with the delete icon, on the right-hand side.



You can add or delete optional attributes. Other attributes are displayed as read only.




Optional attributes are usually an object, containing single attributes. When you click the option attribute hyperlink, Bizagi displays the list of single attributes contained.




When you finish defining optional attributes for each action type, you can click Finish.


Next Steps

Set the Bizagi process where you want to execute the SAP action