Jingga/oms-Workflow
1
0
Fork 0
mirror of https://github.com/Karaka-Management/oms-Workflow.git synced 2026-01-11 06:48:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
52c5c68598
oms-Workflow/Docs/workflow_components.md
Dennis Eichhorn 52c5c68598
Some checks failed
Image optimization / general_image_workflow (push) Has been cancelled
Details
CI / general_module_workflow_php (push) Has been cancelled
Details
CI / general_module_workflow_js (push) Has been cancelled
Details
fix permissions
2025-04-02 14:15:06 +00:00

2.0 KiB
Raw Blame History

Workflow Components

Every workflow has to provide a set of components in order to work. Other files are optional but can be used in order to enhance the experience. Additional files may be provided for better templating or for additional models but are not a necessety.

Template

The template.tpl.php file contains the UI of the workflow.

States

A States.php file contains all workflow states. This is especially important in order to show different content inside of the template.tpl.php depending on the state or in order to trigger state depended actions.

Workflow

The Workflow.php file is the heart of every workflow. This file is responsible for executing state driven actions and it can also be seen as the API for a workflow. All workflow related actions will be forwarded to this file and can be handled inside including database queries.

  1. Workflow gets installed with a trigger (either hook or cron job)
  2. Trigger is fired
  3. Hook loads CliApplication::installWorkflowTemplate with template ID, action ID and Hook
  4. Installer creates WorkflowInstance Model
  5. Installer calls CliApplication::runWorkflow with template, action ID, Hook, instance, and element for every element on this level.
  6. runWorkflow executes the element by calling the respective function
  7. runWorkflow calls itself with all child elements

Results can be stored in the workflow_instance_data field or in a workflow_step_data. The step data is if you want to store information for a specific step of a workflow instance.

Install file explanations

Triggers

Which internal event triggers exists. This allows workflows to bind actions to any of these possible triggers.

Actions

These are the workflow actions that the module exposes. These can be used to create your own workflow by chaining multiple actions together

Workflow definition

  1. You can define workflows based on the above mentioned triggers and actions
  2. You can create programmed workflows using hooks which then trigger a workflow
  3. You can create "forms" that function as workflows ()