Event-Based Gateway - PRD

Product ProcessMaker Core

Target Version Number 1.0.0

Ticket

Document Status PUBLISHED

Product Manager Ashley Stephens

Reviewers

Goals
Dependency
Requirements
User Personas
User Stories
User Flows
Add Element
Process Inspector
Sequence Flow Connection Validation
Add Information on Request Timeline
Additional Information
Engine Execution
Request Cancellation
Example
Not Doing

Goals
Support BPMN 2.0 event-based gateways on the product.

Dependency
Intermediate Message Catch Event - PRD PLANNED

Intermediate Timer Event

Requirements

# Title Type Priority Details

1 Capability to add event-based gateways to control the Functional Must Have Drag and Drop the element over the canvas
flow on the process based on events Requirement

2 Capability to detect valid sequence flow to connect with Functional Must Have Modeler needs to be smart enough to detect
Requirement invalid connections

3 Capability to see request status information when a Functional Must Have User needs to know the status of the request
event-based gateway is executed Requirement when a event-based gateways in part of the
process.

User Personas

Persona Description
 Process Designer Process designers are able to add, delete and configure event-based gateways.

End User End users are able to see request detail and see information about the current request's status.

User Stories

# Title Story Priority User Flows

1 Event-Based As a process designer I want to Must Have Add Element

Gateway use an event-based gateways Process Inspector
on my processes, so I can
process logic will be driven by Sequence Flow Connection Validation
external events.

2 Request Detail As an end user I want to see Must Have Add Information on Request Timeline
information about the status of
the request when an
event-based gateway is
executed, so I can known
exactly what is going on with
my request.

User Flows

Add Element

Edition CORE
 Flow User logs in to application
Navigate to Processes
Create or Edit a process definition
Enter to the Modeler
Select Event-Based gateway element from the side toolbar

Result Event-Based Gateway must be added to the canvas, depending of the current draw element can be placed on:
Canvas when there's not any pool
Inside a Pool or lane

Exceptions N/A

Logs N/A

UI/UX Details 1. Element can be moved and placed around.

2. Every time an event-based gateway is selected the process inspector area needs to be reloaded.
3. Event-based Gateways supports label display and needs to be placed centered at the bottom of the element.

Other Details Please see attached mockups to identify element icon.

Process Inspector

Edition CORE

Flow User logs to application

Navigate to Processes
Create or Edit a process definition
Enter to the Modeler
User selects an event-based gateway element
 Result Process Inspector must be loaded an show the following items:
Identifier
Name

Exceptions N/A

Logs N/A

UI/UX Details Name must be empty by default and is not required

Other Details N/A

Sequence Flow Connection Validation

Edition CORE

Flow User created a process with event-based gateway

User inserted several intermediate receive message and intermediate timer events

Result User must be able to connect after an event-based gateway the following elements:
One only intermediate timer event
One or more intermediate receive message events
Any other elements won't be able to create a successful connection (sequence flow)

Exceptions N/A

Logs N/A

UI/UX To help user experience every time the user is trying to connect to any invalid element the mouse and the target element
Details should display a visual icon and the red highlight, see mockup image.
 Other N/A
Details

Add Information on Request Timeline

Edition CORE

Flow User logs in to the application

Navigate to Requests
Open a request with an event-based gateway

Result For every element after the event-based gateway must be an entry for the elements on the request timeline

Exceptions N/A

Logs N/A

UI/UX Details N/A

Other Details All entries must be executed by the system

Additional Information

Engine Execution

After the event-based execution all events attached after the gateway must be executed.
Engine is waiting until one of the event triggers first. That path will continue with the execution
Engine needs to cancel the execution and listening of the other events.

Request Cancellation

If request is cancelled all catch events waiting need to be cancelled as well.

Example

Event-Based gateways are used on processes where decisions on the flow are based on external events.

Scenario 1: Order Processing with User Cancellation/Change Order period of 30 mins

Not Doing
Not supporting catch elements after event-based gateway except: Receive Message Event and Time Events