mirror of
https://github.com/Karaka-Management/oms-Workflow.git
synced 2026-01-11 06:48:41 +00:00
bug fixes and template adjustments
This commit is contained in:
parent
5db8dd17b9
commit
0c2d6e8c4b
60
Docs/Dev/en/specification.md
Normal file
60
Docs/Dev/en/specification.md
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
# Specification
|
||||
|
||||
```json
|
||||
{
|
||||
"steps": [
|
||||
{
|
||||
"name": "step-name",
|
||||
"event-name": "unique-event-name-generated-on-upload",
|
||||
"type": 1,
|
||||
"template": "visual-template",
|
||||
"users": [],
|
||||
"groups": [],
|
||||
"event-listeners": [
|
||||
"event-to-listen-for-1"
|
||||
"event-to-listen-for-2"
|
||||
],
|
||||
"pre": {
|
||||
"event-trigger": [
|
||||
"event-to-trigger-1"
|
||||
"event-to-trigger-2"
|
||||
],
|
||||
"script": [
|
||||
"script-to-run-1"
|
||||
"script-to-run-2"
|
||||
]
|
||||
},
|
||||
"post": {
|
||||
"event-trigger": [
|
||||
"event-to-trigger-1"
|
||||
"event-to-trigger-2"
|
||||
],
|
||||
"script": [
|
||||
"script-to-run-1"
|
||||
"script-to-run-2"
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
....
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Good synergy with job module required... job runs every x and might invoke a workflow/workflow-step
|
||||
|
||||
## Type
|
||||
|
||||
* 1 = Autorun after previous event
|
||||
* 2 = Only if event listener is called
|
||||
|
||||
Every step receives the status code of all steps + the custom data created from the previous steps
|
||||
|
||||
After every step the handler writes custom data to the workflow run information.
|
||||
|
||||
This means every workflow has a configuration and whenever a new workflow get's triggered a new "workflow entry" is created.
|
||||
|
||||
## Template
|
||||
|
||||
e.g. user interface for this step
|
||||
|
|
@ -10,7 +10,7 @@
|
|||
"require-dev": {
|
||||
"phpunit/phpunit": ">=9.4",
|
||||
"friendsofphp/php-cs-fixer": ">=3.0",
|
||||
"squizlabs/php_codesniffer": ">=3.5",
|
||||
"squizlabs/php_codesniffer": ">=3.6",
|
||||
"phpmd/phpmd": ">=2.9",
|
||||
"phpstan/phpstan": ">=0.12.58",
|
||||
"phan/phan": ">=3.2.6"
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user