pm4py.objects.ocel.importer.xmlocel.variants package#

PM4Py – A Process Mining Library for Python

Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see this software project’s root or visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions Contact: info@processintelligence.solutions

Submodules#

pm4py.objects.ocel.importer.xmlocel.variants.classic module#

PM4Py – A Process Mining Library for Python

Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see this software project’s root or visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions Contact: info@processintelligence.solutions

class pm4py.objects.ocel.importer.xmlocel.variants.classic.Parameters(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: Enum

EVENT_ID = 'param:event:id'#
EVENT_ACTIVITY = 'param:event:activity'#
EVENT_TIMESTAMP = 'param:event:timestamp'#
OBJECT_ID = 'param:object:id'#
OBJECT_TYPE = 'param:object:type'#
INTERNAL_INDEX = 'param:internal:index'#
QUALIFIER = 'param:qualifier'#
CHANGED_FIELD = 'param:chngfield'#
ENCODING = 'encoding'#
pm4py.objects.ocel.importer.xmlocel.variants.classic.parse_xml(value, tag_str_lower, parser)[source]#
pm4py.objects.ocel.importer.xmlocel.variants.classic.apply(file_path: str, parameters: Dict[Any, Any] | None = None) OCEL[source]#

Imports an object-centric event log from a XNK-OCEL file, using LXML

Parameters#

file_path

Path to the XML-OCEL file

parameters

Parameters of the algorithm, including: - Parameters.EVENT_ID - Parameters.EVENT_ACTIVITY - Parameters.EVENT_TIMESTAMP - Parameters.OBJECT_ID - Parameters.OBJECT_TYPE - Parameters.INTERNAL_INDEX

Returns#

ocel

Object-centric event log

pm4py.objects.ocel.importer.xmlocel.variants.ocel20 module#

PM4Py – A Process Mining Library for Python

Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see this software project’s root or visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions Contact: info@processintelligence.solutions

class pm4py.objects.ocel.importer.xmlocel.variants.ocel20.Parameters(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: Enum

EVENT_ID = 'param:event:id'#
EVENT_ACTIVITY = 'param:event:activity'#
EVENT_TIMESTAMP = 'param:event:timestamp'#
OBJECT_ID = 'param:object:id'#
OBJECT_TYPE = 'param:object:type'#
INTERNAL_INDEX = 'param:internal:index'#
QUALIFIER = 'param:qualifier'#
CHANGED_FIELD = 'param:chngfield'#
ENCODING = 'encoding'#
pm4py.objects.ocel.importer.xmlocel.variants.ocel20.parse_xml(value, tag_str_lower, parser)[source]#
pm4py.objects.ocel.importer.xmlocel.variants.ocel20.embed_date_parser(date_parser, x)[source]#
pm4py.objects.ocel.importer.xmlocel.variants.ocel20.apply(file_path: str, parameters: Dict[Any, Any] | None = None) OCEL[source]#

pm4py.objects.ocel.importer.xmlocel.variants.ocel20_rustxes module#

PM4Py – A Process Mining Library for Python

Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see this software project’s root or visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions Contact: info@processintelligence.solutions

pm4py.objects.ocel.importer.xmlocel.variants.ocel20_rustxes.apply(file_path: str, parameters: Dict[Any, Any] | None = None) OCEL[source]#

Imports an OCEL 2.0 XML using the RUSTXES parser.

Parameters#

file_path

Path to the OCEL 2.0 XML

parameters

Optional parameters.

Returns#

ocel

Object-centric event log