9.4 KiB
Using Spiffdemo.org
Spiffdemo is a demo version of Spiffworkflow, offering a limited set of functions and features. It provides users a platform to explore workflow concepts through a collection of top-level examples, diagrams, and workflows. Users can interact with pre-built models, make modifications, and visualize process flows. Spiffdemo serves as a demonstration version of Spiffworkflow, providing a glimpse into its capabilities with limited functionality. Spiffworkflow, on the other hand, is a full-fledged tool that offers a broader range of features for creating and managing workflows.
| Category | Spiffdemo (Demo Version) | SpiffWorkflow (Full Version) |
|---|---|---|
| Functionality | Limited set of functions and features | Comprehensive set of features and functions for creating, managing, and optimizing process models and workflows |
| Purpose | Provides a platform for exploration and demonstration of workflow concepts | Enables users to create, manage, and optimize their own process models and workflows for their specific needs and requirements |
| Features | Limited functionality for interacting with pre-built models and making modifications | Advanced features such as task management, process modeling, diagram editing, and customizable properties |
How to Login to Spiffdemo
To begin your journey with Spiffdemo, open your web browser and navigate to the official Spiffdemo website.
On the login screen, you will find the option to log in using Single Sign-On. Click the Single Sign-On button and select your preferred login method, such as using your Gmail account.
More ways to access Spiffdemo are coming your way!
Exploring the Examples
When logging into the dashboard, it is crucial to familiarize yourself with the functions it offers and how the underlying engine operates. In the demo website, we will explore two examples: the Minimal Example and the Essential Example, to provide a clear understanding of the process.
Minimal Example
Let's begin with the Minimal Example, which serves as a "Hello World" process—a simple executable BPMN Diagram designed to demonstrate basic functionality. Rather than immediately starting the process, we will first examine its structure.
Access the Process Directory
Clicking on the process name will open the directory dedicated to the Minimal Example process. From here, you can start the process if desired, but for the purpose of this example, we will proceed with an explanation of its components and functionality. Therefore, Locate and click on the .bpmn file to access the BPMN editor.
The BPMN editor provides a visual representation of the process workflow.
Understand the Process Workflow
The Minimal Example process consists of three key elements: a start event, a manual task, and an end event. It is essential to understand the purpose and functionality of the properties panel, which is an integral component of the process diagram. Without selecting any specific task within the diagram editor, the properties panel will appear as follows:
General
-
Name field is usually empty unless user wants to provide it. It serves as a label or identifier for the process.
-
The ID is automatically populated by the system (default behavior) however it can be updated by the user, but it must remain unique within the other processes.
-
By default, all processes are executable, which means the engine can run the process.
Documentation
- This field can be used to provide any notes related to the process.
Data Objects
- Used to configure Data Objects added to the process. See full article here.
1. Start Event
The first event in the minimal example is the start event. Each process diagram begins with a Start Event. Now explore the properties panel when you click on the first process of the diagram, “Start Event”.
General
-
The Name for a Start Event is often left blank unless it needs to be named to provide more clarity on the flow or to be able to view this name in Process Instance logs.
-
ID is automatically populated by the system (default behavior) however it can be updated by the user, but it must remain unique within the process. Often the ID would be updated to allow easier referencing in messages and also Logs as long as it’s unique in the process.
Documentation
- This field is used to provide any notes related to the element.
This type of Start Event signifies that the process can be initiated without any triggering message or timer event.
It is worth noting that there are other types of Start Events available, such as Message Start Events and Timer Start Events.
These advanced Start Events will be discussed in detail in the subsequent sections, providing further insights into their specific use cases and functionalities.
2. Manual Task
Within the process flow, the next step is a manual task. A Manual Task is another type of BPMN Task requiring human involvement. Manual Tasks do not require user input other than clicking a button to acknowledge the completion of a task that usually occurs outside of the process.
Now explore the properties panel when you click on the first process of the process of “Show Example Manual Task”.
Panel General Section
-
Enter/Edit the User Task name in this section. Alternatively, double-click on the User Task in the diagram.
-
The ID is automatically entered and can be edited for improved referencing in error messages, but it must be unique within the process.
Documentation Section
- This field is used to provide any notes related to the element.
SpiffWorkflow Scripts
-
Pre-Script: Updates Task Data using Python prior to execution of the Activity.
-
Post-Script: Updates Task Data using Python immediately after execution of the Activity.
Instructions
During the execution of this task, the following instructions will be displayed to the end user. This section serves as a means to format and present information to the user. The formatting is achieved through a combination of Markdown and Jinja. To view and edit the instructions, click on the editor, and a window will open displaying the instructions in the specified format.
-
End Task
The next process in the workflow is an end task. A BPMN diagram should contain an end event for every distinct end state of a process.
Now explore the properties panel when you click on the last end event process:
General
-
The Name for a Start Event is often left blank unless it needs to be named to provide more clarity on the flow or to be able to view this name in Process Instance logs.
-
ID is automatically populated by the system (default behavior) however the user can update it, but it must remain unique within the process.
Documentation
- This field is used to provide any notes related to the element.
Instructions
- These are the Instructions for the End User, which will be displayed when this task is executed.You can click on launch editor to see the markdown file.
