process_configuration

Module to interact with process configurations.

This module contains class to interact with a process configuration in EMS data integration.

Typical usage example

process_configuration = data_model.create_process_configuration(
    activity_table_id=activity_table.id,
    case_id_column="CASE_ID",
    activity_column="ACTIVITY_EN",
    timestamp_column="EVENTTIME",
)
process_configuration.case_id_column = "CASE_ID"
process_configuration.update()
process_configuration.reload()
process_configuration.delete()

ProcessConfiguration

Bases: DataModelConfiguration

Process configuration object to interact with process configuration specific data integration endpoints.

client instance-attribute class-attribute

client: Client = Field(Ellipsis, exclude=True)

id instance-attribute

id: str

Id of process configuration.

data_model_id instance-attribute

data_model_id: str

Id of data model where process configuration is located.

data_pool_id instance-attribute

data_pool_id: str

Id of data pool where process configuration is located.

activity_table_id instance-attribute

activity_table_id: str

Id of data model activity table.

case_table_id instance-attribute

case_table_id: typing.Optional[str]

Id of data model case table.

case_id_column instance-attribute

case_id_column: typing.Optional[str]

Name of case id column.

activity_column instance-attribute

activity_column: typing.Optional[str]

Name of activity column.

timestamp_column instance-attribute

timestamp_column: typing.Optional[str]

Name of timestamp column.

sorting_column instance-attribute

sorting_column: typing.Optional[str]

Name of sorting column.

from_transport classmethod

from_transport(
    client, data_pool_id, data_model_configuration_transport
)

Creates high-level process configuration object from given DataModelConfigurationTransport.

Parameters:

• client (Client) –

  Client to use to make API calls for given process configuration.

• data_pool_id (str) –

  Id of data pool where process configuration is located

• data_model_configuration_transport (DataModelConfiguration) –

  DataModelConfigurationTransport object containing properties of process configuration.

Returns:

• ProcessConfiguration –

  A ProcessConfiguration object with properties from transport and given client.

update

update()

Pushes local changes of process configuration to EMS and updates properties with response from EMS.

sync

sync()

Syncs process configuration properties with EMS.

delete

delete()

Deletes process configuration.