Data Export¶

In this tutorial, you will learn how to export data from the Celonis EMS into your local Python project. This allows you to perform analyses on your Celonis data using tools, such as Pandas, or run machine learning algorithms on it. More specifically, you will learn:

• Where to find the data that can be exported
• How to define which data to retrieve using PQL
• How to export the data as a Pandas dataframe

Prerequisites¶

To follow this tutorial, you should have created a data pool as well as a data model and should have uploaded data into it. As we continue working with the SAP Purchase-to-Pay (P2P) tables from the Data Upload tutorial, it is recommended to complete the Data Push tutorial first before embarking on this tutorial.

Tutorial¶

1. Import PyCelonis and connect to Celonis API¶

In [3]:

from pycelonis import get_celonis
celonis = get_celonis(permissions=False)

from pycelonis import get_celonis celonis = get_celonis(permissions=False)

[2024-08-09 08:57:45,596] INFO: No `base_url` given. Using environment variable 'CELONIS_URL'

[2024-08-09 08:57:45,597] INFO: No `api_token` given. Using environment variable 'CELONIS_API_TOKEN'

[2024-08-09 08:57:45,632] WARNING: KeyType is not set. Defaulted to 'APP_KEY'.

[2024-08-09 08:57:45,634] INFO: Initial connect successful! PyCelonis Version: 2.10.1

No access key provided. Please set the CELONIS_MLOPS_ACCESS_KEY environment variable.

2. Find the data model from which data will be exported¶

The first step in exporting data from the EMS is to find the location where the data is stored, i.e. the corresponding data pool and data model.

In [4]:

data_pool = celonis.data_integration.get_data_pools().find("PyCelonis Tutorial Data Pool")
data_pool

data_pool = celonis.data_integration.get_data_pools().find("PyCelonis Tutorial Data Pool") data_pool

Out[4]:

DataPool(id='1bcc67dc-935a-4b7f-940a-9c0b81a7135a', name='PyCelonis Tutorial Data Pool')

In [5]:

data_model = data_pool.get_data_models().find("PyCelonis Tutorial Data Model")
data_model

data_model = data_pool.get_data_models().find("PyCelonis Tutorial Data Model") data_model

Out[5]:

DataModel(id='a13de415-ab63-4faf-a392-daab5ec74795', name='PyCelonis Tutorial Data Model', pool_id='1bcc67dc-935a-4b7f-940a-9c0b81a7135a')

Important:
In the data export, data is retrieved from the data model and not from the data pool. This is different from the data push, where the data is first inserted into the data pool and then loaded into a data model. This design choice has been implemented, as data models are specifically designed to support fast querying of process data via Celonis' custom Process Query Language (PQL).

3. Define PQL query and export result as Pandas dataframe¶

Data from the EMS is retrieved via Celonis' custom querying language PQL. Hence, in order to export data, we first need to specify a PQL query that defines which data to retrieve and can then export the resulting table as a Pandas dataframe. For this we will be using the SaolaPy Series and DataFrame implementation. For more information on how to use SaolaPy visit the SaolaPy Tutorial.

In [6]:

import pycelonis.pql as pql

import pycelonis.pql as pql

First, we will specify the default data model to use with SaolaPy:

In [7]:

from pycelonis.config import Config

Config.DEFAULT_DATA_MODEL = data_model

from pycelonis.config import Config Config.DEFAULT_DATA_MODEL = data_model

3.1 Selecting columns¶

In [8]:

activities = data_model.get_tables().find("ACTIVITIES")
activity_columns = activities.get_columns()

activities = data_model.get_tables().find("ACTIVITIES") activity_columns = activities.get_columns()

Then, we will create a DataFrame representing an OLAP table by specifying the columns:

In [9]:

df = pql.DataFrame(
    {
        "_CASE_KEY": activity_columns.find("_CASE_KEY"),
        "ACTIVITY_EN": activity_columns.find("ACTIVITY_EN"),
        "EVENTTIME": activity_columns.find("EVENTTIME"),
        # It is also possible to write a PQL query string directly:
        "_SORTING": """ "ACTIVITIES"."_SORTING" """,
    }
)

