Specification file

A specification file is an Excel document that outlines the client’s requirements for the workflow. It serves as a guide for developers, detailing what the workflow should accomplish. The file is composed of the following sheets:

Workflow

The workflow sheet defines the workflow’s name, as well as the organization’s name.
A screenshot of the BPMN diagram of the workflow is also provided.

Groups

The groups sheet defines the groups that will be available in the workflow.

Sheet example
Documentation

Group id	Group name	Is it a system?
client	Client	no
cook	Cook	no

This sheet is not exhaustive and might be empty if groups are provided by an external source (Studio data repository or Excel).

Actions

The actions sheet defines the actions that will be available in the workflow.

Sheet example
Documentation

Action name	Action id	Action type	Generic action	Is a starting point?
Place order	placeOrder	form	no	yes
Receive order	receiveOrder	form	no	no
Comment	comment	form	yes	no

Forms

The forms sheet defines the forms that will be available in the workflow.

Sheet example
Documentation

Group	Action	Field	Type	Mandatory	Conditional	Source	Order	Pre-fill
Client	Eat	Rating	short text	yes	no	N/A	1	no
Client	Eat	Comment	long text	yes	no	N/A	2	no
Client	Place order	Select a meal	dropdown	yes	no	Pizza, Pasta	1	no
Client	Place order	Type	dropdown	yes	yes	…	2	no
Client	Place order	Comment	text	no	no	N/A	3	no
Cook	Receive order	Review	checkboxes	yes	no	N/A	1	no
Cook	Receive order	Comment	text	no	no	N/A	2	no

Group

required

The name of the lane that will do the action.

Action

required

The name of the action that will be done.

Field

required

The name of the form field.

Type

required

The type of the field, for example short text, long text, dropdown, checkboxes, comment.

Mandatory

boolean

required

Whether the field is required when the form is submitted.

Conditional

boolean

required

Whether the field is conditional to the value of another field.

Source

required

The list of possible values of the form field, mostly used for checkboxes and dropdowns.

Order

required

The order of the field in the form.

Pre-fill

boolean

required

Whether the form field is pre-filled with a value from the state.

Trace state

The trace state sheet outlines the structure of the data stored in the state and serves as a guide for defining the type of the workflow’s state data in the state.type.ts file.

Sheet example
Documentation

Field	Is a custom variable?	Type	Objectives
clientName	yes	string	Recorded during the first action
status.value	yes	string
status.progress	yes	number
selectedMeal	no	string
mealType	no	string
comments	yes	list
isAccepted	yes	boolean
isClosed	yes	boolean
rating	no	number

Field

required

The name of the field, or path where the value will be stored in the state data.Example with clientName, status.progress and status.value:

type StateData = {
  clientName: string;
  status: {
    progress: number;
    value: string;
  }
}

Is a custom variable?

boolean

required

Whether the field’s value is provided by the users through the submission of actions, or if it’s calculated by the effects.

Type

required

The type of the field, for example string, number, boolean, list, object.

Specifications are not created by developers, the types might not be accurate.

Objectives

boolean

required

Additional information about the field.

The state sheet is not exhaustive, additional fields can be added if necessary.

Trace state update

The trace state update sheet outlines the minimal state data modifications required during the execution of an action’s effects.

Sheet example
Documentation

Action name	Condition	Updated value	Update effect	Trace state variable
Receive order	accepted is false	0,2	replace	status.progress
Receive order	accepted is false	Order declined	replace	status.value
Receive order	accepted is true	0,6	replace	status.progress
Receive order	accepted is true	Ready to eat	replace	status.value
Receive order		[accepted]	replace	isAccepted
Place order		0,2	replace	status.progress
Place order		Waiting for acceptation	replace	status.value
Place order		[meal]	replace	selectedMeal
Place order		[type]	replace	mealType
Place order		false	replace	isClosed
Place order		(get from meta)	replace	clientName
Eat order		[rating]	replace	rating
Eat order		1	replace	status.progress
Eat order		Done	replace	status.value
Eat order		true	replace	isClosed

Trace notes

The trace notes sheet defines the structure of the trace infos pannel.

Sheet example
Documentation

Category	Field Name	Data type	Trace state field	Order
General Information	Status	Status Widget	status	1
General Information	Client name	string	clientName	2
General Information	Rating	number	rating	3
Order informations	Selected meal	string	selectedMeal	1
Order informations	Selected type	string	mealType	2
Comments	Comments	Comment widget	comments	1

Category

required

The category corresponds to the window widget in the trace infos view.

Field Name

boolean

required

Whether the field’s value is provided by the users through the submission of actions, or if it’s calculated by the effects.

Data type

required

The type of widget that should be used to display the field.
It might note match exactly a widget’s type, for example a string type will be displayed with a text widget.

Each field’s widget should be wrapped with a key-value widget.

Trace state field

required

The name or path of the field in the state data used to retrieve the value displayed by the widget.

Order

required

The order of the field relative to it’s window/category.

Overview

The overview sheet outlines the structure of the workflow’s overview table.

Sheet example
Documentation

Order	Column table	Trace state field	Formatting system
1	Name	trace name	link wrapper
2	Status	status	status
3	Client name	clientName
4	Selected Meal	selectedMeal
5	Selected type	mealType

Order

number

required

The order of the column in the overview table.

Column table

string

required

The name of the column.

Trace state field

string

required

The name or path of the field in the state data used to retrieve the value displayed by the widget.

Formatting system

string

required

The type of widget that should be used to display the field.
It might note match exactly a widget’s type, for example a string type will be displayed with a text widget.

Notifications

The notifications sheet defines the notifications that will be available in the workflow.

Workflow specifications are not set in stone. You are free to make adjustments to suit the workflow’s needs, provided its behavior remains aligned with the specifications.

Workflow configuration