Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add a example workflow to the documentation #68

Merged
merged 1 commit into from
Jan 12, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,53 @@ Workflow GUI adds a User Interface for configuring Pimcore Workflows.
* Install via command-line (or inside the pimcore extension manager): ```bin/console pimcore:bundle:install WorkflowGuiBundle```
* Make sure that the Bundles generated config is loaded (config/config.yaml): ```../var/bundles/workflow-gui/workflow.yml```

## Example workflow
Put the workflow below in the following location ``var/bundles/workflow-gui/workflow.yml`` and change the class ``Pimcore\Model\DataObject\Test`` to the dataobject you want to apply it to.
```yaml
pimcore:
workflows:
exampleWorkflow:
enabled: true
priority: 1
label: 'Example workflow'
initial_markings: placeA
type: workflow
audit_trail:
enabled: true
marking_store:
type: state_table
support_strategy:
type: expression
arguments:
- Pimcore\Model\DataObject\Test
- is_fully_authenticated()
places:
placeA:
visibleInHeader: true
title: 'Place A'
label: 'Place A'
color: '#eb0058'
placeB:
title: 'Place B'
visibleInHeader: true
label: 'Place B'
color: '#00800f'
transitions:
placeAtoB:
from:
- placeA
to:
- placeB
options:
label: 'Place A to B'
changePublishedState: no_change
notes:
commentEnabled: false
additionalFields: { }
globalActions: { }

```

## Configuration

* Inside your project, go to settings -> Workflows
Expand Down