backend.pql_queries.general_queries

Queries that can be used to get general data from celonis.

Functions

get_dfg_representation(→ pandas.DataFrame)	A query that gets the DFG representation of a process.
get_cases(→ pandas.DataFrame)	A query that gets the cases from an event log.
get_number_of_cases(→ pandas.DataFrame)	A query that gets the count of cases from an event log.
get_activities(→ pandas.DataFrame)	A query that gets the activities from an event log.
get_number_of_activities(→ pandas.DataFrame)	A query that gets the count of activities from an event log.
get_traces_with_count(→ pandas.DataFrame)	A query that gets the traces and their count.
get_general_information(→ pandas.DataFrame)	Fetches number of cases, activities, and trace variants from Celonis.

Module Contents

backend.pql_queries.general_queries.get_dfg_representation(celonis: backend.celonis_connection.celonis_connection_manager.CelonisConnectionManager) → pandas.DataFrame

A query that gets the DFG representation of a process.

Parameters:

celonis (CelonisConnectionManager) – the celonis connection

Returns:

a pandas Dataframe that represents a graph

backend.pql_queries.general_queries.get_cases(celonis: backend.celonis_connection.celonis_connection_manager.CelonisConnectionManager) → pandas.DataFrame

A query that gets the cases from an event log.

Parameters:

celonis (CelonisConnectionManager) – the celonis connection

Returns:

a pandas Dataframe that contains the cases

backend.pql_queries.general_queries.get_number_of_cases(celonis: backend.celonis_connection.celonis_connection_manager.CelonisConnectionManager) → pandas.DataFrame

A query that gets the count of cases from an event log.

Parameters:

celonis (CelonisConnectionManager) – the celonis connection

Returns:

a pandas Dataframe that contains the count of cases

backend.pql_queries.general_queries.get_activities(celonis: backend.celonis_connection.celonis_connection_manager.CelonisConnectionManager) → pandas.DataFrame

A query that gets the activities from an event log.

Parameters:

celonis (CelonisConnectionManager) – the celonis connection

Returns:

a pandas Dataframe that contains the count of cases

backend.pql_queries.general_queries.get_number_of_activities(celonis: backend.celonis_connection.celonis_connection_manager.CelonisConnectionManager) → pandas.DataFrame

A query that gets the count of activities from an event log.

Parameters:

celonis (CelonisConnectionManager) – the celonis connection

Returns:

a pandas Dataframe that contains the count of activites

backend.pql_queries.general_queries.get_traces_with_count(celonis: backend.celonis_connection.celonis_connection_manager.CelonisConnectionManager) → pandas.DataFrame

A query that gets the traces and their count.

Parameters:

celonis (CelonisConnectionManager) – the celonis connection

Returns:

a pandas Dataframe that contains the traces and their count

backend.pql_queries.general_queries.get_general_information(celonis: backend.celonis_connection.celonis_connection_manager.CelonisConnectionManager) → pandas.DataFrame

Fetches number of cases, activities, and trace variants from Celonis.

Parameters:

celonis – The CelonisConnectionManager instance to interact with Celonis.

Returns:

A pandas DataFrame containing the counts of cases, activities, and trace variants.