OE Make Modules

The OE digital processes are created out of Make scenarios, which are made of modules performing different actions. The modules are used to link apps and services together.

Emporix has different types of Make modules prepared for OE.

Emporix Orchestration modules

The processes modules are responsible for interactions between OE and Make. The modules make the two applications talk to each other. They are used for as triggers, mid triggers, updates of process context, or for notifications when a scenario is complete.

Starter modules

The starter modules are placed at the beginning of a process step Make scenario. The modules receive all the data from the process context that was gathered from the running digital process instance up to the particular step. This data can be used by the scenario as input to adapt its behaviour. Starter modules also send the instance ID to the digital process that is running the scenario step.

Trigger Event

The module starts a scenario of a process step, which is a part of a digital process. The module works as a trigger for the step when it receives information that the previous step was completed. It passes the process context from the previous steps to the scenario where it's placed.

New Form Trigger

The module works as a scenario trigger when a new Form is issued to the customer.

All the starter modules can be parts of Make scenarios that serve as digital process triggers. To learn more about triggers check the following guides:

• Digital Process Components - Triggers

• Setting a Trigger to Wake Up a Paused Digital Process

• Data Flow between OE and Celonis

Completion modules

The completion modules are responsible for sending notification to OE when a Make scenario is finished. They also send event data that is saved in the process context of the running digital process instance. For this, they need the instance ID from the starter module, and the Event that is an outcome of running the scenario step.

Completion Event

The module is used for sending notification about a completed Make scenario.

Start New Orchestration

The module can be used as a trigger for a new digital process instance. Using the module, you can connect with any other application. When such a connection is configured, any signals or actions from the connected app work as triggers for the orchestration.

Events modules

List Event Types

The module provides a list of Event Types that can be sent to the Orchestration Engine.

Create Event Type

Creates an Event Type in the Orchestration Engine.

Forms modules

The OE is integrated with Form.io that provides a solution for building a variety of forms out of different components. Using the forms Make modules prepared by Emporix, you can include forms in your Make Scenarios.

Create Form Magic Link

The module creates a link with a designed form, or multiple forms combined into one. Within the module, you can select the form that you had prepared in your OE tenant, in Management Dashboard. The created magic link can be used to access the form through the web.

The Create Form Magic Link module allows you to configure custom form attributes, which you can use in the Form Builder to add dynamic, personalized behavior for each recipient of the form. For example, you can present a personalized list of coffee options.

You can create custom attributes either in the Forms view or using the magic link API. Then, you can reference them in the Form Builder to adjust the bahavior of the form.

In the Create Form Magic Link Make module, specify values for the form attributes:

1. Choose the form in which you have created the custom attributes - in this example it's Coffee Preferences.

2. In **Custom JSON Attributes**, Item 1, add `coffeeType` as Attribute Name and specify the value that should be visible in the form, the value should be given in a JSON format. For example:

  {
   "options" : [
       { "id": "americano", "label" : "Americano" },
       { "id" :  "flat white", "label" : "Flat White" },
  {    "id" :  "latte", "label" : "Latte" },
  {   "id" : "black" , "label" : "Black" }
   ]
  }

1. Save the module configuration and the scenario.

After the scenario runs and the magic link to a form is created, you can see the form attributes and values provided in Make module as the possible answers that can be submitted.

To see the example of how to configure the form in OE, see Example - Coffee Preferences form.

Create a Form Magic Link from a Previous Submission

The module creates a link to a form that had been submitted earlier. The link is pre-populated with data received from one user and can be sent to a different user with another unique magic link. The module includes the source submission field (Form Submission IDs), which contains the previous submission ID.

Get a Form Magic Link

The module is used to access the data from a form that was submitted, or saved as a draft, along with the specific schema of the submitted form. The module receives data about forms, and it returns the following information:

• the forms definition (schema) that is linked to the magic link

• data that has been saved up to the specific point in time

• metadata about the submission

Update Magic Link Custom Attributes

The module is used for any custom attributes used in a form magic link.

List Form Magic Links

The modules provides a list of all the form Magic Links.

Delete a Form Magic Link

The module removes a Magic Link along with any associated form submissions.

Get a Form

The module loads a form definition by using its ID.

Submit Form

The module is used together with the Create Form Magic Link to generate a pre-populated form, which can be sent to a user. Using the module settings, you can map the fields between a form created in the OE Management Dashboard and the module in your Make scenario. If you choose to map the fields, all the values are automatically added.

Submit Raw Form Data

The module is used with Create Form Magic Link to generate a form. However, unlike the Submit Form module, it uses a raw data payload in a JSON format. You can use the mapping option, but it only maps the form's ID from the Create Form Magic Link module used in the scenario. You have to add the JSON payload manually.

Forms modules for draft submissions

• Submit Form Draft - the module makes it possible to have a draft form version, before the submission. With this module, the form is autosaved as a draft, but it's not submitted yet - no submission event is sent. The recipient can update the form before they decide to submit. However, the module uses a dynamic form definition instead of raw JSON data.

• Submit Raw Form Data Draft - similarly to Submit Form Draft, the module makes it possible to have a draft form version, before the submission. With this module, the form is autosaved as a draft, but it's not submitted yet - no submission event is sent. The recipient can update the form before they decide to submit. However, the module uses a raw JSON data instead of a dynamic form definition.

Extract Form Submission from Process Context

The module is used for extracting the submitted form data from the whole process context created for a digital process instance.

List Form Submissions

The module is used to provides the submitted data from the specified form.

Task List modules

