Standard Workflow

class StandardWorkflow(api)

Bases: _WorkflowBase

create(name, parent_folder, stage, injection_command=None, application_class_name=None, approvers=None, macro=None, reason_code=None, attributes=None, get_if_already_exists=True)

One of injection_command or approvers must be given.

If a list of approver identity objects is provided, they will be added directly to the workflow as approvers of the workflow. If the approvers should come from the object requiring the workflow, such as the certificate object, then do not supply approvers. If the approvers come from a TPP Macro, then supply macro with the desired macro.

Parameters

• name (str) – Name of the workflow object.

• parent_folder (Union[config.Object, str]) – Config Object or Distinguished Name (DN) of the parent folder.

• stage (int) – Workflow stage.

• injection_command (str) – Command to be invoked on the target application.

• application_class_name (str) – Application class name to trigger this workflow.

• approvers (List[Union[ident.Identity, str]]) – List of Identity Object or Prefixed Name for each approver.

• macro (str) – TPP approver macro.

• reason_code (int) – Integer reason code.

• attributes (dict) – Additional attributes to apply to the workflow object.

• get_if_already_exists (bool) – If the objects already exists, it is modified according to these parameters. Else an exception is raised.

Returns

Config Object of the workflow object.

delete(workflow)

Deletes a workflow.

Parameters

workflow (Union[config.Object, str]) – Config Object or Distinguished Name (DN) of the workflow object.

get(workflow_dn, raise_error_if_not_exists=True)

Returns the config object of the folder DN.

Parameters

• workflow_dn (str) – Distinguished Name (DN) of the workflow.

• raise_error_if_not_exists (bool) – Raise an exception if the object Distinguished Name (DN) does not exist.

Returns

Config Object of the workflow object.