Skip to main content

Workflows

In Workflows, individual, predefined WorkFlowStepClasses can be combined into sequences that are executed step by step.

Example:
Which individual steps should be executed during validation and in which order.


Creating Workflows

A new Workflow can be created using the "Create" button within the CRUD component.
Existing Workflows can be edited or viewed using the inline icons.

Fields:

  • Code (mandatory)
    → Technical name of the workflow.
    → Can be freely chosen, should follow general naming conventions, and must be unique within the workflows.

  • Category (mandatory)
    → Assign a WorkflowCategory for which the Workflow is intended.
    → Only WorkFlowSteps that are assigned to this selected Category can be added.

  • Descriptions (optional)
    → Description of the workflow in multiple languages, for example:

    de_de = Farbe wechseln
    en_en = Change Color

Procedure:

  1. Click "Create" to open the entry dialog for a new Workflow.
  2. Alternatively, view or edit an existing Workflow.
  3. Define "Code".
  4. Assign "Category".
  5. Optionally enter the "Description" in multiple languages.
  6. Save → Create the new Workflow.
  7. Save → Save the changes.

WorkFlowSteps

Here, predefined WorkflowStepClasses can be assigned to the Workflow.
Each WorkFlowStep is also assigned an Order that defines the sequence in which it is executed.

Fields:

  • Code (mandatory)
    → Technical name of the WorkflowStep.
    → Can be freely chosen, should follow general naming conventions, and must be unique within the WorkflowSteps.

  • StepClasses (mandatory)
    → Assign a WorkflowStepClass to be executed at this position.

  • Order (mandatory)
    → Defines the execution order.


Procedure:

  1. Click "Create" to open the entry dialog for a new WorkflowStep.
  2. Alternatively, view or edit an existing WorkflowStep.
  3. Define "Code".
  4. Assign "WorkflowStepClass".
  5. Define "Order".
  6. Save → Create the new WorkflowStep.
  7. Save → Save the changes.

→ A Workflow can have any number of WorkFlowSteps assigned.


WorkflowStepParameters

Here, additional parameters can be assigned to a WorkflowStep to influence its behavior.

Fields:

  • Key (mandatory)
    → Set a Key.

  • Value (mandatory)
    → Assign a Value.


Procedure:

  1. Click "Create" to open the entry dialog for a new WorkflowStepParameter.
  2. Alternatively, view or edit an existing WorkflowStepParameter.
  3. Define "Key".
  4. Define "Value".
  5. Save → Create the new WorkflowStepParameter.
  6. Save → Save the changes.

→ A WorkFlowStep can have any number of WorkflowStepParameters assigned.