Workflows¶

At the top of every profile page is a series of steps which get ticked off as you complete the profile. These steps are what's called a 'Workflow'.

The workflow a profile uses is determined by the criteria the applicant was invited against.

VettingGateway provides a default workflow for referencing applicants out of the box, so that getting started is easy, however you may create custom workflows to suit your organisation.

A workflow is made up of steps, with a minimum requirement of at least two steps existing. Each step has a 'Completion Event' assigned, which means that once a particular event happens the step is considered complete.

When you perform tasks against a profile, VettingGateway will check if the current step is complete and (if applicable) transition the profiles' workflow to the next step, according to its completion event.

The total number of stages and their description are visible to applicants from within their dashboard.

View Workflows¶

Within the workflow settings page you'll find a list of workflows available to your organisation, each showing its name, stage count and actions.

Add or Edit a workflow¶

Add a new workflow by clicking the 'Create a workflow' button, or to edit an existing workflow click the 'edit' button beside it.

You'll be shown a form with the following fields:

• Name - Provide a recognisable name for this workflow.

• Stages - Define the stages of this workflow, each separated by a box with a grey dotted outline.

You can drag and drop the order of stages by holding down your mouse and dragging the stage up or down.

Insert a new stage by clicking the 'Add a stage' button at the bottom of the page. Remove a stage by clicking the 'Remove' button, however stages marked 'Mandatory' can't be deleted.

Each stage asks the following:

• Name - Give this stage a recognisable name, wich will be shown internally.

• Mark Stage As Complete When - Decide when this stage should be marked as completed. If you require it to be manually marked completed, then pick 'Manually Transitioned'.

• Applicant Description - Enter a description which will be shown to the applicant for this stage on their dashboard.

Update or create the workflow by clicking the 'Save Changes' button, or click the 'delete button' beside the workflow to remove it.

Restore Workflows¶

If you accidentally removed a workflow, you may restore it for up to 7 days. Click the 'Show Recently Deleted' button and you be taken to the recent deletions page.

To restore a workflow click the 'Restore' button beside it.