df = pql.DataFrame( { "_CASE_KEY": activity_columns.find("_CASE_KEY"), "ACTIVITY_EN": activity_columns.find("ACTIVITY_EN"), "EVENTTIME": activity_columns.find("EVENTTIME"), # It is also possible to write a PQL query string directly: "_SORTING": """ "ACTIVITIES"."_SORTING" """, } )

We can take a look at the generated PQL query by executing:

In [10]:

df.query

df.query

Out[10]:

PQL(columns=[PQLColumn(name='Index', query='0 - 1 + RUNNING_TOTAL(1)'), PQLColumn(name='_CASE_KEY', query='"ACTIVITIES"."_CASE_KEY"'), PQLColumn(name='ACTIVITY_EN', query='"ACTIVITIES"."ACTIVITY_EN"'), PQLColumn(name='EVENTTIME', query='"ACTIVITIES"."EVENTTIME"'), PQLColumn(name='_SORTING', query=' "ACTIVITIES"."_SORTING" ')], filters=[], order_by_columns=[], distinct=False, limit=None, offset=None)

To get the dimensions of the DataFrame simply run:

In [11]:

df.shape

df.shape

[2024-08-09 08:57:45,746] INFO: Successfully created data export with id '630b1131-cd26-4808-b000-ea58d0ce0d93'

[2024-08-09 08:57:45,747] INFO: Wait for execution of data export with id '630b1131-cd26-4808-b000-ea58d0ce0d93'

[2024-08-09 08:57:45,754] INFO: Export result chunks for data export with id '630b1131-cd26-4808-b000-ea58d0ce0d93'

Out[11]:

(60, 4)

Then, we can use SaolaPy to perform additional operations on the table, such as filtering, sorting, or grouping. For more information on available operations visit the SaolaPy Tutorial.

3.2 Filtering¶

To filter the data, simply apply:

In [12]:

df = df[df._CASE_KEY == "800000000006800001"]

df = df[df._CASE_KEY == "800000000006800001"]

By plotting the df, we can see that the filter has been added to the df object:

In [13]:

df

df

Out[13]:

DataFrame(data={'_CASE_KEY': '"ACTIVITIES"."_CASE_KEY"', 'ACTIVITY_EN': '"ACTIVITIES"."ACTIVITY_EN"', 'EVENTTIME': '"ACTIVITIES"."EVENTTIME"', '_SORTING': ' "ACTIVITIES"."_SORTING" '}, index=RangeIndex(name='Index', start=0, step=1), filters=['FILTER ( "ACTIVITIES"."_CASE_KEY" = \'8000000000...'], order_by_columns=[])

Also, the shape now reflects the added filter:

In [14]:

df.shape

df.shape

[2024-08-09 08:57:45,855] INFO: Successfully created data export with id 'd381a486-036a-467a-872b-569342ee1df4'

[2024-08-09 08:57:45,857] INFO: Wait for execution of data export with id 'd381a486-036a-467a-872b-569342ee1df4'

[2024-08-09 08:57:45,862] INFO: Export result chunks for data export with id 'd381a486-036a-467a-872b-569342ee1df4'

Out[14]:

(6, 4)

3.3 Sorting the data¶

To sort the data, simply use the sort_values function:

In [15]:

df = df.sort_values(by=["EVENTTIME", "_SORTING"])

df = df.sort_values(by=["EVENTTIME", "_SORTING"])

By plotting the df, we can see that the two order-columns have been added to the df:

In [16]:

df

df

Out[16]:

DataFrame(data={'_CASE_KEY': '"ACTIVITIES"."_CASE_KEY"', 'ACTIVITY_EN': '"ACTIVITIES"."ACTIVITY_EN"', 'EVENTTIME': '"ACTIVITIES"."EVENTTIME"', '_SORTING': ' "ACTIVITIES"."_SORTING" '}, index=RangeIndex(name='Index', start=0, step=1), filters=['FILTER ( "ACTIVITIES"."_CASE_KEY" = \'8000000000...'], order_by_columns=['"ACTIVITIES"."EVENTTIME" ASC', ' "ACTIVITIES"."_SORTING"  ASC'])

In [17]:

df.head()

df.head()

[2024-08-09 08:57:45,894] INFO: Successfully created data export with id 'ff4deca9-571f-4bb6-ba6e-bbfc78aa50d7'

[2024-08-09 08:57:45,895] INFO: Wait for execution of data export with id 'ff4deca9-571f-4bb6-ba6e-bbfc78aa50d7'

[2024-08-09 08:57:45,901] INFO: Export result chunks for data export with id 'ff4deca9-571f-4bb6-ba6e-bbfc78aa50d7'

Out[17]:

	_CASE_KEY	ACTIVITY_EN	EVENTTIME	_SORTING
Index
0	800000000006800001	Create Purchase Requisition Item	2008-12-31 07:44:05	0.0
1	800000000006800001	Create Purchase Order Item	2009-01-02 07:44:05	10.0
2	800000000006800001	Print and Send Purchase Order	2009-01-05 07:44:05	NaN
3	800000000006800001	Receive Goods	2009-01-12 07:44:05	30.0
4	800000000006800001	Scan Invoice	2009-01-20 07:44:05	NaN

3.4 SaolaPy Operations¶

We can then apply further SaolaPy transformations, for example arithmetic and string operations:

In [18]:

df._SORTING = df._SORTING + 5
df.ACTIVITY_EN = df.ACTIVITY_EN.str.replace("Receive Goods", "Goods Received")

df._SORTING = df._SORTING + 5 df.ACTIVITY_EN = df.ACTIVITY_EN.str.replace("Receive Goods", "Goods Received")

3.4 Data Export¶

Finally, we can export the data as a Pandas dataframe to get our final result table. This step should be done only after all aggregations and filters are applied to ensure minimal memory consumption and to execute most computations inside the PQL engine instead of in Python:

In [19]:

pandas_df = df.to_pandas()
pandas_df

pandas_df = df.to_pandas() pandas_df

[2024-08-09 08:57:45,942] INFO: Successfully created data export with id '515ed163-3df8-4606-afa2-aa95e821b3cb'

[2024-08-09 08:57:45,943] INFO: Wait for execution of data export with id '515ed163-3df8-4606-afa2-aa95e821b3cb'

[2024-08-09 08:57:45,949] INFO: Export result chunks for data export with id '515ed163-3df8-4606-afa2-aa95e821b3cb'

Out[19]:

	_CASE_KEY	ACTIVITY_EN	EVENTTIME	_SORTING
Index
0	800000000006800001	Create Purchase Requisition Item	2008-12-31 07:44:05	5.0
1	800000000006800001	Create Purchase Order Item	2009-01-02 07:44:05	15.0
2	800000000006800001	Print and Send Purchase Order	2009-01-05 07:44:05	NaN
3	800000000006800001	Goods Received	2009-01-12 07:44:05	35.0
4	800000000006800001	Scan Invoice	2009-01-20 07:44:05	NaN
5	800000000006800001	Book Invoice	2009-01-30 07:44:05	NaN

We can also set the parameters distinct, offset, and limit of the PQL base object:

Let us specify a value for the limit property. By exporting the resulting dataframe, we can see that our result table has been reduced to only include 3 rows:

In [20]:

df.to_pandas(limit=3)

df.to_pandas(limit=3)

[2024-08-09 08:57:45,976] INFO: Successfully created data export with id 'a7ba78a9-8a82-4ed4-a999-7f2955f85a21'

[2024-08-09 08:57:45,977] INFO: Wait for execution of data export with id 'a7ba78a9-8a82-4ed4-a999-7f2955f85a21'

[2024-08-09 08:57:45,983] INFO: Export result chunks for data export with id 'a7ba78a9-8a82-4ed4-a999-7f2955f85a21'

Out[20]:

	_CASE_KEY	ACTIVITY_EN	EVENTTIME	_SORTING
Index
0	800000000006800001	Create Purchase Requisition Item	2008-12-31 07:44:05	5.0
1	800000000006800001	Create Purchase Order Item	2009-01-02 07:44:05	15.0
2	800000000006800001	Print and Send Purchase Order	2009-01-05 07:44:05	NaN

Next, we can specify an offset, meaning that a certain number of rows will be skipped. By exporting the resulting dataframe, we can see that the result table still contains 3 rows but this time the first 3 rows are skipped and only the last 3 rows are returned:

In [21]:

df.to_pandas(limit=3, offset=3)

df.to_pandas(limit=3, offset=3)

[2024-08-09 08:57:46,010] INFO: Successfully created data export with id '9d1cbace-f002-4c67-9dd9-460557ad19ae'

[2024-08-09 08:57:46,011] INFO: Wait for execution of data export with id '9d1cbace-f002-4c67-9dd9-460557ad19ae'

[2024-08-09 08:57:46,018] INFO: Export result chunks for data export with id '9d1cbace-f002-4c67-9dd9-460557ad19ae'

Out[21]:

	_CASE_KEY	ACTIVITY_EN	EVENTTIME	_SORTING
Index
3	800000000006800001	Goods Received	2009-01-12 07:44:05	35.0
4	800000000006800001	Scan Invoice	2009-01-20 07:44:05	NaN
5	800000000006800001	Book Invoice	2009-01-30 07:44:05	NaN

Conclusion¶

Congratulations! You have learned how to create PQL queries in PyCelonis in order to export data from the EMS using SaolaPy. In the next tutorial Data Model - Advanced, we will cover more advanced topics in data models, such as foreign keys, process configurations, name mappings, and different reload modes.