Skip to content

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:

```python
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 class-attribute instance-attribute

client = Field(..., exclude=True)

id instance-attribute

id

Id of process configuration.

data_model_id instance-attribute

data_model_id

Id of data model where process configuration is located.

data_pool_id instance-attribute

data_pool_id

Id of data pool where process configuration is located.

activity_table_id instance-attribute

activity_table_id

Id of data model activity table.

case_table_id instance-attribute

case_table_id

Id of data model case table.

case_id_column instance-attribute

case_id_column

Name of case id column.

activity_column instance-attribute

activity_column

Name of activity column.

timestamp_column instance-attribute

timestamp_column

Name of timestamp column.

sorting_column instance-attribute

sorting_column

Name of sorting column.

tenant_id class-attribute instance-attribute

tenant_id = Field(alias='tenantId')

default_configuration class-attribute instance-attribute

default_configuration = Field(alias='defaultConfiguration')

end_timestamp_column class-attribute instance-attribute

end_timestamp_column = Field(alias='endTimestampColumn')

cost_column class-attribute instance-attribute

cost_column = Field(alias='costColumn')

user_column class-attribute instance-attribute

user_column = Field(alias='userColumn')

use_parallel_process class-attribute instance-attribute

use_parallel_process = Field(alias='useParallelProcess')

parallel_process_parent_column class-attribute instance-attribute

parallel_process_parent_column = Field(
    alias="parallelProcessParentColumn"
)

parallel_process_child_column class-attribute instance-attribute

parallel_process_child_column = Field(
    alias="parallelProcessChildColumn"
)

optional_tenant_id class-attribute instance-attribute

optional_tenant_id = Field(alias='optionalTenantId')

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.