Skip to main content

Editing Start process step in Process Orchestration

A Process Orchestration sequence begins with Start process step. These steps are activated by a defined event, which acts as the trigger for the subsequent steps.

Before you begin

Before you begin, ensure you have completed the following steps or meet the requirements listed below:

  • If using an Action Flow: The Start New Orchestration module needs a Process Orchestration event that it can reference. If you don't have one yet, create it. See .

Starting Orchestration Engine using Action Flow

To start a Process Orchestration using an Action Flow, you must use the Start New Orchestration module. This module generates a unique instance ID that can be used to initialize the Start a Process event in your Process Orchestration.

Once created, you can use this Action Flow as a bridge between a manual action in a Celonis View and the Process Orchestration asset. For instance, you can create an Action button in your View, which will trigger a new Process Orchestration through a dedicated Action Flow.

Note

The Start New Orchestration module must be set up in a separate Action Flow, not as an embedded process step within the Process Orchestration itself.

Building your Start New Orchestration Action Flow

  1. In Studio, go to your package and either start editing an existing Action Flow or start a new one by clicking New asset > Action Flow.

  2. Click Add module and from the list select Start New Orchestration.

  3. Configure the module:

    1. Select your pre-configured Orchestration Engine OAuth connection.

      If there are no existing OAuth connections:

      1. Create an OAuth Client application with authentication methods. See Adding OAuth client to Celonis Platform.

      2. Add permissions for the respective OAuth Client applications to the desired Celonis package. See Managing packages and package permissions.

    2. Select the specific Start a Process event that serves as the designated trigger for your orchestration.

      If there are no existing events, create one. See .

    3. Define a subject to easily identify the specific event instance in the user interface.

    4. (optional) Select Map as JSON String and input a structured JSON payload to pass the necessary data variables into the Orchestration Engine.

  4. Define inputs for the Action Flow:

    1. From the top bar, select inputs.

    2. Add a new input called dpInstanceId of type Text.

      The Digital Process Instance ID (dpInstanceId) serves as a link connecting a process instance to its corresponding Action Flow. It enables the Get Process Context module to retrieve specific data and ensures the Completion Event updates the correct instance.

      An Action Flow inputs screen with the dpdInstanceId input defined. The input is of Text type.

  5. Add Process Context to your Action Flow. See Adding process context to Process Orchestration.

    Process Context stores external information about the execution of a specific Process Orchestration version instance.

  6. Add Completion Event to your Action Flow.

    Completion events log details about the current step to provide content to the next steps in orchestration. Subsequent steps use this data to determine when the previous step has completed so they can begin execution.

    1. In the Action Flow editor, click Add module and from the list select Completion Event.

    2. Configure the Completion event module:

      1. In the Digital Process Instance ID field, enter dpdinstanceID.

      2. Select a Process Orchestration event to which the Action Flow will send information.

        If there are no existing events, create one. See .

  7. Schedule the Action Flow to be on-demand.

  8. Save your Action Flow.

  9. Version and deploy the package with the Action Flow. See Versioning and deploying packages.

  10. Switch the Action Flow to active.

Your Start New Orchestration Action Flow is set up and ready to use.

Starting Orchestration Engine using Annotation Builder

  1. In Studio, go to your package and select your Process Orchestration.

  2. Select the Start process step and from the side panel, click Add event.

  3. Select an event in one of the following ways:

    • Select an event from the list.

    • Add a new event. Click Create event.

      1. Give your event a name (key) and a description (label) for easy identification in the event list.

      2. (optional) Toggle Link asset to add extra assets that will be used as triggers for Process Orchestration.

        These assets can only be used to start Process Orchestration. Each asset type can be linked to the event you're creating right now but also to already existing events on the list.

        From the dropdown list, select your asset. You can select from the following asset types:

        • Annotation Builder - this AI-enhanced Studio asset processes your data and generates informed guidelines based on your specific instructions. You can use the Annotation Builder logic as a starting point for your new automations. This can be helpful with, for example, dynamically routing workflows and automatically triggering correct further actions.

      3. (optional) Add a schedule based on which this step is going to be run. See Adding timer events to Process Orchestration.

      4. Click Create.

      Your event is created and available in all Process Orchestrations in the package. Once you're satisfied with your Process Orchestration setup, you can test it to see its outcome and logs. To do so, in the edit mode for your Process Orchestration, select Test at the top.

You’ve added an event to your start step.

Related topics