Skip to main content

Celonis Product Documentation

Use Case Package Import Guide

In this section you will find a complete guide to importing the required Skills and components required to implement the automation use case templates.

Activate Machine Learning

The Machine Learning product is required to import the Action Engine and Studio Skills for the automation use cases. Look at the navigation bar at the top of your Celonis team to determine whether Machine Learning is activated. See below:

41195198.png

If Machine Learning is not activated within your Celonis EMS team, you cansubmit a ticketto the Service Desk to request access.

Alternatively, reach out to your respective Celonis Customer Success Manager or Process Mining Consultant and they can activate Machine Learning within your EMS team.

41195197.png
Create API Key

In order to import the automation use case assets into your Celonis EMS team using Machine Learning, you will first need to create an API key. This API key will be used later when using the Machine Learning app to import the automation use case Skills to your EMS team. Follow the instructions below to set up an API key in your user profile.

Navigate to your user profile by clicking on the profile icon in the top right corner of your EMS team. This is shown in the image on the right.

41195206.png

Once you have entered your profile, scroll down to the section labeled "API-Keys". In this section, you will be able to name your new API key, as show on the right.

41195207.png

After naming your API key, Celonis will create the unique key value which you can copy and store, to be used later when importing the automation use case Skills.

Note: it is important to copy and save this API key when it is created, as you will not be able to view the unique key again once it has been generated.

41195208.png
Download use case packages

The automation use case packages can be downloaded from the respective use case help pages, or through the links below.

  • Release Credit Holds (O2C): Download Package

  • Remove Delivery Block (O2C): Download Package

  • Update Delivery Date (O2C): Download Package

  • Clear FI Documents (AR): Download Package

  • Post Goods Receipt (P2P): Download Package

  • Block Duplicate Payments (AP): Download Package

Once unzipped, each package should contain the necessary building blocks (Action Engine Skills, Studio Skills, etc.) to implement the use case.

Note: Action Engine Skills are exported from Celonis as JSON (.json) files, whereas Studio Skills are exported as YML (.yml) files.

Add Skills to Machine Learning App

Once you have downloaded and unzipped the relevant automation use case package, you can complete the following steps to import the associated Action Engine and Studio Skills into Celonis.

First, create a new Machine Learning app, and configure a Jupyter Workbench as shown on the right.

41195219.png

Once you have created this Machine Learning app, your screen should look something like the image shown on the right.

As you can see, you have the option of creating new notebooks, consoles or terminals using the launcher in the center of your screen.

Additionally, you can navigate the various assets and folders within your Machine Learning app using the navigation bar on the left.

41195230.png

Next, upload the Action Engine Skills (JSON file) and Studio Skills (YML file) contained within the unzipped use case package to your Machine Learning app. You can do this using the "upload" button above the navigation bar on the left hand side of your screen. See the reference image on the right.

41195226.png

Once your Skills have been uploaded to your Machine Learning app, you should see them in the navigation bar on the right of your screen. An example of this is shown in the image on the right.

41195227.png
Create a New Terminal

With your Action Engine and Studio Skills uploaded to your Machine Learning app, you can launch a new "Terminal" in order to begin importing them into your Celonis EMS team. See the reference image on the right.

41195221.png

Your new terminal console should look like the image on the right.

41195231.png
Use Content CLI to Import Skills

The Content CLI is a tool within Celonis Machine Learning which allows you to import and export assets from the EMS.

The Content CLI queries described below are needed to import the Action Engine and Studio Skills to your EMS team. You will need to modify these queries for your selected use case(s) and EMS team.

1. Create Profile

First, you will need to create a profile using Content CLI. This profile allows you to execute push and pull actions using Content CLI in Machine Learning.

You can create a new profile using the following query:

Create Profile in Content CLI

content-cli profile create

To create your profile, you will be asked to provide the following details (also shown in the screenshot below):

  • Name of the profile: my-team; import-skills; etc.

  • Your team URL: https://my-team.us-1.celonis.cloud

  • Your API token: paste your created API key

41195232.png

Once you have successfully created your profile, you can set it as your default profile using the query below:

Define Default Profile in Content CLI

content-cli profile default <YOUR_PROFILE_NAME>

_

2. Import Action Engine Skills

Once you have created a profile, you need to add the Action Engine Skills for your automation use case to an Action engine project within your EMS team. To do this, you can either create a new Action Engine project dedicated to this use case, or you can import the Skills to an existing Action Engine project. Regardless, you will need to navigate to the desired project, and search the URL to determine the respective Project ID. This is shown in the image below.

41195238.png

Within the URL of your EMS team, you will find the unique ID for the relevant Action Engine project

Once you have determined the relevant Project ID, you can modify and use the following Content CLI query in your Machine Learning app to import the Action Engine Skills needed for your automation use case template.

Define Default Profile in Content CLI

content-cli push skill --projectId <ACTION_ENGINE_PROJECT_KEY> --file <ACTION_ENGINE_SKILL_FILE.json>

As you can see, the above Content CLI query has the following required inputs:

  • Project ID: this defines the project to which your Action Engine Skill will be added

  • File: this is the name of the Action Engine Skill (.json file) that you added to your Machine Learning app in the previous step

    • E.g. automate_credit_hold_releases.json

If you have completed the above steps properly, you will receive a notification stating that the Skill was pushed to the Action Engine project successfully. You will also find the Skill in the associated project.

3. Import Studio Skills

The final step is to import your automation use case Studio Skills to your Celonis EMS team. To do this, you can either create a new Studio Package dedicated to this use case, or you can import the Skills to an existing Studio Package. Regardless, you will need to retrieve the relevant Package Key using the steps below to ensure that the Studio Skill is imported to the desired package.

If creating a new Studio package for this automation use case, the unique package key is defined during the creation stage. See the image on the right:

41195241.png

If, however, you are importing the Studio Skill to an existing package, you can retrieve the associated package key as follows. In the settings of the package, you will find a section titled "Key", as shown on the right.

41195242.png

Within this "Key" section, you will find the Studio package's associated unique identifier.

41195243.png

Once you have retrieved the relevant Package Key, you are ready to use Content CLI to import the Studio Skills. You can modify and use the following Content CLI query in your Machine Learning app to import the Studio Skills needed for your automation use case template.

Define Default Profile in Content CLI

content-cli push asset --file <STUDIO_SKILL_FILE.yml> --package <STUDIO_PACKAGE_KEY>

As you can see, the above Content CLI query has the following required inputs:

  • Package ID: this defines the package to which your Studio Skill will be added

  • File: this is the name of the Studio Skill (.yml file) that you added to your Machine Learning app in the previous step

    • E.g. asset_remove-delivery-block.yml

If you have completed the above steps properly, you will receive a notification stating that the Skill was pushed to the Studio package successfully. You will also find the Skill in the associated package.

You now have all of the required assets imported to your Celonis EMS team, and should be ready to configure these Skills to your or your customers' specifications.