Skip to main content

Celonis Product Documentation

Celonis Actions

Celonis Process Automation can connect to other applications within the Celonis Intelligent Business Cloud, e.g., Data Integration.

Connection

Grant required Permissions:

  1. Go to Data Integration.

  2. Click on the three dots in the top right corner of your Data Pool.

  3. Click Permissions.

  4. Select the required Permissions (USE, ADMIN, DATA PUSH API, CONTINUOUS DATA PUSH API).

Actions

What it does: Updates your data pool by writing data in a specific column of a table or creating a new table/column for it.

  1. Connection (Celonis User) (required): Add your Celonis User connection. The user should have permissions to use the DATA PUSH API of the Data Pool you would like to push data to.

  2. Data pool (required): Select the Data Pool you would like to push data to.

  3. Table name (required): Define the name of the Table you would like to push data to. If a table with this name already exists, then the data will be pushed to the existing table, otherwise the workflow will create a new table with this name. Table names cannot have spaces.

  4. Column name and value (required): Define the columns of the table you would like to push data to. If the table you push data to already exists, ensure that column names and data types match and all columns are configured in the right order.

    The following operators can be used to cast values: toString(), toDate(), toInt(), toFloat()

Additional information

Please Note:

  • When using the continuous data push API version, please note that for the connection an Application Key (not an API key) is required.

  • We recommend using the action that is using the continuous push API. If it's no available and you want to use it, please request activation via the Service Desk.

  • We highly recommend using the operators toString(), toDate(), toInt(), toFloat() for all inputs to prevent data type mismatches.

  • The current limit of the Write Data to Table (Continuous Data Push API) action is 2k characters per push.

  • Data jobs are collected and processed in a combined fashion in regular intervals. It might take up to 20mins for the data to be present in event collection.

41192130.png
35555808.png

Troubleshooting

Below you can find some error messages and proposed solutions for frequently occuring issues with writing back to table.

Please switch to the continuous push API action.

If you can not find it as an action in your list, please request activation via the Service Desk. This action is able to push data back via usage of the continuous push API. For more context on this, please check the corresponding documentation

If you are using the continuous push API, there are two potential sources:

(1) Data jobs are collected and processed in a combined fashion in regular intervals. It might take up to 20mins for the data to be present in event collection.

(2) Even though the action is shown as successful, the processing of the data fails to insert data. The reason for this can be a datatype mismatch between the insert and the existing table. Check that all columns are present in the configuration, have always the same order (also when used in different actions) and are cast to the right data types.

Note

You can use toString(), toDate(), toInt() and toFloat() to force data types.

Data is showing up, but some columns seem to be mixed up, and the data does not look as expected.

If you notice that the result that is pushed to the data pool doesn't look as expected e.g. your number does not appear correctly, this can be due to data types. You can use toString(), toDate(), toInt() and toFloat() to force data types. Also make sure you are always including all columns in the same order (if using in various skills).

Query Data Model

What it does: Queries parts of your data model and provides the respective columns as output which can be used in the next steps.

  1. Connection (Celonis User) (required): Add your Celonis User connection. The user should have USE and ADMIN permissions on the Data Model that should be queried.

  2. Data pool (required): Select the Data Pool which contains your Data Model.

  3. Data model (required): Select the Data Model you would like to query.

  4. Columns (required): Add the columns that you would like to query. You can add a column from the Data Model or write a PQL expression. You can change the order of the columns, define column names (alias) and adjust format as well as unit.

  5. Filter(optional): Define filters. Example: FILTER "Table"."Column" = {Placeholder for Parameter}

  6. Sort by (optional): Sort the rows according to one column (ascending/descending).

  7. Limit (optional): Limit the number of rows. If left empty, 'Limit' will default to 50.

Advanced settings

Make sure to tick "Show advanced settings" in order to be able to filter, sort and define a limit.

Query output

  • If you would like to insert the queried table in an e-mail, use the output 'Table (HTML Format)'.

  • The Query Data Model Action will provide you as output both with a table of the queried columns as well as the single columns.

Use the queried columns in the next steps:

41192139.jpg
Reload Data Model

What it does: Reloads your data model either from cache or complete.

  1. Connection (Celonis User) (required): Add your Celonis User connection. The user should have ADMIN permissions on the Data Model that should be reloaded.

  2. Data pool (required): Select the Data Pool which contains your Data Model.

  3. Data model (required): Select the Data Model you would like to reload.

  4. Force complete reload (required): Define if you want to reload from cache or force a complete reload.

