Create an empty business process to better understand how to release and deploy a process, and then start and monitor a process instance, as part of the SAP Build CodeJam.
Step 1Finish installing SAP Build Process Automation
—
You installed SAP Build Process Automation in Step 3 of the prerequisites tutorial. But the subscription to the service takes a long time and you may have skipped the final few actions in that step.
👉 If you did not complete that step, go back to the prerequisites tutorial, Step 3, Bullet 5 and finish adding the role collections to your user.
If in the next step of this tutorial you get the following error when creating your automation project, you did not complete the prerequisites.
No privileges
👉 If you completed that step, just continue below.
Step 2Create a process project
+
In the Build Lobby, choose Create.
Build Lobby
If you also installed SAP Build Code, you will get a dropdown after clicking Create. If so, click Create again.
Create
Choose Automated Process, and then click Next.
Build Automated Process
Choose Process, and then click Next.
Choose Automation Type
Enter the following:
Field
Value
Project Name
Purchase Approval
Description
My purchase approval project
Click Review.
Give Project Name
On the Summary page, click Create.
Create
You may get a disclaimer screen. If so, click Accept.
Disclaimer
Once the project is created, it will automatically try to create a process for the project.
For Name of the process, enter Purchase Approval Process.
Click Create.
Give Process Name
You may get a message about the new layout editor or other news. Click Close.
Docs
In your project, you will see an empty process with start and end nodes.
Empty Business Process
You will get in-app help to give you information about different parts of the user interface. If you click he questions marks around the screen, you can get additional information.
You can hide the help by clicking the information button in the top right of he screen, in the header.
Step 3Configure the process inputs
+
A process makes decisions based on data sent to it when it is triggered (the process inputs), as well as data from API calls made as part of the process (actions).
In this step, you will specify the inputs required for the process.
In later tutorials, you will create an action to get data from APIs.
Click the Purchase Approval Process tab.
Expand the side panel.
Business Process Side Panel
In Process Details (side panel to the right), click Variables.
Next to Process Inputs, click Configure.
Configure Process Input Parameters
In the Configure Process Inputs window, click Add Input 3 times to add space for the inputs.
Add Process Inputs
Add the following inputs as shown in the above screenshot, flagging them all as Required.
The Identifier field values – which are case-sensitive – are auto-populated. DO NOT CHANGE THESE.
Field Name
Type
Required
Order ID
String
☑️
Total
Number
☑️
Business Partner
String
☑️
The editor will remove leading and trailing spaces.
After adding all 3 inputs, the dialog should look like this.
Complete Adding Process Inputs
DOUBLE-CHECK that you set the Total field as a number, and made all the fields required.
Click Apply.
Click Save (upper right).
Save Process Inputs
Step 4Create API trigger
+
A business process can be started in several ways.
API: SAP Build Process Automation defines a common API so that other apps can trigger processes.
Event: An event from SAP S/4HANA Cloud – via SAP Event Mesh – can be set up to trigger a specific process.
Form: You can build a form to give to your users that can be filled in and submitted to trigger the process. That form is created within the same project. Forms can also be built with SAPUI5.
Schedule: You can simply schedule the process to start on a schedule.
For this process, we will create an API trigger so it can be started by an API call.
Click Add a Trigger.
Create a Trigger
Choose API Trigger.
Select Call an API
For the trigger Name, enter Purchase Approval Trigger.
Click Create.
Create API Trigger
The process inputs are automatically added to the trigger. Click the Trigger block, and expand the side panel.
Examine API Trigger Outputs
Note that API trigger’s Outputs are automatically synchronized from the process inputs, meaning that the API will send these inputs and the rest of the process can use them.
Step 5Release Project
+
To run the process, you must release and deploy it.
Releasing a project creates a version or snapshot of the changes, and deploying the project makes that version available in runtime to be consumed (or triggered). You can only deploy a released version of the project, and at a given time there can be multiple deployed versions of the same project.
Click Release (upper right).
Press Release Project
In the Release Project dialog, you can decide what type of change you are making, what version number to create, and a description of the changes in this version.
However, the first time you release the project, it will automatically be set to 1.0.0, and you can only add a description.
Click Release.
Confirm Release Project
At the top you have a dropdown that shows all the released and deployed versions, plus the current editable version.
Select the version you just released (1.0.0).
You could also click Show project version, which is displayed after releasing a version.
Examine Release Status Overview
This displays the released version.
Released version
Whenever you need to make changes to your process project, make sure you have the Editable version.
Versions
Step 6Deploy Project
+
Once the project is released – and you are viewing the released version – you will find a Deploy option on the top-right corner of the screen.
Click Deploy.
Examine Release Status Overview
You will be asked to select an environment. Select Public and click Deploy.
Deploy public
SAP Build Process Automation enables you to create multiple environments with different security so you can control who can run and update processes, generally for different lines of business. For this CodeJam, you will work with the default Public environment, which allows everyone to deploy processes to the environment and execute those processes.
For more information, go to the SAP Build lobby and then Control Tower > Environments, or see Environments.
A dialog is shown indicating what triggers will be created and deployed.
Click Deploy.
Deploy trigger
Deploying will take a couple of seconds/minutes depending upon how big your project is and how many artifacts it has. Any errors during deployment are displayed in the Deployment Console at the bottom of the screen.
Once the deployment is successful, you will see that this release has been deployed, and that it is the active version (since you can have deployed many releases).
Deployment Status
Go back to the SAP Build lobby, which should be open in one of your browser tabs.
Alternatively, you can return to the lobby from your project by clicking the SAP logo in the top-left corner.
Return to Lobby
Step 7Start a process instance
+
SAP Build Process Automation lets you trigger a process manually, generally so you can quickly test it.
In the SAP Build lobby, choose Control Tower.
Open Control Tower
Click Environments.
Environments
Select the Public environment.
Public environment
You will see all the projects with processes deployed to this environment.
Click More > Processes and Workflows.
Processes and Workflows
This area shows you all the processes that have been deployed. If you are using SAP Build Process Automation for the first time in your trial account, there is only one process and it is already selected.
If it isn’t selected, select it.
Deployed processes
For when you have many more processes, you can perform a free text search, or you can select the project and then see all the processes in that project.
With the process selected, you will see information about the process, most notably its ID. This ID must be passed whenever an API call is made to trigger the process, though SAP Build Apps will handle sending this ID for you.
Click Start New Instance.
Start process instance
This opens a dialog that lets you trigger a process – for testing – without using a form, API call, or external event. The dialog lets you provide the required inputs for the process, in JSON format.
IMPORTANT: You must provide the values for the inputs that you defined as “process inputs,” in JSON format. BUT … the example JSON you will see in the dialog is not related AT ALL to what you need to provide. Therefore, you will delete this JSON.
Instance inputs
Here’s a reminder of the Process inputs you defined in the Process Editor (in the JSON, you must use the same field identifiers in the JSON key value pairs):
Input IDs
Delete the JSON in the dialog, and replace it with the following:
If all goes well, you will get the message Instance started.
Success
If things didn’t go well, you may get the following:
Error
This is most likely because the identifier names or the types of the input parameters defined in the process do not match the data you just entered to start the process – for example, you sent a number for a string input.
One thing you may not have done is change the data type of the total input parameter to Number. If so, you must go back to the Editable version of your project, change the type for the total input, and release and deploy again. Or, you may have changed the identifiers for an input.
Step 8Monitor the Process
+
Once triggered, you can monitor the process instance from the Monitor section of the Monitoring tab.
In the same screen you triggered the process, click Show instances.
Show instances
You can also get to the same place with the menu by clicking Monitoring, and under Monitor clicking Process and Workflow Instances (likely first tile on the page).
You would then have to filter or search for your instance. The Show Instances button takes you there directly.
By default, completed processes are not shown in the list. And because you have no steps inside the process, it will start and immediately complete.
To see your instance, in the filters, click the dropdown for the Status filter, and select Completed.
Process instance
Now you should see your process instance.
Notice that because you navigated from your deployed process from the Control Tower, the list of processes is filtered for just that project (see highlighted filter).
Click on your process instance.
In the details section at the top, you can see:
When it started
When it completed
Who started it
ID of the instance
ID of the process, or “Definition ID”
Examine the Process Flow Context
Under Logs you can see all the events that occurred, such as its triggering, approval forms completed, API calls performed, and any other action that was taken as part of the process.
Under Context, you can see the data that was passed to the process, or that was retrieved during steps that involved data.
Congratulations! You have created your first SAP Build Process Automation process.
Share feedback on this tutorial or join the conversation in SAP Community.
Submit detailed feedbackDiscuss in Community
Steps
Step 1 of 9
1. Finish installing SAP Build Process Automation2. Create a process project3. Configure the process inputs4. Create API trigger5. Release Project6. Deploy Project7. Start a process instance8. Monitor the Process9. Further study
Joule
AI Notice
Joule is an AI assistant. Generative AI may produce inaccurate, incomplete, or biased information. Always verify important details before acting on them.
Conversations are sent to SAP-hosted large language models for processing. Do not include personal data, credentials, or confidential information in your messages.
Joule's responses are based on the SAP tutorial catalog and may not reflect the latest product changes. For authoritative guidance, consult the linked tutorials and official SAP documentation.