Connectors define the connection (entry point) to an external system. Given such a connection, you might send several different requests to the connected system. We call one such concrete pair of request / response a “connector call”. In order to use a connector call in the edit mode of a user story (Process Designer), you must create at least one connector call for each connector.
To use a connector within an app, you have to configure a specific connector call and assign data types within the configuration! Otherwise the connector will not be visible in the Process Designer.
Choose a connector from the overview and click the call icon. In the call overview add a new call for each connector operation.
For SOAP and SQL connectors, you have the possibility to use the Connector Wizard. It helps you to create your connector calls much easier and faster. If you click on it, you can choose the ones that you need.
Otherwise click on the plus icon in the upper right and enter a unique call name that describes the operation (e.g. read, write, update, delete, search, …).
Connector Call name
Unique name without spaces to describe the operation.
Description of the operation.
For configuring a connector call, you have to specify input and output parameters in the following tables:
Each connector call has its own specific parameters.
You can validate the Input and Output parameter in the backend. It validates:
- Base type against type security
- Domain type against security and restrictions
- Structures against type security and underlying property types
- Collections against type security and the underlying types / property categories
If the validation is not successful, the client is notified of all failed validations and it’s written to the Connector log or System log at the same time.
For every new Connector Call, this flag is set by default. Already existing Connector Calls do not have this checkbox flagged to guarantee the compatibility.
The technical path or name within a rest api definition or web service description language or csv header column.
A meaningful non-technical description for the technical parameter. This wording is used in the edit mode for a user story (Process Designer) for mapping data with ui elements.
Optional description of the parameter.
A constant value like SAP Client or company code that can’t be overwritten by any business apps. The value will be validated, so that it’s not possible to use a constant value with a wrong base type in Connector Calls and Buisness Objects.
Assigned Simplifier data type for validating data before it gets back or from a backend system.
After finishing the parameters, you can save the connector call settings.