Create an API Trigger for the Process
- How to create an API trigger to start an instance of a business process from any service, like SAP Build Apps
Chaitanya Priya PuvvadaJanuary 27, 2023
Prerequisites
- Complete Acquire A Template Project From The Store OR
- Complete the mission Build Your First Business Process with SAP Build Process Automation
A business process is started by defining a trigger, an event that indicates to your SAP Build Process Automation tenant to start a process instance.
Process triggers can be either a form, such as a request form, or an API call, where an external system starts the process.
You can start an instance of your process using an API call, with the inputs for the call configured from the process builder. These inputs can then be used as input fields in your process.
- Step 1
Once you have completed the tutorial Acquire A Template Project From The Store, your process looks as below.
-
Open the process Order Processing.
-
From the Editable version of the Sales Order Approvals Dev Tutorial project, choose the three dots of the Order Processing Form and select Remove to delete the form.
A warning message will inform you that the related bindings will be removed. Choose OK.
Save the project.
-
To add an API trigger for the process, click on the + > API > New API Trigger.
Since the bindings are lost, all the artifacts are in error state. Once the API trigger is created, the bindings will be updated.
-
Enter the name of the trigger as Sales Order Trigger. Choose Create.
Log in to complete tutorial -
- Step 2
Select Sales Order Trigger, click on the Canvas, and choose Inputs. Then choose Configure to configure inputs.
In the Configure Process Inputs window, choose Add Input to add parameters.
Add the following parameter:
Name Type salesOrderDetailsSalesOrderApply changes.
Once the trigger is created successfully, you can view the trigger under the Triggers section in the Overview page.
You can edit, deactivate, or delete the API trigger properties from Triggers tab in the respective process builder overview.
Deactivate means that while the trigger exists in design-time, you cannot consume it in runtime.
Delete will permanently delete the trigger from design-time, but for already deployed processes the trigger will still exist at runtime.
In general, any changes in the trigger will be affective only when the process is released and deployed.
Note: All the API triggers that are created in that project will be shown.
Save the project.
- Step 3
Since you have created an API trigger, the bindings were lost as mentioned in Step 1. Let’s adjust the process with the new inputs configured for the API trigger.
Choose the condition artifact and click on Open Condition Editor.
Enter the condition for the
orderAmount.
Click on Apply.
Choose Approval Form to adjust the bindings.
Modify the General section. Since the process would be started through an API, remove the Users Process Started by and enter your
EmailIDthat was configured for the tenant.
Modify the Inputs section.
Choose Order Confirmation Form to adjust the bindings.
Modify the General section. Since the process would be started through an API, remove the Users Process Started by and enter your
EmailIDthat was configured for the tenant.
Modify the Inputs section.
Choose Order Rejection Notification Form to adjust the bindings.
Modify the General Section. Since the process would be started through an API, remove the Users Process Stared by and enter your
EmailIDthat was configured for the tenant.
Modify Inputs section.
Choose Auto Approval Notification Form to adjust the bindings.
Modify the General section. Since the process would be started through an API, remove the Users Process Started by and enter your
EmailIDthat was configured for the tenant.
Modify the Inputs section.
Save your project.
Log in to complete tutorial - Step 4
Release the project.
After successful release of the project, deploy the project.
You have successfully released and deployed the process and it is ready to consume via APIs.
Log in to complete tutorial