41192144.png
Create PDF Report

What it does: Creates a pdf report of an analysis.

  1. Application Key (required): Create an Application Key in the team settings and grant it permissions to USE the analysis you would like to create the report from.

  2. Type (required): Choose if you would like to create a pdf report from an analysis in Process Analytics or Studio.

  3. Analysis (required): Select the analysis you would like to create the report from.

  4. Sheets (required): Select and order the sheets you would like to include in the report.

  5. Output (required): Choose the output type of the report. Select 'Download Link' to create a publicly available link. Choose 'Base64 String' to create Base64 encoded content. Base64 encoded content is e.g. needed for email attachments.

  6. Filter (optional): Define the PQL filter that will be passed to the analysis.

  7. Width (optional): Adjust the width of the PDF based on the sheet width. Default: 1920.

  8. Height (optional): Adjust the height of the PDF based on the sheet height. Default: 1080.

  9. Device Pixel Ratio (optional): The ratio of the resolution in physical pixels to the resolution in CSS pixels. Default: 1.

  10. Header (optional): Define a header (as HTML content) that will be shown on each page.

  11. Footer (optional): Define a footer (as HTML content) that will be shown on each page.

Download link

Please note that if you choose 'Download Link' as output of this action, the created link will be publicly available using a non-guessable URL. Everyone with access to this URL will be able to view the pdf. Permissions that users might have in EMS will not be applied.

50726475.png
50726474.png

Note

Click "Show advanced settings":

41192152.png

Switch to manual input:

If you don't want to select an analysis or sheet from the dropdown, you can switch to manual input. This allows you to either manually type in the field or use an input.

The fields expect the analysis ID/ sheet IDs. These IDs can be found in the URL of the analysis.

You can also forward the current filter from your analysis to the skill by using Process Analytics - Constant Variables.

35556035.png
35556048.png
Email by Celonis

What it does: Send an email via noreply@celonismail.com

  1. To (required): Define who this email will be sent to. You can add multiple email addresses by separating them with a comma.

  2. Subject (required): Define a subject for the email.

  3. Body type (optional): Choose a body type for your email e.g. Plain or HTML. If you choose the HTML option, you can format the email using HTML tags.

  4. Body (required): Define the body for the email.

  5. CC (optional): Define who will receive a copy of this email. You can add multiple email addresses by separating them with a comma.

  6. BCC (optional): Define who will receive a blind copy of this email. You can add multiple email addresses by separating them with a comma.

  7. Reply to (optional): Define an email address to which the recipient can reply to (if different from your default email address).

  8. Attachment file name and content (optional): Add attachments to your email. Make sure to have file name with extension (e.g. Report.pdf) and attachments content encoded in Base64.

Email by Celonis Limit

This action is intended for testing purposes only. It's limited to 100 emails per day. For productive use cases, it's recommended to switch to the generic email action which allows you to connect your own SMTP server. This will provide you with the full access and flexibility for sending emails. See Email (SMTP).

Using inputs in links

If you want to use inputs from previous actions in your links, please make sure to use single quote ''.

Example:

50725604.png

Images

If you want to insert images in your body, please use PNG or JPG images.

Code editor example:

<img src="https://example.png" width="320" />

Attachments

Note: Please choose an attachment file name with less than 40 characters and without special characters like ë,ü,á.

41192161.png

Note

Note: Click "Show advanced settings":

41192162.png
Celonis On-prem Agent - Actions
Execute Program

Use the action "Celonis Agent - Execute Program" to execute .bat or .exe files on the server where the Celonis on-Prem Agent is located.

Note: This action is currently only available for selected customers & requires Celonis on-Prem Agent.

To run this action, please add the following statement to the application.yml file of your Celonis on-Prem Agent:

custom-programs:
  <app_name>: <path of the app> # e.g. C:\\my_folder\my_script.bat

The following example will run the .bat file "my_script.bat" located in the folder "C:\\my_folder\":

Note: You can define multiple apps that can be triggered from Celonis Process Automation

custom-programs:
  app-1: C:\\my_folder\my_script.bat
  1. Program Name (required): Define here the name of the program (.bat or .exe file) on the server that should be executed.

  2. Arguments (optional): You can define up to 9 arguments that can be submitted into the local program.

50726479.png

In this example the program "app-1" (as defined in application.yml file) will be executed and the following argument will be transmitted:

1 = 12

(meaning the 1st argument is "12")

If another input is added the transmitted argument would be

1 = 12

2 = ...

and so on.