Labelling Workflow Blocks

In order to understand what a Workflow does, the blocks must be properly labelled. It should be possible to understand what a block does simply by its name, without needing to inspect it further. When a User Property is referenced in a Workflow block, it is recommended to refer to the User Property in the block’s label. For example, if there is an intercom association with an asset inside User Property 4, the Logic block should be labelled: has an intercom? (uprop4).

To demonstrate the importance of labelling Workflows, here is an example of an unlabeled Workflow. As it is right now, it is not possible to understand what the Workflow is doing simply by looking at it.

Example

Before:

Now, if the same Workflow is labeled so that the blocks are labeled according to their function, it is possible to understand exactly what the Workflow is doing.

After:

Action block: label them according to their action.
  • Write Status to Message Banner
  • Set Object Position to x = 10, y = 300
Logic blocks: label them according to their true condition.
  • Has Intercom?
  • Is Door Open?
  • Is Trigger in Alarm?
Switch block: label as the data you are checking.
  • Current Status
Case block: label as the options the Switch block is checking.
  • Off
  • On
  • Masked
  • Acknowledged
Set Variable block: label as the variable name needed for the Workflow.
  • Camera Callup 1
  • Asset Visible Status
Timer block: label as the time the Workflow will pause for.
  • 60 seconds
  • 5 seconds
  • 2 minutes
Note: To make Workflows even more readable, it is good practice to use Workflow Variables where possible as well.