pm4py.algo.connectors.variants package#

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

Submodules#

pm4py.algo.connectors.variants.camunda_workflow module#

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

class pm4py.algo.connectors.variants.camunda_workflow.Parameters(value)[source]#

Bases: Enum

An enumeration.

CONNECTION_STRING = 'connection_string'#
pm4py.algo.connectors.variants.camunda_workflow.apply(conn, parameters: Optional[Dict[Any, Any]] = None) DataFrame[source]#

Extracts an event log from the Camunda workflow system

Parameters#

conn

(if provided) ODBC connection object to the database (offering cursors)

parameters

Parameters of the algorithm, including: - Parameters.CONNECTION_STRING => connection string that is used (if no connection is provided)

Returns#

dataframe

Pandas dataframe

pm4py.algo.connectors.variants.chrome_history module#

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

class pm4py.algo.connectors.variants.chrome_history.Parameters(value)[source]#

Bases: Enum

An enumeration.

HISTORY_DB_PATH = 'history_db_path'#
pm4py.algo.connectors.variants.chrome_history.apply(parameters: Optional[Dict[Any, str]] = None) DataFrame[source]#

Extracts a dataframe containing the navigation history of Google Chrome. Please keep Google Chrome history closed when extracting.

CASE ID (case:concept:name) => an identifier of the profile that has been extracted ACTIVITY (concept:name) => the complete path of the website, minus the GET arguments TIMESTAMP (time:timestamp) => the timestamp of visit

Parameters#

Parameters.HISTORY_DB_PATH

Path to the history DB path of Google Chrome (default: position of the Windows folder)

Returns#

dataframe

Pandas dataframe

pm4py.algo.connectors.variants.firefox_history module#

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

class pm4py.algo.connectors.variants.firefox_history.Parameters(value)[source]#

Bases: Enum

An enumeration.

HISTORY_DB_PATH = 'history_db_path'#
pm4py.algo.connectors.variants.firefox_history.apply(parameters: Optional[Dict[Any, str]] = None) DataFrame[source]#

Extracts a dataframe containing the navigation history of Mozilla Firefox. Please keep Google Mozilla Firefox closed when extracting.

CASE ID (case:concept:name) => an identifier of the profile that has been extracted ACTIVITY (concept:name) => the complete path of the website, minus the GET arguments TIMESTAMP (time:timestamp) => the timestamp of visit

Parameters#

Parameters.HISTORY_DB_PATH

Path to the history DB path of Mozilla Firefox (default: position of the Windows folder)

Returns#

dataframe

Pandas dataframe

pm4py.algo.connectors.variants.github_repo module#

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

class pm4py.algo.connectors.variants.github_repo.Parameters(value)[source]#

Bases: Enum

An enumeration.

OWNER = 'owner'#
REPOSITORY = 'repository'#
AUTH_TOKEN = 'auth_token'#
pm4py.algo.connectors.variants.github_repo.apply(parameters: Optional[Dict[Any, str]] = None) DataFrame[source]#

Extracts a dataframe containing the history of the issues of a Github repository. According to the API limit rate of public/registered users, only a part of the events can be returned.

Parameters#

prameters

Parameters of the algorithm, including: - Parameters.OWNER => owner of the repository (e.g., pm4py) - Parameters.REPOSITORY => name of the repository (e.g., pm4py-core) - Parameters.AUTH_TOKEN => authorization token

Returns#

dataframe

Pandas dataframe

pm4py.algo.connectors.variants.outlook_calendar module#

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

class pm4py.algo.connectors.variants.outlook_calendar.Parameters(value)[source]#

Bases: Enum

An enumeration.

EMAIL_USER = 'email_user'#
CALENDAR_ID = 'calendar_id'#
pm4py.algo.connectors.variants.outlook_calendar.apply(parameters: Optional[Dict[str, Any]] = None) DataFrame[source]#

Extracts the history of the calendar events (creation, update, start, end) in a Pandas dataframe from the local Outlook instance running on the current computer.

CASE ID (case:concept:name) => identifier of the meeting ACTIVITY (concept:name) => one between: Meeting Created, Last Change of Meeting, Meeting Started, Meeting Completed TIMESTAMP (time:timestamp) => the timestamp of the event case:subject => the subject of the meeting

Returns#

dataframe

Pandas dataframe

pm4py.algo.connectors.variants.outlook_mail_extractor module#

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

pm4py.algo.connectors.variants.outlook_mail_extractor.get_events(box, prefix, progress) List[Dict[str, Any]][source]#

Utility method extracting the items of a given mailbox.

Parameters#

box

Mailbox

prefix

Prefix for the activities (Sent / Received )

Returns#

list_events

List of events (dictionaries)

pm4py.algo.connectors.variants.outlook_mail_extractor.apply(parameters: Optional[Dict[str, Any]] = None) DataFrame[source]#

Extracts the history of the conversations from the local instance of Microsoft Outlook running on the current computer.

CASE ID (case:concept:name) => identifier of the conversation ACTIVITY (concept:name) => activity that is performed in the current item (send e-mail, receive e-mail, refuse meeting …) TIMESTAMP (time:timestamp) => timestamp of creation of the item in Outlook RESOURCE (org:resource) => sender of the current item

Returns#

dataframe

Pandas dataframe

pm4py.algo.connectors.variants.sap_accounting module#

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

class pm4py.algo.connectors.variants.sap_accounting.Parameters(value)[source]#

Bases: Enum

An enumeration.

CONNECTION_STRING = 'connection_string'#
PREFIX = 'prefix'#
pm4py.algo.connectors.variants.sap_accounting.apply(conn, parameters: Optional[Dict[Any, Any]] = None) DataFrame[source]#

Extracts an event log for the SAP Accounting process

Parameters#

conn

(if provided) ODBC connection object to the database (offering cursors)

parameters

Parameters of the algorithm, including: - Parameters.CONNECTION_STRING => connection string that is used (if no connection is provided) - Parameters.PREFIX => prefix to add to the table names (example SAPSR3.)

Returns#

dataframe

Pandas dataframe

pm4py.algo.connectors.variants.sap_o2c module#

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

class pm4py.algo.connectors.variants.sap_o2c.Parameters(value)[source]#

Bases: Enum

An enumeration.

CONNECTION_STRING = 'connection_string'#
PREFIX = 'prefix'#
pm4py.algo.connectors.variants.sap_o2c.apply(conn, parameters: Optional[Dict[Any, Any]] = None) DataFrame[source]#

Extracts an event log for the SAP Order-to-Cash process

Parameters#

conn

(if provided) connection object to the database (offering cursors)

parameters

Parameters of the algorithm, including: - Parameters.CONNECTION_STRING => ODBC connection string that is used (if no connection is provided) - Parameters.PREFIX => prefix to add to the table names (example SAPSR3.)

Returns#

dataframe

Pandas dataframe

pm4py.algo.connectors.variants.windows_events module#

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

pm4py.algo.connectors.variants.windows_events.apply(parameters: Optional[Dict[str, Any]] = None) DataFrame[source]#

Extract a process mining dataframe from all the events recorded in the Windows registry.

CASE ID (case:concept:name) => name of the computer emitting the events. ACTIVITY (concept:name) => concatenation of the source name of the event and the event identifier

TIMESTAMP (time:timestamp) => timestamp of generation of the event RESOURCE (org:resource) => username involved in the event

Returns#

dataframe

Pandas dataframe