mirror of
https://github.com/sartography/spiff-arena.git
synced 2025-01-28 02:05:52 +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
136 lines
5.6 KiB
ReStructuredText
136 lines
5.6 KiB
ReStructuredText
Overview
|
|
========
|
|
|
|
BPMN and SpiffWorkflow
|
|
----------------------
|
|
|
|
.. sidebar:: BPMN Resources
|
|
|
|
This guide is a mere introduction to BPMN.
|
|
For more serious modeling, we recommend looking for more comprehensive
|
|
resources. We have used the `books by Bruce Silver <https://www.amazon.com/Bruce-Silver/e/B0062AXUFY/ref=dp_byline_cont_pop_book_1>`_
|
|
as a guide for our BPMN modeling.
|
|
|
|
.. image:: figures/overview/bpmnbook.jpg
|
|
:align: center
|
|
|
|
Business Process Model and Notation (BPMN) is a diagramming language for specifying business
|
|
processes. BPMN links the realms of business and IT, and creates a common process language that
|
|
can be shared between the two.
|
|
|
|
BPMN describes details of process behaviors efficiently in a diagram. The meaning is precise enough
|
|
to describe the technical details that control process execution in an automation engine.
|
|
SpiffWorkflow allows you to create code to directly execute a BPMN diagram.
|
|
|
|
When using SpiffWorkflow, a client can manipulate the BPMN diagram and still have their product work
|
|
without a need for you to edit the Python code, improving response and turnaround time.
|
|
|
|
.. sidebar:: BPMN Modelers
|
|
|
|
|
|
Currently the best way to build BPMN diagrams is through our SpiffArena project
|
|
which provides a custom BPMN Modeler, along with ways to test and run BPMN diagrams
|
|
from within a web browser. Please see our `getting started guide <https://www.spiffworkflow.org/posts/articles/get_started/>`_
|
|
for more information.
|
|
|
|
It is also possible to use version 7 of the Camunda Modeler to create BPMN diagrams.
|
|
However, be cautious of the properies panel settings, as many of these settings are
|
|
not a part of the BPMN Standard, and are not handled in the same way within SpiffWorkflow.
|
|
You can download the Camunda Modeler from `Camunda <https://camunda.com/download/modeler/>`_.
|
|
|
|
Today, nearly every process modeling tool supports BPMN in some fashion making it a great tool to
|
|
learn and use. This page provides a brief overview, and the following section provides a more
|
|
in-depth look. There are many resources for additional information about BPMN.
|
|
|
|
Most of the examples in this guide have been created with
|
|
`our modeler <https://github.com/sartography/bpmn-js-spiffworkflow>`_, which is based on
|
|
`bpmn.js <https://bpmn.io/toolkit/bpmn-js/>`_.
|
|
|
|
|
|
|
|
A Simple Workflow
|
|
-----------------
|
|
|
|
All BPMN models have a start event and at least one end event. The start event
|
|
is represented with a single thin border circle. An end event is represented
|
|
by a single thick border circle.
|
|
|
|
The following example also has one task, represented by the rectangle with curved corners.
|
|
|
|
|
|
.. figure:: figures/overview/simplestworkflow.png
|
|
:scale: 25%
|
|
:align: center
|
|
|
|
A simple workflow.
|
|
|
|
|
|
The sequence flow is represented with a solid line connector. When the node at
|
|
the tail of a sequence flow completes, the node at the arrowhead is enabled to start.
|
|
|
|
|
|
A More Complicated Workflow
|
|
---------------------------
|
|
|
|
.. figure:: figures/overview/ExclusiveGateway.png
|
|
:scale: 25%
|
|
:align: center
|
|
|
|
A workflow with a gateway
|
|
|
|
|
|
In this example, the diamond shape is called a gateway. It represents a branch
|
|
point in our flow. This gateway is an exclusive data-based gateway (also
|
|
called an XOR gateway). With an exclusive gateway, you must take one path or
|
|
the other based on some data condition. BPMN has other gateway types.
|
|
|
|
The important point is that we can use a gateway to add a branch in the
|
|
workflow **without** creating an explicit branch in our Python code.
|
|
|
|
An Even More Complicated Workflow
|
|
------
|
|
BPMN is a rich language that can describe many different types of processes. In
|
|
the following pages we'll cover lanes (a way to distribute work across different
|
|
roles) events (a way to handle asynchronous events), multi-instance tasks (that
|
|
can be executed many times in parallel or in sequence) and decomposition (the
|
|
many ways you can interconnect diagrams to build larger more complex processes)
|
|
We are just scratching the surface. For now let's take one more step and look
|
|
at what Events make possible.
|
|
|
|
Events
|
|
^^^^^^^
|
|
In the above simple workflows, all of the transitions are deterministic and we
|
|
have direct connections between tasks. We need to handle the cases where an event
|
|
may or may not happen, and link these events in different parts of the workflow or
|
|
across different workflows.
|
|
|
|
BPMN has a comprehensive suite of event elements. SpiffWorkflow does not support
|
|
every single BPMN event type, but it can handle many of them.
|
|
|
|
.. figure:: figures/overview/events.png
|
|
:scale: 25%
|
|
:align: center
|
|
|
|
A workflow containing events
|
|
|
|
|
|
We've already seen plain Start and End Events. BPMN also includes the concept
|
|
of Intermediate Events (standalone events that may be Throwing or Catching) as well
|
|
as Boundary Events (which are exclusively Catching).
|
|
|
|
All Start Events are inherently Catching Events (a workflow can be initiated if a
|
|
particular event occurs) and all End Events are Throwing Events (they can convey
|
|
the final state of a workflow or path to other tasks and workflows).
|
|
|
|
If an Intermediate Throwing Event is added to a flow, the event it represents
|
|
will be generated and the flow will continue immediately. If an Intermediate
|
|
Catching Event is added to a flow, the workflow will wait to catch the event it
|
|
represents before advancing.
|
|
|
|
A Boundary Event represents an event that may be caught only while a particular task
|
|
is being executed and comes in two types: Interrupting (in which case the task it is
|
|
attached to will be cancelled if the event is received) or Non-Interrupting (in
|
|
which case the task will continue). In both cases, flows may emanate from the
|
|
Boundary Event, which will trigger those paths if the events occur while the task
|
|
is being executed.
|