ecm.workflow

The ecm.workflow namespace provides access to workflow functionality of the ECM server.

Method Description

organisations()

Returns all defined workflow organisations.

organisation_objects()

Returns objects from the organisation tree.

process_list_by_user()

Returns all processes that have a work item in the user’s inbox.

absent_users()

Returns all users marked as absent in an organisation.

configure_user_absence()

Marks users as absent or present.

save_organisation()

Persists a workflow organisation and notifies all clients.

set_substitutes()

Sets the substitutes for any number of users or roles.

client_types()

Returns all client types defined in the system.

workflow_list()

Returns the workflows a user may start.

workflow_by_name()

Resolves a workflow by its model name.

start_process()

Creates and starts a workflow process instance and returns the process ID.

workflow_model_by_name()

Returns a typed variable model class for a workflow.

Typed workflow-variable models can also be generated as .py files — see the ecm-generate-workflow-models guide.