Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Live Search
spaceKeyHG
additionalpage excerpt
placeholderSearch for a solution
typepage
 

For a video tutorial on Workflows, click this link.

How To Guides

How to create a Workflow Template

Expand
  1. Select Workflow Templates from the Administration area. You will be taken to the Workflow Templates DataGrid. To learn more about DataGrids, click here.

  2. Click the Add button at the top left hand corner of the DataGrid. This will open the Workflow Maintenance Details page.

    Image Modified

  3. Enter the title for the Workflow, and select the Module and Trigger event. Add a Description if you wish. At this point, we recommend leaving the Workflow as inactive until you have entered some rules into the Workflow.

  4. Click Save to save your Workflow.

How to turn on a Workflow

Expand
  1. Select Workflow Templates from the Administration area.

  2. Right-click the Workflow you wish to activate and select Set as Active from the context menu.

    Image Modified

How to edit an existing Workflow

Expand
  1. Select Workflow Templates from the Administration area.

  2. Right click the Workflow and select Edit from the context menu.

    Image Modified

How to add Settings to a Workflow

Important:

  • Refresh Values
    Each time an object is updated, any Workflow Instances that haven’t yet been sent/triggered will be updated to use the new information.
    For example:

    • If a ‘Course Reminder’ email is due to send to all Delegates 7 days before their Course, and the start time of the Course is updated by an admin 9 days before the Course from 10am to 9am. The reminder email will still send 7 days before the Course, and it will be updated to contain the new start time of 9am.

    • If a ‘Venue Has Changed’ email sends when the Venue is updated, and the Venue is updated multiple times, this Workflow will only trigger once.

Image Added
  • Duplicate
    Each time the object is updated, a new instance will be created for this Workflow to send.
    If you don't include a 'Has Changed' rule when using the Duplicate option, an email could send every time anything related to that object

ID
  • is changed in the platform.
    For example:

    • If a ‘Course Reminder’ email is due to send to all Delegates 7 days before their Course, and the start time of the Course is updated by an admin 9 days before the Course from 10am to 9am. The reminder email will send 7 days before the Course, although it will send twice - the original version will send with the original course start time of 10am, and a second version will send which contains the new start time of 9am.

    • If a ‘Venue Has Changed’ email sends when the Venue is updated, and the Venue is updated multiple times, this Workflow will trigger an email for each Venue change.

Image Added
  • Ignore
    Each time an object is updated, nothing will be updated/changed for their pending Workflow Instances.
    For example:

    • If a ‘Course Reminder’ email is due to send to all Delegates 7 days before their Course, and the start time of the Course is updated by an admin 9 days before the Course from 10am to 9am. The reminder email will still send 7 days before the Course, and it will be contain the original start time of 10am.

Expand
  1. Navigate to the Settings tab within the Workflow.

  2. Ensure that the Matching Rules tick-box is ticked.

Image Removed
  1. Image Added
  2. To add a rule to the Workflow, click the Add Filter(s) button.

  3. Use the drop downs to select the rules you wish to apply to the Workflow. To add additional rules, click the + button. To remove rules, click the - button.

    Image Modified

  4. Click Save to save your Workflow Settings.

*

On Update Setting Guidance

:

This setting determines what Workflows do with unexecuted actions when settings are changed.

When set to ‘Refresh Values’ a workflow will only trigger once per object (e.g. each course, each delegate, etc.).

Image Removed

The 'Duplicate' option allows multiple emails to be sent whenever the trigger object is changed, e.g. the Venue field against a Course Date.

Image Removed

Info

How to add Advanced Rules to a Workflow

Expand
  1. Navigate to the Settings tab within the Workflow.

  2. Ensure that the Advanced Rules tick-box is ticked.

    Image Modified
  3. Your rules will now appear in a line. To add an AND rule, use && between your rules. To add an OR rule, use || between the appropriate rules. Ensure that you use brackets if your Workflow has more than two rules.

    Image Modified

  4. Click Save to save your Workflow Settings.

How to create a Workflow Action

Expand
  1. Navigate to the Actions tab within the Workflow.

  2. Click the Add button at the top of the page. 

  3. Select the appropriate Workflow Action from the drop-down, and add an Action Label if you wish.

    Image Modified
  4. Click Save to save your Workflow Action. You will now be able to configure the settings of your Workflow Action.

How to Preview an Email Action

Expand
  1. Navigate to the Actions tab within the Workflow.

  2. Right click the Email Action you wish to preview and select Edit from the context menu.

    Image Modified

  3. Click the Preview button at the top of the page. This will open the Preview Email dialog box.

    Image Modified

  4. Click Select and find the object you wish to preview from the Preview Object dialog box. Select it, and click OK.

    Image Modified
  5. Enter your Email into Send Sample to field. Click Enter to save the email in this field.

    Image Modified

  6. Click Send Email to send the email to your email address.

How to manually execute a Workflow

Expand
  1. Navigate to the Instances tab within the Workflow.

  2. Right click the Instance you wish to execute and select Actions from the context menu. This will open the Workflow Instance Actions dialog box.

    Image Modified

  3. Right click the Action you wish to execute, and select Execute. Please note, this will send out the Action even if it has already been delivered.

    However, if the Instance has failed due it not meeting the current rules of the Workflow, the execute function will not work.

    Image Modified

How to backfill a Workflow

Expand
  1. Select Workflow Templates from the Administration area.

  2. Right click the Workflow you wish to backfill, and select Settings from the context menu.

    Image Modified
  3. Temporarily remove any Has Changed rules from the Workflow - the backfill won't work if these are in place. It is also recommended to add a Course Start Date >Period > Future (if applicable) to any Delegate-based Workflow to prevent the backfill from triggering for historic bookings. Click Save to save your changes.

    Image Modified

  4. Navigate back to the Workflow Templates DataGrid. Right click the Workflow and select Backfill Instances from the context menu. Once the backfill is complete, go back to the Workflow's settings and re-add any Has Changed rules back into the Workflow.


Additional Support

If you would like additional support on any of the above information please raise a ticket with our Support team.

Info

Please note: The customer support team and ticket portal is available to all platform Training Administrators. If you are an individual user, manager or trainer please contact your Training Administrator for access to this support.