Activating and configuring live data
Overview
You can set up a live data connection between your knowledge model in Celonis Platform and Celonis Process Management. This allows you to use features such as the Process Cockpit. Once the connection is established, you must then configure the data in Process Designer (in the form of KPIs and tasks), which can then be viewed and used in process models in Process Navigator.
Prerequisites
To set up live data in Celonis Process Management you must have the following:
A Celonis Platform license
Access to the Celonis Intelligence API
Knowledge model setup in Celonis Platform
Administrator role in Celonis Platform
Administrator role in Celonis Process Management
Set up live data connection with Celonis Platform
It's easiest to set up the connection by having the Celonis Platform open in one tab, and Process Designer open in another. Start by logging into Celonis Platform and navigate to Admin & Settings - Applications. Click Add New Application and select Application Key from the dropdown.
Enter a key name, then click Save.
Now you will see the application key displayed. Make sure to copy it to clipboard before proceeding. It's a secret that you can only see once!
Note
You can only view an application key once, so make sure to copy it when you create it. If you don't have a copy of the keys on your list, you'll need to create a new one.
Open a new tab. Log into Process Designer and from the top menu click the gear icon to access the Settings area. Under Services, click the SSO Configuration tile. Click Connectivity on the left-hand side.
Paste the application key you created in step 3 into the Client Secret field.
Switch back to your Celonis Platform tab. Copy the matching ID for your application key from the list.
Switch back to your Process Designer tab. Paste the ID you just copied into the Client ID field.
Switch back to your Celonis Platform tab. Look at the browser bar. It should say something like http://celonisphere-24-pam.eu-1.celonis.cloud/ui/team/applications. Everything in front of "/ui" is your team URL. Copy this part.
Switch back to your Process Designer tab. Paste your URL segment into the Team URL field and click Update. You should see a success message.
Now that we've created our application key, we need to assign it permissions so we can use it. Switch back to your Celonis Platform tab. Click Permissions, look for the Studio square, and click Edit.
Search for the name of the application key you just created. Under Template, select All Permissions and then click Save.
Switch back to your Process Designer tab. Go back to the Settings area and under Configu click the Features tile.
You'll be brought to the Features page. Under Method: Live data feature, set Activation to Activated.
Note
If you want to activate live data at task level, you must also set Method: Best Practice Tasks to Activated. If you can't see any live data provider options, contact Support.
Click System in the top navigation, then scroll to find LiveDataProvider.
In the right-hand navigation, under Live data provider, select your live data provider.
Release your system.
If a previous valid version exists, set the state of your new version to Valid. Your new version will now take precedence over any other versions.
Configuring live data
With the live data connection activated, you need to configure it before you can start viewing it in process models. You do this by adding it to KPIs and tasks.
Adding live data to KPIs
In Process Designer, click KPI in the top navigation.
Select a category. Click the white New next to the trash icon. Select Key Performance Indicator from the dropdown. Type the name of your new KPI and click the blue New to save it. In the screenshot below, we're adding a new KPI called "Case count" to an existing category called Procurement.
Click your newly created KPI, and in the sidebar scroll down to Details. Under Calculated in system, select the system you created. If desired, you can also set the warning limits under Units to control when the live data indicator switches from green to yellow (warning) and red (action) in your process model.
In the sidebar, scroll down to Celonis Platform Attributes, and enter the following from your Celonis Platform knowledge model:
Knowledge model key
Record ID
Record attribute (default is ACTIVITY)
Date filter attribute (default is EVENTTIME). The date filter attribute requires a date attribute for your record in the Celonis Platform. The type should be set as Date & Time and the format should be set as Y-M-D H:M.
Note
Record attribute is only needed for task-level KPIs.
The graphic below shows where to find the necessary attributes in your Celonis Platform knowledge model.
Release your KPI.
Adding live data to tasks
Note
The following section assumes you are creating tasks manually. If you import your model from the Celonis Platform using Celonis Process Adherence Manager , you can skip this step
To use live data at the task level, you need to create a Best Practice Task to use as a repository object in your process model.
Assign the KPI to a task within a process.
Click Processes in the top navigation, then click Best Practice Tasks.
.Celonis Platform by setting its ID to the ActivityID in the Best Practice TaskConfigure the Release the Best Practice Task.
Release the Best Practice Task.
Connect the Best Practice Task to the task.
Release the process.
Adding live data to a process
With all your data configured, the last step is to add the KPI and Best Practice Task to your process.
Select the process that you want to see live data for.
In the details pane that opens, under KPI, select the KPI you just created.
If you want to also see data on a task level, under Task, select the Best Practice Task you created.
Checking your live data configuration
Select the task or process you assigned the KPI to.
In the Detail content panel, navigate to Live data check and select Check.
If your configuration is correct, you'll see a preview of the live data. Any configuration issues will be flagged by warning or error messages indicating that your system or KPI isn’t connected or your Best Practice Task/system/KPI hasn’t been released.
Where necessary, fix your configuration using the message information for guidance.
Live data limitations
The main KPI and any child KPIs must:
Have the same Celonis Platform knowledge model key at task level.
Be assigned to the same Best Practice Task in the Celonis Platform at task level.