Workflow Configuration

These configurations allows you to override the default graph layout, state and transition appearance set in Global Configuration for a given workflow. To set workflow configuration, simply add your configuration in workflow description using Simplified JSON Syntax.

Warning

After you have made changes to workflow, you’ll need to update metadata cache (see Update Workflows).

Layout options

Option

Values

Description

direction

TB or LR

Define current workflow graph direction: Top to Bottom or Left To Right

align

  • NONE

  • UR

  • DR

  • DL

  • UL

Define current workflow graph alignment, where: U is for Up, D is for Down, R is for Right and L is for Left

tree

  • long or l

  • tight or t

Define current workflow graph tree layout type

acyclicer

true or false

Whether to enable cyclic layout for current workflow or not, works only for cyclic graphs

States options

Option

Values

Description

shape

<shapeName>

The default shape for current workflow’s states, for full list of possible options, see JSON State Shape values

default

hex color

The default color for current workflow’s states

previous

hex color

The default color for the object’s prevous state

current

hex color

The default color for the object’s current state

next

hex color

The default color for the object’s next possible states which are not selectable

selectable

hex color

The default color for the object’s selectable possible states, this apply only when Allow State Transitions is enabled

noState

hex color or #h

The default color for the no state state. To hide this state from the workflow set the value to #h

autoColor

true or false

When set to false, only the default and current colors will apply and the legend will be hidden. The default value is true

fill

true or false

Whether to use colors to fill or for stroke color

light

true or false

When fill option is set to false, whether to use light color to fill the shape or for text

style

  • b

  • i

  • bi

The font style for current workflow’s states text, use :- b for bold - i for italic - bi for bold italic

size

number

The size in pixels for current workflow’s states text

stroke

number

The width in pixels for shapes stroke, 0 for no stroke

auto

true or false

Whether to use automatic shapes for this workflow or not, this will overrides the shape option. see Automatic Sate Shapes Behavior

Transitions options

Option

Values

Description

linkType

  • basis or b

  • step or s

  • linear or l

Define the interpolation type used for current workflow’s transitions. Default value is basis

linkStyle

  • solid

  • dotted or dot

  • dashed or dash

Define the stroke style used for current workflow’s transitions. Default is dashed for automatic transitions and solid otherwise.

linkHead

  • arrow or a

  • vee or v

  • triangle or t

  • sTriangle or st (solid)

  • square or s

  • sSquare or ss (solid)

  • circle or c

  • sCircle or sc (solid)

  • none or n

Define current workflow transition arrows. Default is arrow

Example

This configuration set in workflow description will set all its state shapes to rectangle and change colors of current and selectable states:

{shape:rect, current:#ff8c00, selectable:#f00}

../_images/wf-config.jpg

And this is the resulting graph for this workflow only:

../_images/wf-config-result.jpg