mirror of
https://github.com/sartography/spiff-arena.git
synced 2025-01-14 19:44:25 +00:00
c904ee907b
01a25fc3f Merge pull request #333 from sartography/feature/ruff 99c7bd0c7 ruff linting fixes 56d170ba1 Cleaning up badges in the readme. 51c13be93 tweaking action, adding button 96275ad7c Adding a github action to run tests c6c40976a minor fix to please sonarcloud. 03316babb Merge pull request #332 from sartography/updates-for-2.0-release ab70a34b5 Release Notes for 2.0.0_rc1 f0bf79bd9 copy edits a7c726951 Release Notes for 2.0.0_rc1 5f0468ba4 Merge pull request #330 from sartography/updates-for-2.0-release b9ad24406 Mostly minor edits e284dd8e2 corrections and tweaks to documentation 4b2e62600 add more examples 1ea258c6a update spiffworkflow concepts 851d7cdf6 fix a few bugs I found while testing the example repo 7a0a6bdf8 update bpmn docs 07c153f2d save/restore nested subprocess tests 340e9983b Merge branch 'main' of github.com:sartography/spiffworkflow into main 618afbc59 It is rare to submit an update that touches upon both religion and the origins of the universe. I think, for the sake of supporting all view points we must offer the possibility that there can be a thing that is not a child, but rather the beginning of all childen, that there is a chicken to the first egg, a single original big bank. a68dec77e use raw strings for regexes using escape sequences w/ burnettk 4644f2810 Merge pull request #329 from sartography/task/remove-deprecated-functions ca65602c0 correct typo in filename 39ab83f1f remove one deprecated and unused feature 23d54e524 Merge pull request #328 from sartography/improvement/task-spec-attributes 544614aa9 change dmn bpmn_id method to property 12ad185a4 update bpmnworkflow.waiting_events to use classname aec77097d fix some typos & add a few missing licenses 4b87c6d0c add some changes that didn't get included in the merge commit 965a5d4e1 Merge branch 'main' into improvement/task-spec-attributes a844b34f9 alternate bomnworkflow.cancel 0a455cdd2 Merge pull request #327 from sartography/feature/mark_tasks_in_sub_workflows_as_future_if_reseting_to_a_task_before_subworkflow 2bda992aa cancel tasks in subprocesses and return cancelled tasks 309937362 take account that we reset the parent when checking all sub-process executions. d4bcf1290 handle nested subprocesses when resetting tasks 032bedea6 reset subprocess task when resetting a task inside the subprocess 3a6abe157 change reset workflow to drop tasks and re-predict e9cd65757 move exceptions for bpmn into bpmn package e654f2ff1 add bpmn_id and bpmn_name attributes to task specs 74bb9cf1a Found that tasks within a sub-workflow were left in a state of "READY" after resetting to task before the sub-workflow. 957a8faec make all task specs in bpmn processes bpmn tasks b6070005c create actual mixin classes & improve package structure 666a9e4e5 Merge pull request #326 from sartography/feature/boundary_event_reset_fix 9fe5ae4ad Whenever a task is reset who's parent is a "_ParentBoundaryEvent" class, reset to that parent boundary event instead, and execute it, so that all the boundary events are reset to the correct point as well. fbc071af5 remove 'is_engine_step' and use existing 'manual' attribute instead 0d8e53a25 remove unused attributes, minor parser improvements 6ae98b585 Merge pull request #325 from sartography/bugfix/make-data-objects-available-to-gateways cefcd3733 make data objects available to gateways 6060fe778 Merge pull request #324 from sartography/task/update-license efa24bed2 update license 56271f7f7 Merge pull request #323 from sartography/bugfix/handle-dash-in-dmn 6de4e7e01 Merge pull request #322 from sartography/improvement/remove-celery 6ee0668cb remove unnecessary dependencies in test 7ceae68c2 change literal '-' in DMN input to None 4cffc7e7a remove celery task and dependency 580d6e516 Merge pull request #321 from sartography/improvement/allow-duplicate-subprocess-names e4440d4df remove legacy signavio parser 477a23184 remove absolute imports from tests failing in CI 15a812a92 use process ids only when storing process specs abaf1b9e9 move parallel gateway tests to their own package 29fd2d0d9 remove some redundant, unused, or unnecessary tests & consolidate others fda1480bc remove unused CORRELATE attribute from tests 21a2fdbee remove signavio files 299c2613c Merge pull request #320 from sartography/parser_funcs 01afc9f6e PR feedback 646737834 Cleanup dfd3f8214 Add same methods for dmn 764e33ccd Rename file, fix tests 9646abca4 Add bpmn in memory parser functions and tests 58f6bd317 Merge pull request #319 from sartography/feature/better_task_order_for_sub_processes fd7c9308f By swapping the order of these lines, we can assure that a call activity is returned BEFORE the tasks that it contains, rather than after it. 0a7ec19d6 Merge pull request #318 from sartography/feature/optionally-skip-call-activities-when-parsing 3430a2e9f add option to skip parsing call activities 1b1da1dd2 Merge pull request #317 from sartography/bugfix/non-bpmn-tutorial e82345d68 remove some bpmn-related stuff from core serializer 6f9bc279c use name for inputs/outputs in base serializer -- not sure why this was ever changed git-subtree-dir: SpiffWorkflow git-subtree-split: 01a25fc3f829786c4b65d19fd0fda408de37c79f
87 lines
3.1 KiB
ReStructuredText
87 lines
3.1 KiB
ReStructuredText
Gateways
|
|
========
|
|
|
|
BPMN Model
|
|
----------
|
|
|
|
In this section, we'll expand our model by creating alternate paths through the
|
|
workflow depending on the current workflow state, in this case, answers provided
|
|
by the user through forms.
|
|
|
|
We've also added a second DMN table to find the cost of the selected shipping
|
|
method, and we updated our order total calculations to incorporate that cost.
|
|
|
|
We'll be using the following files from `spiff-example-cli <https://github.com/sartography/spiff-example-cli>`_.
|
|
|
|
- `gateway_types <https://github.com/sartography/spiff-example-cli/blob/main/bpmn/gateway_types.bpmn>`_ workflow
|
|
- `product_prices <https://github.com/sartography/spiff-example-cli/blob/main/bpmn/product_prices.dmn>`_ DMN table
|
|
- `shipping_costs <https://github.com/sartography/spiff-example-cli/blob/main/bpmn/shipping_costs.dmn>`_ DMN table
|
|
|
|
Exclusive Gateway
|
|
^^^^^^^^^^^^^^^^^
|
|
|
|
Exclusive Gateways are used when exactly one alternative can be selected.
|
|
|
|
Suppose our products are T-shirts and we offer product C in several colors. After
|
|
the user selects a product, we check to see it if is customizable. Our default
|
|
branch will be 'Not Customizable', but we'll direct the user to a second form
|
|
if they select 'C'; our condition for choosing this branch is a simple python
|
|
expression.
|
|
|
|
.. figure:: figures/gateways/exclusive_gateway.png
|
|
:scale: 30%
|
|
:align: center
|
|
|
|
Flow configuration
|
|
|
|
Parallel Gateway
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
.. sidebar:: IDs vs Names
|
|
|
|
We've assigned descriptive names to all our tasks so far. Text added to
|
|
the Name field will appear in the diagram, so sometimes it's better to
|
|
leave it blank to avoid visual clutter. I've put a description of the
|
|
gateway into the ID field instead.
|
|
|
|
Parallel Gateways are used when the subsequent tasks do not need to be completed
|
|
in any particular order. The user can complete them in any sequence and the
|
|
workflow will wait for all tasks to be finished before advancing.
|
|
|
|
We do not care whether the user chooses a shipping method or enters their
|
|
address first, but they'll need to complete both tasks before continuing.
|
|
|
|
We don't need to do any particular configuration for this gateway type.
|
|
|
|
.. figure:: figures/gateways/parallel_gateway.png
|
|
:scale: 30%
|
|
:align: center
|
|
|
|
Parallel Gateway example
|
|
|
|
Inclusive Gateway
|
|
^^^^^^^^^^^^^^^^^
|
|
|
|
SpiffWorkflow also supports Inclusive Gateways, though we do not have an example of this gateway
|
|
type in this tutorial. Inclusive Gateways have conditions on outgoing flows like Exclusive Gateways,
|
|
but unlike Exclusive Gateways, multiple paths may be taken if more than one conition is met.
|
|
|
|
Event-Based Gateway
|
|
^^^^^^^^^^^^^^^^^^^
|
|
|
|
SpiffWorkflow supports Event-Based Gateways, though we do not use them in this tutorial. Event-Based
|
|
gateways select an outgoing flow based on an event. We'll discuss events in the next section.
|
|
|
|
Running The Model
|
|
^^^^^^^^^^^^^^^^^
|
|
|
|
If you have set up our example repository, this model can be run with the
|
|
following command:
|
|
|
|
.. code-block:: console
|
|
|
|
./spiff-bpmn-runner.py -p order_product \
|
|
-d bpmn/tutorial/product_prices.dmn bpmn/tutorial/shipping_costs.dmn \
|
|
-b bpmn/tutorial/gateway_types.bpmn
|
|
|