Setting up a First Digital Process
Start with building a first digital process.
Last updated
Was this helpful?
Start with building a first digital process.
Last updated
Was this helpful?
By going through this guide, you will create a digital process that responds to a Hello World event from a sender. The response is a feedback form that is first sent to the sender with a request for completion. In this case, the sender can be a customer whom we are asking for feedback. The digital process ends once the sender submits the feedback form. To successfully complete the trail, make sure to go through all the sections from top to bottom.
Digital Process involves an initiating event followed by subsequent steps. External events work as triggers for Digital Process to run, they are transmitted to an Orchestration Engine event-receiver endpoint. The subsequent process steps are basically a combination of actions following one after another making a whole process complete.
To start building a digital process, follow these steps:
Create a new Hello World event, with hello_world
as the event name, which works as its technical ID.
To create the event, go to OE -> Events -> Event Registry. For details, see the and guides.
Create a new digital process with the hello_world
event as a trigger.
To create the digital process, go to OE -> Digital Processes and choose Create digital process.
Add Hello World as a name for your process.
Choose the Hello World event as a trigger for the process.
Choose Publish to save the changes. When you choose publish, your changes are saved but the process is not active yet. To activate the process, use the active/inactive toggle in the digital process dashboard.\
To move to the next steps you need the data to be processed first. To do so, you need to send some data to OE to complete the event connection. You can do this using Postman, or with Celonis Action Flows.
You can check there all the details that must be included in the request.
Send the POST request, with {"hello" : "world"}
in the body content. The endpoint responds with 200 OK status and a payload to confirm a successful receipt.
Here's how the payload looks like:
If you receive 401, verify if your setup for the secret
is correct.
If you receive any other status, verify if the webhook source URL is correct.
Note down your request_id
, it may be useful later to search for the process in OE.
Add the OE module to your Action Flow.
Select the “Hello World” event type.
Send { “hello” : “world” }
as the payload.
Trigger the action flow.
To confirm a successful receipt, the endpoint responds with 200 OK status and a confirmation payload. Here's how the payload looks like:
If you receive 401, verify if your setup for the secret
is correct.
If you receive any other status, verify if the source
value is correct.
Note down your request_id
, it may be useful later to search for the process in OE.
Go to Digital Processes and open the debug mode of your Hello World digital process. You can do this from the main view by clicking the magnifier icon, or opening the process and choosing the Go to Debugger option. If the request worked, you should see the details of the instance run.
To confirm the data was received as expected, open the instance and check the logs.
After creating and validating the trigger event, we can now add a process step in the Hello World digital process. The process step includes a form prepared for the sender to add a feedback message.
Create a new form with Feedback as a name.
Add a new dropdown component and label it as Sentiment in the Display tab.
Go to the Data tab and configure the component to have three Data Source Values:
happy
sad
indifferent
Go to the Validation tab and flag the field with the dropdown as Required.
Save the configuration.
Add two separate text fields:
first with a First Name label - set it as required in the validation tab
second with a Last Name label
Save the form. You can also check its preview to see if all the fields are added.
Update the event that you sent previously with a new data: replyTo, where you add the email address as a value.
Send the updated event to OE. You can use Postman or Celonis Action Flow as in the previous step.
Go to debugger to check if the data was properly received.
Copy the Instance ID, we will use it in the next steps.
In the new process step, choose the Create New Scenario option.
This opens a new tab and redirects you to a scenario step template wizard in Make, with a starting module and completion event.
After going to Make, ensure you are working in the right organization. The name should reflect your tenant name in OE. To check if the organization is the correct one, it's enough to hover over the Make's sidebar, the name is visible at the top. Then, you can either click directly on the template to start working with it, or choose the Start guided setup option to continue.
If you click on any of the Make's sidebar nodes, it switches off the template and redirects you the selected section in Make. It's not possible to get back to the template.
Add a name for the scenario, in this example it's "Send a Survey on Hello World". Save the scenario to make sure the name is kept.
Add a webhook name in the Trigger Event module.
There's no validation requirement for the name, but we recommend to use the same name for the webhook as for the scenario. Without the webhook, the digital process is marked as invalid in OE.
The webhook connection is established automatically, but it may happen that you'll need to set it up manually. In that case choose Add next to the connection field in the Webhook module and provide there the Connection Name, Tenant ID and Event-Receiver Secret.
The tenant ID is the first part of the digital process ID, you can find it in two places:
Go to OE -> Admin -> Settings tab, the tenant ID is displayed next to the Make Team name.
Check the URL of your digital process instance.
The template shows that the last Make scenario step should be a completion event. To send the completion event, we need to create a new event in OE Management Dashboard. Go to OE -> Events -> Event Registry and create a new event with the following data:
Display name: Hello World Feedback Sent
Event name: hello_feedback_sent
Go back to your scenario editor in Make -> Completion Event module and select the connection.
Optional: If it happens that you don't have the connection established yet, you need to configure it in the module.
Choose Add next to the Connection field.
Provide the necessary data for the Event-Receiver Endpoint and Environment.
The data for the endpoint is the one from the Admin settings in OE, the data for the environment is the one that you can find in the Developer Portal in your API keys - OE API.
Select the newly created event as an Event Type. If you don't see the event, try to refresh the list.
Choose Continue. This creates the scenario, you can now add a relevant name for it, for example Send a Survey on Hello World.
Get the Make scenario to access the replyTo field. For this, you can use the Set Variable from Process Context module to extract the replyTo email address that we send in the payload, and assign it to a Variable called email.
Add the Set Variable from Process Context module and place it between the Trigger Event and Completion Event modules.
Assign the Data from the Trigger Event.
Select the Hello World digital process.
Use the Instance ID from the debugger (see step 4) as the Example Instance. You can select the ID from the drop-down list. The ID at the top is the one from the latest instance.
Enter email
in the Variable Name field.
Modify the Completion Module payload to include the email. In the Payload field, select Map as JSON String and add the JSON string. The email should point to the email settings from the Set Variable from Process Context module. For example: { "email" : "{{4.email}}"}
- if the reference is to email from module 4.
Save the scenario.
Go back to your Hello World digital process in OE and add the Send a Survey on Hello World scenario as the next process step.
Choose Publish and then activate the new version of the Hello World digital process.
Check if your digital process is activated and if it has a valid status.
Invalid status is usually caused by a missing webhook on the trigger module, or on improperly set up completion module.
OE revalidates each digital process with every new publishing.
To verify if you scenario works properly, do the following checks:
Go back to your scenario editor in Make. If you closed the tab with the scenario in Make, you can open it directly from the process step in the Hello World digital process.
To verify the step before activating the scenario, use the Run once option.
You should see a confirmation about a successful scenario load that is waiting for data.
Make sure there are no errors in your request and resend the previous request using Postman or Celonis Action Flow (as in Step 2 of Creating a skeleton scenario process step section) and check if the scenario is working as expected. You should see the operation details in the Set Variable from Process Context module. After you send the request, the scenario initializes and then you get a confirmation about scenario completion.
Optionally, go to debugger and verify if the new instance has logs including the new process step that you added. If there are any errors in your Make scenario, you can navigate directly to the specific scenario logs in Make from the process step visible in the debugger.
In this step we will use the Feedback form that we created earlier and email it to the replyTo email address. We will pre-populate one of the fields in this form. The recipient will be able to use a Magic Link to open the form. We will then change the digital process to wait till the Feedback form has been submitted (in this case saved as draft) before completing.
Go to OE -> Events -> Event Registry and create a new event with the following values:
Display name: Hello World Feedback Provided
Event name: hello_feedback_provided
The event captures the feedback submitted by the recipient. All the submitted form data is enclosed inside this event.
Go to your Send a Survey on Hello World scenario in Make.
Add the Create Form Magic Link module and place it after the Set Variable from Process Context module.
Set up the module configuration:
Select the Feedback form
Choose no in the Assign Contact - we use the email address sent in the event
Select the Hello_feedback_provided event as the submission event type. This is what ensures that the expected event is raised when the form is submitted.
Leave Submitted Only Once to true - we do not want the form to be replied to more than once.
In the Digital Process Instance ID field, select the digital process Instance ID item from the list of items available for the Trigger Event module. This is to ensure the correct process is resumed when the form is submitted. Instance ID is the ID that you can find in the debugger, but here we need to map the relevant field from the trigger.
Name and Language fields can be left empty
Choose OK to save your module configuration
Add the Submit Form Draft module and place it after the Create Form Magic Link module.
Set up the module configuration:
Map the Magic Link ID from the previous step
Select the Feedback form to reveal the fields available for pre-population. The fields can be left empty.
The whole Make scenarios should look like this:
Go back to your Hello World digital process in OE and add the Hello World Feedback Provided event as a trigger, after the Send a Survey on Hello World process step. This trigger is necessary to complete the digital process, it receives information that a form was submitted by the user.
Publish the digital process and ensure it's activated again. Send the previous event one more time from Postman or Celonis Action flow to trigger the process. The email with the survey link is sent to the specified email address.
Submit the reply to the form. After submitting the reply, you can check if the last step of your Hello World digital process (Hello World Feedback Provided) was finished.
If it happens that the Hello World digital process trail did not work for you, see some fixing hints below:
"I got the email, submitted the form, but the process did not complete."
Check if you mapped the digital process ID in the Create Form Magic Link module
"I created the process step with the Send a Survey on Hello World and did the test run but I didn't get any email."
Check if there were any errors in the Make scenario sending the email
Check your junk folder for the email
Check you mail provider's logs
For details on how to create a digital process, see guides.
Get the Webhook Target URL and HMAC Secret and send the Hello World event following the instructions in . The authentication and configuration guide includes a Postman collection that also shows you how to authenticate the request by generating the HMAC signature.
If you are a Celonis customer and want to trigger a digital process from EMS, it is possible to do this using the Action Flow module. There's a public that enables you to start digital processes.
Set up the connection to include the source
, secret
and OE API client
and secret
following the instructions in .
Check if your payload was retrieved and whether it activated a new digital process. You can verify this using the .
To create the form, you can use the Form builder that is integrated with OE. For details, see documentation.
Go to your Hello World digital process, and a new process step. For details, see .
7. The form has to be emailed to the recipient. To do this, send a message to the recipient containing the magic link. You can use any supported Mail Provider for this. The example below shows , which supports a free account of up to 5 recipients. Ensure you allowlist the recipient so that the email gets sent. To make the module work, you need to set it up as described in documentation. For details about Mailgun authentication, see Mailgun's documentation.
Use the OE form UI to review and submit the form. The link has the following format: Match the MAGIC_LINK_ID and the TENANT_ID. The TENANT_ID is specific to the tenant for which you're creating the scenario, it can be fetched from the Trigger Event.