An introduction to the Workflow behaviour
This is article describes the Workflow behaviour in our ideal completed state. The availability of features will vary between the different bots. To see what functionality is available in your app, see your Reference documentation in the library.
What is Workflow?
Workflows comprise various tasks or processes which are completed sequentially. Workflows can be used in various contexts - from onboarding, to training, to filling out multi-step forms, such as application forms for properties.
Our Workflow behaviour takes place across multiple screens (a builder) to allow users to easily find the content they want to change. This same method of building out a component can also be found on the Forms page.
Use cases could include managing booking or application status, issues, or a sales pipeline.
To understand how Workflow works, see the interactive prototype.
Default Workflows includes:
Run-time configurable transitions between states on an entity
Assign a workflow to one or more entities.
Using Codebots protected regions, Workflows can be customised to include:
Actions occurring on a state change (e.g., sending a email).
Workflows is not suitable for:
Allowing the end user to configure complex actions on a state change.
This is a screen which shows the existing workflows, their names, what entities they are connected to and the version which is active. It also shows if there is a draft version of the workflow. Additionally, a user is able to delete, edit or duplicate an existing workflow. Finally, users can create new workflows or access the help documentation for this behaviour.
Initial building for workflows. The tabbed navigation bar at the top of the create workflow page allows users to jump between different build modes for their workflow. During initial creation of a workflow, users can access the Details, States and Preview.
Users can cancel creation, save a draft and publish their workflow.
Allows users to set the workflow name, the workflow description and connect entities to said workflow using a multi-select dropdown with search functionality.
The most complex of the sections in the Create Workflow builder. In this stage, users create new steps as part of their workflow. They input a state name and can select which step would be the start of the workflow. They can see incoming and outgoing transitions for each step. They can also delete steps. When creating the outgoing transitions for each step, users can click the Edit button which is beside the Outgoing transitions number.
Clicking the edit button opens a side bar where transitions associated with a step can be further edited. Users can set the transition name, the destination (via a dropdown) and indicate return flow. Return flow essentially means that a transition can go both ways.
For example, we could move something from ‘Awaiting Approval’ to ‘Approved’ and vice versa. Users can add additional outgoing transitions for each step. They must save their transitions in order to add them to the step using the Save button at the bottom of the side bar.
The sidebar slides out from the left of the screen and contains various controls to assist users in building their workflow. It has been structured in a modular way to allow for elements to be repeated in other component builders. Users can add new transitions and save their progress. They can also set whether something will have return flow or not.
The preview workflow tab illustrates the completed workflow using a diagram. This is the final step for the initial Workflow creation process.
Last updated: 13 January 2020