diff --git a/docs/index.md b/docs/index.md index 6162b4f4..d4e2ae02 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,7 +5,6 @@ :caption: Getting Started learn_basics/learn_basics.md quick_start/quick_start.md -learn_basics/bpmn_terminology.md ``` ```{toctree} @@ -48,6 +47,7 @@ how_to/complete_a_task_on_behalf_of_another_user.md :maxdepth: 3 :caption: Glossary glossary/glossary.md +learn_basics/bpmn_terminology.md ``` diff --git a/docs/learn_basics/images/Annotation.png b/docs/learn_basics/images/Annotation.png new file mode 100644 index 00000000..51088a41 Binary files /dev/null and b/docs/learn_basics/images/Annotation.png differ diff --git a/docs/learn_basics/images/BPMN_end_event-50x51.png b/docs/learn_basics/images/BPMN_end_event-50x51.png deleted file mode 100644 index 66a3e92c..00000000 Binary files a/docs/learn_basics/images/BPMN_end_event-50x51.png and /dev/null differ diff --git a/docs/learn_basics/images/BPMN_intermediate_event-47x48.png b/docs/learn_basics/images/BPMN_intermediate_event-47x48.png deleted file mode 100644 index 712d5b1b..00000000 Binary files a/docs/learn_basics/images/BPMN_intermediate_event-47x48.png and /dev/null differ diff --git a/docs/learn_basics/images/BPMN_start_event-47x47.png b/docs/learn_basics/images/BPMN_start_event-47x47.png deleted file mode 100644 index 9b50baff..00000000 Binary files a/docs/learn_basics/images/BPMN_start_event-47x47.png and /dev/null differ diff --git a/docs/learn_basics/images/Businessrule.png b/docs/learn_basics/images/Businessrule.png new file mode 100644 index 00000000..961a0b4e Binary files /dev/null and b/docs/learn_basics/images/Businessrule.png differ diff --git a/docs/learn_basics/images/Callactivity.png b/docs/learn_basics/images/Callactivity.png new file mode 100644 index 00000000..28be2dd6 Binary files /dev/null and b/docs/learn_basics/images/Callactivity.png differ diff --git a/docs/learn_basics/images/Complex.png b/docs/learn_basics/images/Complex.png new file mode 100644 index 00000000..2527afbd Binary files /dev/null and b/docs/learn_basics/images/Complex.png differ diff --git a/docs/learn_basics/images/Complex_Gateway.png b/docs/learn_basics/images/Complex_Gateway.png deleted file mode 100644 index ed6f29e9..00000000 Binary files a/docs/learn_basics/images/Complex_Gateway.png and /dev/null differ diff --git a/docs/learn_basics/images/Data_Object.png b/docs/learn_basics/images/Data_Object.png new file mode 100644 index 00000000..f921fa0e Binary files /dev/null and b/docs/learn_basics/images/Data_Object.png differ diff --git a/docs/learn_basics/images/Data_Storage.png b/docs/learn_basics/images/Data_Storage.png new file mode 100644 index 00000000..89317471 Binary files /dev/null and b/docs/learn_basics/images/Data_Storage.png differ diff --git a/docs/learn_basics/images/End.png b/docs/learn_basics/images/End.png new file mode 100644 index 00000000..431fb91e Binary files /dev/null and b/docs/learn_basics/images/End.png differ diff --git a/docs/learn_basics/images/EndEvent.png b/docs/learn_basics/images/EndEvent.png deleted file mode 100644 index 79318ba6..00000000 Binary files a/docs/learn_basics/images/EndEvent.png and /dev/null differ diff --git a/docs/learn_basics/images/End_Event.png b/docs/learn_basics/images/End_Event.png deleted file mode 100644 index 9ddd3ff7..00000000 Binary files a/docs/learn_basics/images/End_Event.png and /dev/null differ diff --git a/docs/learn_basics/images/Eventbased.png b/docs/learn_basics/images/Eventbased.png new file mode 100644 index 00000000..63d33517 Binary files /dev/null and b/docs/learn_basics/images/Eventbased.png differ diff --git a/docs/learn_basics/images/Exclusive.png b/docs/learn_basics/images/Exclusive.png new file mode 100644 index 00000000..93f10446 Binary files /dev/null and b/docs/learn_basics/images/Exclusive.png differ diff --git a/docs/learn_basics/images/Exclusive_Gateway.png b/docs/learn_basics/images/Exclusive_Gateway.png deleted file mode 100644 index 443d0595..00000000 Binary files a/docs/learn_basics/images/Exclusive_Gateway.png and /dev/null differ diff --git a/docs/learn_basics/images/Group.png b/docs/learn_basics/images/Group.png new file mode 100644 index 00000000..2c4854c8 Binary files /dev/null and b/docs/learn_basics/images/Group.png differ diff --git a/docs/learn_basics/images/Inclusive.png b/docs/learn_basics/images/Inclusive.png new file mode 100644 index 00000000..79f43ac3 Binary files /dev/null and b/docs/learn_basics/images/Inclusive.png differ diff --git a/docs/learn_basics/images/Inclusive_Gateway.png b/docs/learn_basics/images/Inclusive_Gateway.png deleted file mode 100644 index 3bf8db68..00000000 Binary files a/docs/learn_basics/images/Inclusive_Gateway.png and /dev/null differ diff --git a/docs/learn_basics/images/Intermediate.png b/docs/learn_basics/images/Intermediate.png new file mode 100644 index 00000000..330d4c81 Binary files /dev/null and b/docs/learn_basics/images/Intermediate.png differ diff --git a/docs/learn_basics/images/IntermediateEvent.png b/docs/learn_basics/images/IntermediateEvent.png deleted file mode 100644 index 3a14945a..00000000 Binary files a/docs/learn_basics/images/IntermediateEvent.png and /dev/null differ diff --git a/docs/learn_basics/images/Manual.png b/docs/learn_basics/images/Manual.png new file mode 100644 index 00000000..c3376b4b Binary files /dev/null and b/docs/learn_basics/images/Manual.png differ diff --git a/docs/learn_basics/images/Receive.png b/docs/learn_basics/images/Receive.png new file mode 100644 index 00000000..cfe9650a Binary files /dev/null and b/docs/learn_basics/images/Receive.png differ diff --git a/docs/learn_basics/images/Script.png b/docs/learn_basics/images/Script.png new file mode 100644 index 00000000..2db4d402 Binary files /dev/null and b/docs/learn_basics/images/Script.png differ diff --git a/docs/learn_basics/images/Send.png b/docs/learn_basics/images/Send.png new file mode 100644 index 00000000..3cea40cb Binary files /dev/null and b/docs/learn_basics/images/Send.png differ diff --git a/docs/learn_basics/images/Service_task.png b/docs/learn_basics/images/Service_task.png new file mode 100644 index 00000000..d3a83c91 Binary files /dev/null and b/docs/learn_basics/images/Service_task.png differ diff --git a/docs/learn_basics/images/Sevice.png b/docs/learn_basics/images/Sevice.png new file mode 100644 index 00000000..d3a83c91 Binary files /dev/null and b/docs/learn_basics/images/Sevice.png differ diff --git a/docs/learn_basics/images/Start.png b/docs/learn_basics/images/Start.png new file mode 100644 index 00000000..d1f9480c Binary files /dev/null and b/docs/learn_basics/images/Start.png differ diff --git a/docs/learn_basics/images/StartEvent.png b/docs/learn_basics/images/StartEvent.png deleted file mode 100644 index c375c675..00000000 Binary files a/docs/learn_basics/images/StartEvent.png and /dev/null differ diff --git a/docs/learn_basics/images/SubProcess.png b/docs/learn_basics/images/SubProcess.png new file mode 100644 index 00000000..f6809f50 Binary files /dev/null and b/docs/learn_basics/images/SubProcess.png differ diff --git a/docs/learn_basics/images/User.png b/docs/learn_basics/images/User.png new file mode 100644 index 00000000..887fbe40 Binary files /dev/null and b/docs/learn_basics/images/User.png differ diff --git a/docs/learn_basics/images/complex-gateway-53x53.png b/docs/learn_basics/images/complex-gateway-53x53.png deleted file mode 100644 index 3bb2bbec..00000000 Binary files a/docs/learn_basics/images/complex-gateway-53x53.png and /dev/null differ diff --git a/docs/learn_basics/images/event-based-gateway-52x54.png b/docs/learn_basics/images/event-based-gateway-52x54.png deleted file mode 100644 index 4b737486..00000000 Binary files a/docs/learn_basics/images/event-based-gateway-52x54.png and /dev/null differ diff --git a/docs/learn_basics/images/exclusive-gateway-55x54.png b/docs/learn_basics/images/exclusive-gateway-55x54.png deleted file mode 100644 index 81688430..00000000 Binary files a/docs/learn_basics/images/exclusive-gateway-55x54.png and /dev/null differ diff --git a/docs/learn_basics/images/inclusive-gateway-54x53.png b/docs/learn_basics/images/inclusive-gateway-54x53.png deleted file mode 100644 index 2c8a0558..00000000 Binary files a/docs/learn_basics/images/inclusive-gateway-54x53.png and /dev/null differ diff --git a/docs/learn_basics/images/parallel-event-based-gateway-52x53.png b/docs/learn_basics/images/parallel-event-based-gateway-52x53.png deleted file mode 100644 index 288b8bca..00000000 Binary files a/docs/learn_basics/images/parallel-event-based-gateway-52x53.png and /dev/null differ diff --git a/docs/learn_basics/images/parallel-gateway-57x57.png b/docs/learn_basics/images/parallel-gateway-57x57.png deleted file mode 100644 index a21e3597..00000000 Binary files a/docs/learn_basics/images/parallel-gateway-57x57.png and /dev/null differ diff --git a/docs/learn_basics/learn_basics.md b/docs/learn_basics/learn_basics.md index 61bf7387..83fd82b8 100644 --- a/docs/learn_basics/learn_basics.md +++ b/docs/learn_basics/learn_basics.md @@ -12,44 +12,45 @@ When using SpiffWorkflow, a client can create the BPMN diagram and still have th ## BPMN Elements BPMN (Business Process Model and Notation) elements are the building blocks used to model business processes visually. They represent different aspects of a process, such as tasks, events, gateways, and flows, and are used to describe the flow of activities, decisions, and data within a process. -### Tasks -Tasks represent activities or work that needs to be performed as part of a process. They can be manual tasks that require human intervention or automated tasks that are executed by systems or applications. - -| **Task** | **Symbol** | **Description** | -|---------------|------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Service |
![Untitled](images/Service-tasks.png) | Task that uses a Web service, an automated application, or other kinds of service in completing the task. | -| Send |![Untitled](images/Send_task.png) | Task that sends a Message to another pool. The Task is completed once the Message has been sent. | -| Receive |
![Untitled](images/Receive_task.png) | A Receive Task indicates that the process has to wait for a message to arrive in order to continue. The Task is completed once the| message has received. | -| User |
![Untitled](images/Users_task.png) | A User Task represents that a human performer performs the Task with the use of a software application. | -| Manual |
![Untitled](images/Manual_task.png) | A Manual Task is a Task that is performed without the aid of any business process execution engine or any application. | -| Business Rule |
![Untitled](images/Business-rule-tasks.png) | Business Rule Task provides a mechanism for a process to provide input to a Business Rules Engine and then obtain the output provided by the Business Rules Engine. | -| Script |
![Untitled](images/Script-tasks.png) | A Script Task defines a script that the engine can interpret. | | - ### Events Events, represented with circles, describe something that happens during the course of a process. There are three main events within business process modeling: start events, intermediate events, and end events. -| **Event** | **Symbol**| **Description** | -|---------------|-----------|-----------------| -| Start Event |![Untitled](images/Start_Event.png) | Signals the first step of a process | -| Intermediate Event | ![Untitled](images/Intermdiate.png) | Represents any event that occurs between a start and end event. | -| End event | ![Untitled](images/End_Event.png) | Signals the final step in a process. | +| **Event** | **Symbol**| **Description** | +|-----------|-----------|-----------------| +| Start Event |![Untitled](images/Start.png) | Signals the first step of a process | +| Intermediate Event | ![Untitled](images/Intermediate.png) | Represents any event that occurs between a start and end event. | +| End event | ![Untitled](images/End.png) | Signals the final step in a process. | ### Gateways Gateways represent decision points in a process. They determine which path the process will take based on certain conditions or rules. There are different types of gateways: | **Gateway** | **Symbol**| **Description** | |---------------|-----------|-----------------| -| Exclusive gateway |![Untitled](images/Exclusive_Gateway.png) | Evaluates the state of the business process and, based on the condition, breaks the flow into one or more mutually exclusive paths | -| Event-based gateway | ![Untitled](images/Event_Gateway.png) | An event-based gateway is similar to an exclusive gateway both involve one path in the flow. In the case of an event-based gateway, however, you evaluate which event has occurred, not which condition has been met. | -| Parallel gateway | ![Untitled](images/Parallet_gateway.png) | Parallel gateways are used to represent two tasks in a business flow. A parallel gateway is used to visualize the concurrent execution of activities. | -| Inclusive gateway | ![Untitled](images/Inclusive_Gateway.png) | An inclusive gateway breaks the process flow into one or more flows. | -| Complex gateway | ![Untitled](images/Complex_Gateway.png) | complex gateways are only used for the most complex flows in the business process. They use words in place of symbols and, therefore, require more descriptive text. | -| | +| Exclusive gateway |![Untitled](images/Exclusive.png) | Evaluates the state of the business process and, based on the condition, breaks the flow into one or more mutually exclusive paths | +| Event-based gateway | ![Untitled](images/Eventbased.png) | An event-based gateway is similar to an exclusive gateway both involve one path in the flow. In the case of an event-based gateway, however, you evaluate which event has occurred, not which condition has been met. | +| Inclusive gateway | ![Untitled](images/Inclusive.png) | An inclusive gateway breaks the process flow into one or more flows. | +| Complex gateway | ![Untitled](images/Complex.png) | Complex gateways are only used for the most complex flows in the business process. They use words in place of symbols and, therefore, require more descriptive text. | -### Flows -Flows represent the sequence or direction of activities in a process. There are different types of flows in BPMN, including sequence flows, message flows, and association flows. Sequence flows indicate the order in which tasks are performed, message flows represent the exchange of messages between participants, and association flows connect data objects or artifacts to activities. +### Tasks +Tasks represent activities or work that needs to be performed as part of a process. They can be manual tasks that require human intervention or automated tasks that are executed by systems or applications. + +| **Task** | **Symbol** | **Description** | +|---------------|------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Service |![Untitled](images/Service_task.png) | Task that uses a Web service, an automated application, or other kinds of service in completing the task. | +| Send |![Untitled](images/Send.png) | Task that sends a Message to another pool. The Task is completed once the Message has been sent. | +| Receive | ![Untitled](images/Receive.png) | A Receive Task indicates that the process has to wait for a message to arrive in order to continue. The Task is completed once the| message has received. | +| User | ![Untitled](images/User.png) | A User Task represents that a human performer performs the Task with the use of a software application. | +| Manual | ![Untitled](images/Manual.png) | A Manual Task is a Task that is performed without the aid of any business process execution engine or any application. | +| Business Rule |![Untitled](images/Businessrule.png)| Business Rule Task provides a mechanism for a process to provide input to a Business Rules Engine and then obtain the output provided by the Business Rules Engine. | +| Script | ![Untitled](images/Script.png) | A Script Task defines a script that the engine can interpret. | +| Call Activity | ![Untitled](images/Callactivity.png) | A call activity allows you to call and invoke another process as part of this process.processes. | +| Sub-Process | ![Untitled](images/SubProcess.png) | Sub-processes allow you to collapse and expand tasks to quickly convey information. | ### Artifacts Artifacts are used to provide additional information or documentation within a process. They include data objects (representing information or data needed for the process), annotations (providing explanatory or descriptive text), and groups (used to visually group related elements). - -[def]: images/Untitled_2.png +| **Artifact** | **Symbol** | **Description** | +|---------------|------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Data Object |![Untitled](images/Data_Object.png) | Data objects can represent data placed to the process, data resulting from the process, data that needs to be collected | +| Data Storage |![Untitled](images/Data_Storage.png) | Data storage provides the ability to store or access data that is associated with a business model. If your process outputs any data, it will become necessary to store that data. | +| Group |
![Untitled](images/Group.png) | Groups organize tasks or processes that have significance in the overall process.​​ | +| Annotation |
![Untitled](images/Annotation.png) | Annotations allow you to describe the business process and flow objects in more detail. | diff --git a/docs/quick_start/quick_start.md b/docs/quick_start/quick_start.md index 8081813c..529155b1 100644 --- a/docs/quick_start/quick_start.md +++ b/docs/quick_start/quick_start.md @@ -1,4 +1,4 @@ -# Quick start guide +# QuickStart Guide ```{admonition} Welcome to the SpiffWorkflow quick start guide! :class: info