Task list is designed for external users to make it easier for them to monitor and complete all their assigned tasks. The list gathers all the separate forms links for specific tasks and can be accessed by the users in a Task Inbox, outside of Management Dashboard. The Make modules related to the feature are:

Create an Access Link

Creates an Access Link (link to a Task Inbox) for a specific user email address.

Get an Access Link

Retrieves the Task Inbox link using the given link ID.

List Access Links

Provides a list of all the access links within the Task Inbox. You can filter the list by a specified query, limit the max number of links or sort by different attributes.

Revoke an Access Link

Removes the Task Inbox access link, this can be used for various security reasons.

Process Context Interaction modules

Process Context is a JSON object that contains information about an overall digital process. To check the information how process context is structured in general, see the Process Context document.

In Make scenarios the data for process context is sent from the Resume Event module when a scenario is completed. The data is then passed through the subsequent scenarios/process steps. However, OE can also use process context modules to search for process context and also, to update the context in the middle of a scenario run.

Search Process Contexts

The module is used to find process contexts related to a specific tenant. It uses criteria such as digital processes, event fields and processing state.

List Process Contexts

The module lists process contexts that can be filtered by digital process and its versions, as well as the status and create and update dates.

Get Process Context

The module securely extracts process context of a given digital process using its instance ID. It first retrieves the current state of the process context and then outputs the relevant information.

When used by Celonis action flows, it enables secure access and extraction of information from a digital process, eliminating the need for insecure methods like chaining webhooks. This ensures that data retrieval happens within a protected framework, enhancing the security of interactions between the digital process and external systems.

Delete a Digital Process Instance

The module removes the specified digital process instance along with any associated resources, including Event Logs and Magic Links.

Terminate a Digital Process Instance

The module stops a digital process instance.

List a Process Context Event Log

The module chronologically lists all the events generated by a digital process instance. Process contexts logs gathered with the module can be filtered, or sorted using various settings:

• Update Since - gathers events data from the specified date and time.

• Query Filter - uses specified queries to collect partial data, for example: eventType:(order.spotbuy.sent,order.stock.checked).

• Sort - orders the results by a given criteria, the default sorting is done according to updatedSince.asc.

• Limit - setting for the maximum number of returned results.

The output data in the module includes IDs related to the tenant and the related process context, as well as the Occurred At and Received At information.

• Occurred At - it's the value of the ce-time CloudEvent header, or if the value is not present then it's the same value as Received At. The ce-time header can be used by the merchant to indicate when the event occurred on their end, which may not always align with the time they sent the event to OE. For example, if a return was initiated on Tuesday in an ERP but is only sent to OE on Wednesday, ce-time can inform us of Tuesday's timestamp, rather than presuming the return was initiated only when receiving the event.

• Received At - it's the time when OE received and registered the event. This may differ from the time when the event was sent because OE queues events.

Update Process Context

The module is used if you want to save the process context information through the process of the specified Make scenario, before it is completed.

In comparison to having the context information available at the end of the Make scenario process, the Update Process Context module makes it possible to store context data before going to the next step in a scenario itself, not only between the digital process steps. This data is intended for use in scenarios allowing you to adapt a scenario's behaviour according to the context and outcomes of previously run scenarios.

If you want to save the process context information in a process of a running scenario, add the Update Process Context module to your scenario and in the module settings add the contextID, select the Event Type and use the mapping for JSON payload.

Set Variable from Process Context

The module is used for mapping process context data.

Using the context data gathered throughout a running scenario requires mapping this context data while setting up new scenarios in the same digital process. You can do the mapping using the Set Variable from Process Context module that works with events fields in a type safe way. The mapping is based on selecting only the whole context object and the fields that you want to assign.

In the module's configuration, you can select an event field that you want to use in the specific digital process and assign its output to a Make Variable. You can also specify, if the module should throw an error if the event type's value isn't present. Both primitive and complex types can be assigned.

The process context object mapping is supported for the Data object sent through the Trigger Event module, and the Context object from Search Process Contexts or Get Process Context modules.

Set Multiple Variable from Process Context

It is recommended for type-safe assignment of process context variables. The module extracts event fields from the process context, either passed into a scenario or loaded from the API, and assigns their values to variables. It serves as a more user-friendly alternative to mapping context fields using notation.

Resume Event

The module is used as a wake up trigger for a paused digital process instance.

Datastore modules

These modules are designed for uploading, storing, and browsing data. They work with forms for data storage and retrieval, making it easy to manage and access information. The datastore can be used for various purposes, such as listing active users, managing workspace settings, or creating lookup tables.

Set a Datastore from a CSV Upload

The module is configured for creating and populating a datastore with structured data. To upload a datastore, you first create a namespace to organize the data. Then, you define a unique key column for each row, ensuring data integrity. The module supports CSV file uploads using an HTTPS mapping, allowing flexibility in data sourcing.

List Values in a Datastore

This module enables listing values from the datastore. Access to the data is controlled through a unique Magic Link ID, which serves as the single entry point to retrieve stored values. Make sure the Magic Link you use is active and valid to use it in the module.

Tenant modules

Get Account

The module is used to fetch information about your OE tenant data needed for the Make scenario.

Celonis Intelligence API

Using OE and Make modules you can retrieve data from Celonis Knowledge models for your digital processes. To see how the data flow between OE and Celonis works and how to use the Celonis Intelligence API modules, check the Data Flow between OE and Celonis documentation.

Emporix Commerce Engine

The modules related to commerce for CE are responsible for specific actions like for example creating a price for a product, searching a price list, or assigning product to category.