All pages
Powered by GitBook
2 of 13

Adding Actions to a Case

What are Actions?

Actions are the constituent parts of a Case, i.e. a Case is made up of a flow of Actions.

The Actions that you can add to a Case flow come from a standard menu of Actions, but can be added in any order.

You can add a variety of types of Actions - see below for more details.

Actions can be manual (i.e. can be carried out by humans and bots) or the can be automatic, e.g. auto sending an email.

You can choose to add a set of instructions to an Action, often a checklist of activities, to track progress within the Action.

All the manual Actions that are added to the process flow are shown under [Action Info] tab, and you can configure their standard attributes there. Additionally, specific types of Action (e.g. Email and Peer Review) Actions have further attributes which are displayed in subsequent tabs in the same location. These will only display once you add an Action of that type to your flow.

What types of Action can I add?

Depending on which Action types have been creating in your system, you can add the following types of Action:

  • ABBYY FlexiCapture Actions - these Actions provide integration with ABBYY FlexiCapture

  • Approval Actions - these Actions enable the creation of approval request flows.

  • Manual Actions - these Actions are carried out by humans or bots

  • Manual with Peer Review Actions - these Actions allow different members of a team to crosscheck each other's work. They involve two parts: the first part is the "doing" of the Action by one user, the second part involves reviewing to check if the Action was completed correctly - this review is done by a different user.

  • Send Email Actions - these Actions involve the user sending out an email

  • Send Email and Wait Actions - these Actions involve the user sending an email and waiting for a response.

  • Start Case Actions - these Actions

  • Trigger External API Actions - these Actions are used when you need to automatically call out to another system, passing data to it and potentially getting the external system to pass updated custom data back into Enate.

  • Wait for Sub Cases to Complete Actions - these Actions wait for a specific Sub-Case to reach completion before allowing the Case to move on to the next Action.

Action types can be configured in the Service Lines page, see this article for more details, or directly from within a Case screen itself.

How do I add Actions to a Case?

If you need to add additional Actions to your Case, you can do this by:

  1. Adding an Action from a step

  2. Adding an Action from an existing Action

  3. Adding an ad-hoc Action

Adding Actions from a step

Clicking on the menu icon on the right of a Step will give you the option to:

  • Add a Condition (click here for more details)

  • Add an Action in series

  • Add a parallel Action

You then need to choose which Action you want to add to the flow

Adding Actions from an existing Action

Clicking on the menu icon on the right of an Action will give you the option to:

  • Delete the Action

  • Cut / copy / paste the Action

  • Move the Action up or down within the Step flow

  • Add further Actions, either before, after or parallel to the selected Action

When adding an Action from another Action, you can choose to add an Action before, after or in parallel to the selected Action.

How do I edit a Case Flow

Once you have added an Action, clicking on the menu icon on the right of it in the flow will give you the option to:

  • Add further Actions, either before, after or parallel to the selected Action

  • Rearrange the order of Actions by moving the Action up or down within the same Step

  • Merge multiple Actions - adding a new merged Action or editing an existing merged Action

  • Cut / copy / paste the Action

  • Delete the Action

Copy/Paste Actions

You can also cut, copy and paste Actions within a Case Flow diagram.

Selecting the Action to be cut/copied and pasted in the Flow Diagram will highlight the Action in the Grid below as well.

Note: this feature is only available within a single Case diagram. Copying or pasting between difference processes or systems is not currently supported.

How do I configure an Action's settings?

Clicking on an Action in the Case flow will open the Action Info tab in the info grid and highlight that particular Action in the grid.

Here you can the configure the following settings for that Action:

Setting

Description

Notes

When is it due?

Select a value from the dropdown menu of Due Date ‘flavours’

Mandatory to set live.

(See Due Date Flavours Settings for more information).

Who does it go to?

Select a value from the dropdown menu of Allocation ‘flavours’

Mandatory to set live.

(See Allocation Flavours Settings for more information).

General Settings

Select a value from the dropdown menu of Follow Up ‘flavours’

Mandatory to set live.

(See General Settings Flavours Settings for more information).

Allow Manual Creation

Ticket to display the category as an option on Self Service submission forms. This allows you to show a subset of categories for end user submission.

Main Card

Custom Data for this Case can be displayed on the Case screen at runtime.

Select the Custom Card to be used for displaying this data in the main section of the Case screen.

Side Card

Custom Data for this Case can be displayed on the Case screen at runtime.

Select the Custom Card to be used for displaying this data in the right hand side panel section of the Case screen.

Manual Creation

Ticking this will make the Action an ad hoc Action that appears in the Case flow. See here for more information.

Checklist

See here for more information.

Different types of Action might require additional settings. These can be added in the additional tabs that will appear when these Actions are added to the flow. See here for more information.

Copy/Paste Data

In every tab in the Info Section apart from the Case tab, you can copy and paste data to make configuring attributes quicker and easier.

You can select data from multiple cells and paste that data into selected destination cells.

Please note that you cannot copy and paste data between columns.

If you want to copy more that one cell from multiple columns, you must make sure to copy the same number of cells from each column:

If the number of cells you select to paste data to is more than the number of cells you have copied, the data you have copied will repeat itself to fill the highlighted cells.

If the number of cells you select to paste data in is less than the number of cells you have copied, you will only paste data to fill the highlighted cells i.e. if you copy the data from 4 cells but select to paste that data into 3 cells, then only the data from the first 3 cells you copied will be pasted.

If you select to paste data into multiple places, the data that is pasted will begin from the start of the first cell you copied.

The data from the first cell you select will be pasted first:

Manual Actions

Overview

'Manual' Actions let users send out manual emails to service recipients.

To use 'Manual' Actions, you need to create a 'Manual' Action type and then add the Action into your Case flows.

Creating a Manual Action Type

You can either create a Manual Action type in the Service Line section of Builder, or directly from your Case flow.

From the Service Lines Page

Creating a Manual Action type from the Service Lines page adds the Action type to your menu of available Actions when you're building flows subsequently in Cases.

To do this, in the Service Line page, select which service line you would like to add the Manual Action to and then click on the plus symbol next to the 'Process Search' box. This will bring up a drop down menu where you can select an Action.

This will open up a new Action for you to create.

Add a name and description to your Action and then in the type drop down select 'Manual Action with Peer Review'.

Once you are happy with your Action, hit save to create it. This Action can now be added to new and existing business processes by selecting it from the dropdown list when adding a new Action to a Case.

From a Case Flow

Alternatively you can add a Manual Action type directly from the Case flow itself.

To do this, open a Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its type, select 'Manual'.

This will add the Manual Action to the Case flow.

Configuring Manual Actions

You now need to configure the settings for the new Action you have added to your Case. Click on the Action in the flow to highlight it in the info section.

In the Action Info tab, you need to add the usual following information for an Action:

Setting

Description

Notes

When is it due?

Select a value from the dropdown menu of Due Date ‘flavours’

Mandatory to set live.

(See Due Date Flavours Settings for more information).

Who does it go to?

Select a value from the dropdown menu of Allocation ‘flavours’

Mandatory to set live.

(See Allocation Flavours Settings for more information).

General Settings

Select a value from the dropdown menu of Follow Up ‘flavours’

Mandatory to set live.

(See General Settings Flavours Settings for more information).

Main Card

You can select a Custom Card to display on the main section of the Action screen.

Optional. See here for more information about Custom Cards.

Side Card

You can select a Custom Card to display on the side panel of the Action screen.

Optional. See here for more information about Custom Cards.

Manual Creation

Switching this setting on allows the Action to be started manually in Work Manager.

Optional. See Adding Ad-hoc Actions section for more information.

Checklist

Here you can add local checks to the Action that help support 'custom' activities that take place for that specific Action. You can also edit the global checks for the Action type from here too, if it has any.

Optional. See here for more information about adding checklists.

Additionally, once a Manual Action has been added to your Case flow, a new 'Email info' tab will display in the info grid.

Here you need to add the following settings that are only relevant for Manual, Send Email and Send Email and Wait Actions.

Setting

Description

Notes

From Email Address

Enter email address to be used as the from address.

Optional for Manual Actions. Multiple addresses can be set - at runtime users will be presented with a dropdown in the email section to choose a from address. f you set one of the addresses as the Default, this will be populated automatically but users will still be able to select alternatives. Only one email address can be set as the Default.

Email To

Enter the address to where the email will be sent from the Action.

Optional for Manual Actions. Multiple addresses can be set - at runtime users will be presented with a dropdown in the email section to choose a from address. If you set one of the addresses as the Default, this will be populated automatically but users will still be able to select alternatives. Only one email address can be set as the Default. If no email address is added, the ‘To’ value will be auto-populated as the Primary Contact’s email address.

Email CC

Enter email addresses where the email should be cc’d

Optional. If no email address is added and there is a CC address on the Action, the ‘CC’ value will be auto-populated as the CC contact’s email address.

Email BCC

Enter email addresses where the email should be bcc’d

Optional.

Email Template

Select the desired Email Template from the dropdown list

See Email Template section for more information on how to create Email Templates.

Peer Review Actions

Overview

Peer Review Actions are a great way for different members of a team to crosscheck each other's work for key actions within a case, letting you embed quality checks into your processes without having to add in feedback flows.

Enate supports this with a 'Manual with Peer Review' Action type that you can add to your Case flows. These are like 'Manual' Action types, except that once the initial manual activity is carried out by a user, Enate will route the Action to be picked up by a different user to check the work, passing or failing it. If failed, it will route back to the original user to resolve the issues.

Watch this video to find out more about how to set up a Peer Review Action:

Click here for more information and examples about when and why you would user Peer Review Actions.

For detailed information on how Peer Review Actions work at runtime, see the dedicated Work Manager section.

Creating a Peer Review Action Type

You can either create a Peer Review Action type in the Service Line section of Builder, or directly from your Case flow.

From the Service Lines Page

Creating a Peer Review Action type from the Service Lines page adds the Action type to your menu of available Actions when you're building flows subsequently in Cases.

To do this, in the Service Line page, select which service line you would like to add the peer review Action to and then click on the plus symbol next to the 'Process Search' box. This will bring up a drop down menu where you can select an Action.

This will open up a new Action for you to create.

Add a name and description to your Action and then in the type drop down select 'Manual Action with Peer Review'.

You can then choose to add a global checklist to the Action. This contains a standard checklist of activities that will be added any time this Action type is added to a Case flow. See here for more information on checklists.

You can also choose to add a Peer Reviewer global checklist to the Action. This contains a standard checklist of activities for the peer reviewer to complete that will be added any time this Action type is added to a Case flow. See here for more information on peer review checklists.

Once you are happy with your Action, hit save to create it. This Action can now be added to new and existing business processes by selecting it from the dropdown list when adding a new Action to a Case.

From a Case Flow

Alternatively you can add an Peer Review Action type directly from the Case flow itself.

To do this, open a Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its type, select 'Manual with Peer Review Action'.

This will add the Peer Review Action to the Case flow.

Configuring Peer Review Actions

You now need to configure the settings for the new Action you have added to your Case. Click on the Action in the flow to highlight it in the info section.

In the Action Info tab, you need to add the usual following information for an Action:

Setting

Description

Notes

When is it due?

This is for the initial 'completion' stage of the Action. Select a value from the dropdown menu of Due Date ‘flavours’

Mandatory to set live.

(See Due Date Flavours Settings for more information).

Who does it go to?

This is for the initial 'completion' stage of the Action. Select a value from the dropdown menu of Allocation ‘flavours’

Mandatory to set live.

(See Allocation Flavours Settings for more information). Note that the system will not allow the user who carried out the manual activity to also carry out the peer review.

General Settings

Select a value from the dropdown menu of Follow Up ‘flavours’

Mandatory to set live.

(See General Settings Flavours Settings for more information).

Main Card

You can select a Custom Card to display on the main section of the Action screen.

Optional. See here for more information about Custom Cards.

Side Card

You can select a Custom Card to display on the side panel of the Action screen.

Optional. See here for more information about Custom Cards.

Manual Creation

Switching this setting on allows the Action to be started manually in Work Manager.

Optional. See Adding Ad-hoc Actions section for more information.

Checklist

Here you can add local checks to the Action that help support 'custom' activities that take place for that specific Action. You can also edit the global checks for the Action type from here too, if it has any.

Optional. See here for more information about adding checklists.

Additionally, once a Peer Review Action has been added to your Case flow, a new 'Peer Review' tab will display in the info grid.

Here you need to add the following settings that are only relevant for the Action once it is in its 'Peer Review' stage.

Setting

Description

Notes

When is it due?

This is for the peer review stage of the Action. Select a value from the dropdown menu of Due Date ‘flavours’

Mandatory to set live.

(See Due Date Flavours Settings for more information).

Who does it go to?

This is for the peer review stage of the Action. Select a value from the dropdown menu of Allocation ‘flavours’

Mandatory to set live.

(See Allocation Flavours Settings for more information). Note that the system will not allow the user who carried out the manual activity to also carry out the peer review.

Peer Review Checklist

Here you can add local checks for the peer reviewer to complete and edit the global peer review checks for the Action type, if it has any.

Optional. See here for more information.

Peer Review Checklists

You can set up Peer Review Actions to display a dedicated checklist for the peer review section of the Action. These checks must be carried out and confirmed by the peer reviewer before the Action can be marked as resolved, allowing you to enforce procedure in how Peer Review Actions should be completed by agents at runtime.

In Work Manager, users will then have to confirm for each item in the checklist whether they have completed it (the options are Yes, No, N/A) and they can even add a note for each check.

You can create two different levels of peer review checklists:

  • 'Global' checklists - these are added to the Action type and contain a standard checklist of activities must be carried out and confirmed by the peer reviewer before the Action can be marked as resolved. Global checks will be added any time this Action type is added to a Case flow. Global peer review checks can be added/edited at Service Line level or from the Peer Review Checklist setting in the Case screen.

  • 'Local' checklists - these help support 'custom' activities that take place for that specific Action that must be carried out and confirmed by the peer reviewer before the Action can be marked as resolved. Local checks will only apply to the specific Action they have been added to. Local peer review checks are added to the Peer Review Action itself from the Peer Review Checklist setting in the Case screen.

Once important feature to note is that once you've created a local checklist item, you can drag it up to LINK it to a global check, specifying whether it should run before or after a standard global check. You'll see the colour-coding denoting which global check it's linked to. If ever the order of global checks is adjusted, all the linked 'local' checks will move with it. Once you're happy with your overall checklist you can OK this and the checklist for this Action is saved.

At runtime, users reviewing the Action in Work Manager will just see a single list of the checks they must complete, with no differentiation between global and local checks. They'll have to complete all of the checks in order to mark their Action as resolved.

Adding Conditions to Bypass a Peer Review

You can also choose to automatically bypass a peer review by adding a condition to a Peer Review Action in your Case configuration. If that condition is met, the peer review part of the Action will no longer be required. This gives you more flexibility when using Peer Review Actions and allows you to avoid any unnecessary peer reviews.

To set a condition for a peer review, in your Case flow screen select the relevant Peer Review Action and, on the Peer Review tab, click the 'Bypass if' icon.

In the resulting popup, set your condition - choosing a data field (which can be standard or one of your own custom data items), then a condition and a value.

Selecting the 'Advanced' option lets you create a more complex condition with a combination of multiple criteria, adding a plus symbol between each part. You can check the validity of your expression via the external DotNetfiddle link. Once you're happy with your settings here, apply the condition.

The 'Bypass if' icon will the be highlighted, showing that a condition has been added.

Save the update to your Case and set the new version live.

Over in Work Manager, if the condition you have added is met, at runtime the activity will move straight from the manual activity onto the next Action, bypassing the peer review stage. A note will subsequently be displayed in the Actions list on the Case screen, showing that the peer review activity was not required.

Send Email Actions

Overview

Enate allows the automatic sending of emails by the system.

A 'Send Email' Action type that you can add to your Case flows will automatically send out an email and then immediately close the Action and progress on the the next Action without waiting for a response.

If you want to automatically send out an email and wait for a reply to the email before closing and progressing to the next Action, you should instead select a 'Send Email and Wait' Action - see here for more information on that Action type:

Send Email and Wait Actions

For detailed information on how Send Email and Wait Actions work at runtime, see the dedicated Work Manager section:

'Send Email' and 'Send Email and Wait' Actions

Creating a Send Email Action Type

You can either create a Send Email Action type in the Service Line section of Builder, or directly from your Case flow.

From the Service Lines Page

Creating a Send Email Action type from the Service Lines page adds the Action type to your menu of available Actions when you're building flows subsequently in Cases.

To do this, in the Service Line page, select which service line you would like to add the Send Email Action to and then click on the plus symbol next to the 'Process Search' box. This will bring up a drop down menu where you can select an Action.

This will open up a new Action for you to create.

Add a name and description to your Action and then in the type drop down select 'Manual Action with Peer Review'.

Once you are happy with your Action, hit save to create it. This Action can now be added to new and existing business processes by selecting it from the dropdown list when adding a new Action to a Case.

From a Case Flow

Alternatively you can add an Send Email Action type directly from the Case flow itself.

To do this, open a Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its type, select 'Send Email Action'.

This will add the Send Email Action to the Case flow.

Configuring Send Email Actions

You now need to configure the settings for the new Action you have added to your Case. Click on the Action in the flow to highlight it in the info section.

In the Action Info tab, you need to add the usual following information for an Action:

Setting

Description

Notes

When is it due?

Select a value from the dropdown menu of Due Date ‘flavours’

Mandatory to set live.

(See Due Date Flavours Settings for more information).

Who does it go to?

Select a value from the dropdown menu of Allocation ‘flavours’

Mandatory to set live.

(See Allocation Flavours Settings for more information).

General Settings

Select a value from the dropdown menu of Follow Up ‘flavours’

Mandatory to set live.

(See General Settings Flavours Settings for more information).

Main Card

You can select a Custom Card to display on the main section of the Action screen.

Optional. See here for more information about Custom Cards.

Side Card

You can select a Custom Card to display on the side panel of the Action screen.

Optional. See here for more information about Custom Cards.

Manual Creation

Switching this setting on allows the Action to be started manually in Work Manager.

Optional. See Adding Ad-hoc Actions section for more information.

Checklist

Here you can add local checks to the Action that help support 'custom' activities that take place for that specific Action. You can also edit the global checks for the Action type from here too, if it has any.

Optional. See here for more information about adding checklists.

Additionally, once a Send Email Action has been added to your Case flow, a new 'Email info' tab will display in the info grid.

Here you need to add the following settings that are only relevant for Manual, Send Email and Send Email and Wait Actions.

Setting

Description

Notes

From Email Address

Enter email address to be used as the from address.

Mandatory for a Send Email Action. Only one email address can be used.

Email To

Enter the address to where the email will be sent from the Action.

Mandatory for a Send Email Action. Only one email address can be used.

Email CC

Enter email addresses where the email should be CC’d. If you do not enter a CC address on the Email Info tab, but have entered a CC address on the Case Info tab, at run time the Action will use the CC address from the Case Info tab.

Optional.

Email BCC

Enter email addresses where the email should be BCC’d. If you do not enter a BCC address on the Email Info tab, but have entered a BCC address on the Case Info tab, at run time the Action will use the BCC address from the Case Info tab.

Optional.

Email Template

Select the desired Email Template from the dropdown list

See Email Template section for more information on how to create Email Templates.

Send Email and Wait Actions

Overview

Enate allows the automatic sending of emails by the system.

A 'Send Email and Wait' Action type that you can add to your Case flows will automatically send out an email and wait for a reply to the email before closing and progressing to the next Action.

If you want to automatically send out an email and then immediately progress on the the next Action without waiting for a response, you should instead select a 'Send Email' Action - see here for more information on that Action type:

Send Email Actions

For detailed information on how Send Email and Wait Actions work at runtime, see the dedicated Work Manager section:

'Send Email' and 'Send Email and Wait' Actions

Creating a Send Email and Wait Action Type

You can either create a Send Email and Wait Action type in the Service Line section of Builder, or directly from your Case flow.

From the Service Lines Page

Creating a Send Email and Wait Action type from the Service Lines page adds the Action type to your menu of available Actions when you're building flows subsequently in Cases.

To do this, in the Service Line page, select which service line you would like to add the Send Email and Wait Action to and then click on the plus symbol next to the 'Process Search' box. This will bring up a drop down menu where you can select an Action.

This will open up a new Action for you to create.

Add a name and description to your Action and then in the type drop down select 'Send Email and Wait'.

Once you are happy with your Action, hit save to create it. This Action can now be added to new and existing business processes by selecting it from the dropdown list when adding a new Action to a Case.

From a Case Flow

Alternatively you can add an Send Email and Wait Action type directly from the Case flow itself.

To do this, open a Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its type, select 'Send Email and Wait Action'.

This will add the Send Email and Wait Action to the Case flow.

Configuring Send Email and Wait Actions

You now need to configure the settings for the new Action you have added to your Case. Click on the Action in the flow to highlight it in the info section.

In the Action Info tab, you need to add the usual following information for an Action:

Setting

Description

Notes

When is it due?

Select a value from the dropdown menu of Due Date ‘flavours’

Mandatory to set live.

(See Due Date Flavours Settings for more information).

Who does it go to?

Select a value from the dropdown menu of Allocation ‘flavours’

Mandatory to set live.

(See Allocation Flavours Settings for more information).

General Settings

Select a value from the dropdown menu of Follow Up ‘flavours’

Mandatory to set live.

(See General Settings Flavours Settings for more information).

Main Card

You can select a Custom Card to display on the main section of the Action screen.

Optional. See here for more information about Custom Cards.

Side Card

You can select a Custom Card to display on the side panel of the Action screen.

Optional. See here for more information about Custom Cards.

Manual Creation

Switching this setting on allows the Action to be started manually in Work Manager.

Optional. See Adding Ad-hoc Actions section for more information.

Checklist

Here you can add local checks to the Action that help support 'custom' activities that take place for that specific Action. You can also edit the global checks for the Action type from here too, if it has any.

Optional. See here for more information about adding checklists.

Additionally, once a Send Email and Wait Action has been added to your Case flow, a new 'Email info' tab will display in the info grid.

Here you need to add the following settings that are only relevant for Manual, Send Email and Send Email and Wait Actions.

Setting

Description

Notes

From Email Address

Enter email address to be used as the from address.

Mandatory for a Send Email and Wait Action. Only one email address can be used.

Email To

Enter the address to where the email will be sent from the Action.

Mandatory for a Send Email and Wait Action. Only one email address can be used.

Email CC

Enter email addresses where the email should be cc’d

Optional.

Email BCC

Enter email addresses where the email should be bcc’d

Optional.

Email Template

Select the desired Email Template from the dropdown list

See Email Template section for more information on how to create Email Templates.

Start Case Actions

Overview

It is possible to configure a Case to start automatically from within a Case flow.

Enate supports this with a 'Start Case' Action type that you can add to your Case flows. When the Case flow reaches a 'Start Case' Action, a new Case will be triggered.

Creating a Start New Case Action Type

You can either create a Start Case Action type in the Service Line section of Builder, or directly from your Case flow.

From the Service Lines Page

Creating a Start Case Action type from the Service Lines page adds the Action type to your menu of available Actions when you're building flows subsequently in Cases.

To do this, in the Service Line page, select which service line you would like to add the Start Case Action to and then click on the plus symbol next to the 'process Search' box. This will bring up a drop down menu where you can select an Action.

This will open up a new Action for you to create.

Add a name and description to your Action and then in the type drop down select 'Start Case Action'.

You can then choose to add a global checklist to the Action. This will add the same checks that are applied to any other action where the global checklist has been added.

Once you are happy with your Action, hit save to create it. This Action can now be added to new and existing business processes by selecting it from the dropdown list when adding a new Action to a Case.

From a Case Flow

Alternatively you can add a Start Case Action type directly from the Case flow itself.

To do this, open a Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its type, select 'Start Case'.

This will add the Start Case Action to the Case flow.

Configuring Start Case Actions

You now need to configure the settings for the new Action you have added to your Case. Click on the Action in the flow to highlight it in the info section.

In the Action Info tab, you need to add the usual following information for an Action:

Setting

Description

Notes

When is it due?

Select a value from the dropdown menu of Due Date ‘flavours’

Mandatory to set live.

(See Due Date Flavours Settings for more information).

Who does it go to?

Select a value from the dropdown menu of Allocation ‘flavours’

Mandatory to set live.

(See Allocation Flavours Settings for more information).

General Settings

Select a value from the dropdown menu of Follow Up ‘flavours’

Mandatory to set live.

(See General Settings Flavours Settings for more information).

Main Card

You can select a Custom Card to display on the main section of the Action screen.

Optional. See here for more information about Custom Cards.

Side Card

You can select a Custom Card to display on the side panel of the Action screen.

Optional. See here for more information about Custom Cards.

Manual Creation

Switching this setting on allows the Action to be started manually in Work Manager.

Optional. See Adding Ad-hoc Actions section for more information.

Checklist

Here you can add local checks to the Action that help support 'custom' activities that take place for that specific Action. You can also edit the global checks for the Action type from here too, if it has any.

Optional. See here for more information about adding checklists.

Additionally, once a Peer Review Action has been added to your Case flow, a new 'Start Case' tab will display in the info grid.

Here you need to add the following settings that are only relevant for 'Start Case' Actions.

Setting

Description

Notes

Start Case

Here you can select the Case you want this Action to start.

Sub-Case

You can choose to start this as a Sub Case (by enabling the Sub Case slider) or as an independently running Case by leaving this setting off.

See below for more information.

Copy Defects

You can copy existing defects from the original Case to the new Case that will be launched. Note that making updates to the defects in the new launched Case will NOT update the defects in the original Case.

Optional if the new Case is launched as an independent Case.

If the new Case is launched as a Sub-Case, defects will be automatically copied to the new Sub Case.

Copy Files

You can copy existing files (including tags and file notes) from the original Case to the new Case that will be launched. Note that making updates to the files in the new launched Case will NOT update the defects in the original Case.

Optional if the new Case is launched as an independent Case.

If the new Case is launched as a Sub-Case, files will be automatically copied to the new Sub Case.

Copy Links

You can copy existing links (including tags and link notes) from the original Case to the new Case that will be launched. Note that making updates to the links in the new launched Case will NOT update the defects in the original Case.

Optional if the new Case is launched as an independent Case.

If the new Case is launched as a Sub-Case, links will be automatically copied to the new Sub Case.

Copy Custom Data

You can copy existing custom data (e.g. custom data fields) from the original Case to the new Case that will be launched. Note that making updates to the custom data in the new launched Case will NOT update the defects in the original Case.

Optional if the new Case is launched as an independent Case.

If the new Case is launched as a Sub-Case, custom data will be automatically copied to the new Sub Case.

Copy Communications

You can copy work item communications i.e. emails (including email attachments) and notes from the original Case to the new Case that will be launched.

Note that when choosing to copy communications, you will not only copy communications from the original Case, but you will also copy communications from the original Case's related group, e.g. its Actions, or Sub-Cases if it has any. You can find out more about related groups vs linked work items here.

Also note that making updates to the communications in the new launched Case will NOT update the defects in the original Case.

Optional if the new Case is launched as an independent Case.

If the new Case is launched as a Sub-Case, defects will be automatically copied to the new Sub Case.

Note that emails will not be shared across but you can easily see them by selecting the 'Include related work items' option in the timeline of the main Case in Work Manager.

Sub Case vs Independent Case

Option 1: Starting a Sub Case

A Sub Case will behave according to its own specific configuration, but its 'parent' Case will not complete until all of its Sub Cases have first completed. Further, in the work item screen in Work Manager it will show in the 'Sub Cases' tab. For more information about when you would use Sub Cases, see here.

Data such as defects, files, links and custom data will be shared with the new Sub Case automatically. Emails will not be shared across but you can easily see them by selecting the 'Include related work items' option in the timeline of the main Case in Work Manager.

Option 2: Starting an Independent Case

If you do NOT tick the Sub Case option, the new Case launched will be completely independent from its 'parent' Case, which will not wait for it to complete. This is useful when the parent Case’s due date is not dependent on some sub-part being completed (e.g. by a different department).

If you choose to start the new Case as an independent Case, you can then choose whether to copy across the defects, files (including tags), links and custom data into the new Case.

You can also choose to copy work item communications i.e. emails (including email attachments) and notes. Note that when choosing to copy communications, you will not only copy communications from the original Case but you will also copy communications from the original Case's related group, e.g. its Actions, or Sub-Cases if it has any. You can find out more about related groups vs linked work items here.

Auto-Start By Schedule Cases

Note that if the Case which is set to be launched as part of the 'Start Case' Action is itself linked to a schedule, you will need to go to that Case's configuration screen in Builder and untick the 'Auto Start By Schedule' toggle in that Case's Info tab. If you do not, the Action will fail to launch a new Case (both launching options are not possible).

Approval Actions

Overview

'Approval' Actions enable an approval request flow to be added into the Case.

Often within the Case flows of business processes which are built in Enate there are points where external people (i.e. people working outside Enate - this could be business managers within your company or the relevant client company) need to sign off on activities before the process can continue. Payroll processes are good examples of such processes, where client management need to sign off on payroll reports before the process can be allowed to continue.

Enate's Approval Action is built to specifically support these scenarios in a more integrated way - to ensure that this 'approval cycle' is tightly managed and visible within the flow of activities in Enate. When an Enate Case reaches an Approval Action in a flow, things then work as follows:

  • Enate uses uploaded business rules to determine the Approvers to whom approval request emails should be sent (standard email templates are available, but these can be modified to contain information sufficient for approver to review what is being requested). See dedicated section describing how your approver business rules can be uploaded into Builder.

  • Once the approvers are determined, Enate sends out Approval Requests and then Waits for their response. Depending on the type of approval defined, this might send out one request after another (awaiting approval from the first) in a multilevel request, or might send the request to a group of people in one go, waiting for either one or all to approve before continuing. Note: While this is happening, the Approval Action in Work Manager sits in a state of 'Wait for more Information'

  • Those approvers can then approve or decline, via a link in the email sent to them which takes them to an online form.

  • Once all required Approvals have been received, the Case process can continue again*.

*Important note: If the approval action times out with no or insufficient responses, current system behaviour is that the Case flow will recommence as if full approval was received.

To use 'Approval' Actions, you need to create an 'Approval' Action type and then add the Action into your Case flows.

Creating an Approval Action Type

You can either create an Approval Action type in the Service Line section of Builder, or directly from your Case flow.

From the Service Lines Page

Creating an Approval Action type from the Service Lines page adds the Action type to your menu of available Actions when you're building flows subsequently in Cases.

To do this, in the Service Line page, select which service line you would like to add the Approval Action to and then click on the plus symbol next to the 'Process Search' box. This will bring up a drop down menu where you can select an Action.

This will open up a new Action for you to create.

Add a name and description to your Action and then in the type drop down select 'Approval Action'.

Once you are happy with your Action, hit save to create it. This Action can now be added to new and existing business processes by selecting it from the dropdown list when adding a new Action to a Case.

From a Case Flow

Alternatively you can add an Approval Action type directly from the Case flow itself.

To do this, open a Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its type, select 'Approval Action'.

This will add the Approval Action to the Case flow.

Configuring Approval Actions

You now need to configure the settings for the new Action you have added to your Case. Click on the Action in the flow to highlight it in the info section.

In the Action Info tab, you need to add the usual following information for an Action:

Setting

Description

Notes

When is it due?

Select a value from the dropdown menu of Due Date ‘flavours’

Mandatory to set live.

(See Due Date Flavours Settings for more information).

Who does it go to?

Select a value from the dropdown menu of Allocation ‘flavours’

Mandatory to set live.

(See Allocation Flavours Settings for more information).

General Settings

Select a value from the dropdown menu of Follow Up ‘flavours’

Mandatory to set live.

(See General Settings Flavours Settings for more information).

Main Card

You can select a Custom Card to display on the main section of the Action screen.

Optional. See here for more information about Custom Cards.

Side Card

You can select a Custom Card to display on the side panel of the Action screen.

Optional. See here for more information about Custom Cards.

Manual Creation

Switching this setting on allows the Action to be started manually in Work Manager.

Optional. See Adding Ad-hoc Actions section for more information.

Checklist

Here you can add local checks to the Action that help support 'custom' activities that take place for that specific Action. You can also edit the global checks for the Action type from here too, if it has any.

Optional. See here for more information about adding checklists.

Additionally, once an Approval Action has been added to your Case flow, a new 'Approval' tab will display in the info grid.

Here you need to add the following settings that are only relevant for Approval Actions.

Setting

Description

Notes

Approval Type

Select an approval type.

  • Multilevel - More than one level of approval is required. Request is sent to the first-level approver and, only if approved, onto the next level, and so on, up to a maximum of three levels. If you've selected Multilevel, you will also need to add how many levels of approval are needed in the 'Approval Levels' column (maximum 3).

  • Parallel Any - The approval request is sent to multiple people at the same time, and the decision is taken from the first one to respond. A maximum of 5 approvers can be specified at runtime.

  • Parallel All - The approval is sent to multiple people at the same time, and approval is needed from all of them. If any decline, the approval is declined. A maximum of 5 approvers can be specified at runtime.

Approval Levels

Enter the number of approval levels you would like the request to have, up to a maximum of 3.

Only relevant if you have selected 'Multilevel' as your approval type. If you have selected either of the two parallel approval types, the approval levels will automatically be set to 1.

Approval Request Email

Select which approval email template you would like to be sent out to the approvers

See this section to find out how to create and adjust approval email templates.

Trigger External API Actions

Overview

‘Trigger External API’ Actions allow Enate to call out to an external system, passing a static structure containing information information about a Work Item (i.e. a Case, Action or Ticket). This Action type also includes an optional callbackURL, which allows the external system to update custom data and pass it back into Enate.

For information on how 'Trigger External API' Actions are shown at runtime, check out this Work Manager section.

The external API will be called as a POST method, and will be sent the following information:

{"Action":[ActionPacketJSONIncludingCurlyBraces],"CallBackURL":""}

The [ActionPacketJSONIncludingCurlyBraces] will be an Actionpacket, as per the response from the Enate getAction API.

Enate supports this with a 'Trigger External API' Action type that you can add to your Case flows.

For detailed information on how Trigger External APIs work at runtime, see the dedicated Work Manager section.

Creating a Trigger External API Action Type

You can either create a Trigger External API Action type in the Service Line section of Builder, or directly from your Case flow.

From the Service Lines Page

Creating a Trigger External API Action type from the Service Lines section of Builder adds the Action to your menu of available Actions when you're building flows subsequently in Cases.

To do this, in the Service Lines page select which service line you would like to add the Trigger External API Action to and then click on the plus symbol next to the 'process Search' box and then select 'Action.

This will open up a new Action for you to create.

Add a name and description to your Action and then in the 'type' drop down select 'Trigger External API Action'.

You can then choose to add a global checklist to the Action. This contains a standard checklist of activities that will be added any time this Action type is added to a Case flow. See here for more information on checklists.

Once you are happy with your Action, hit save to create it. This Action can now be added to new and existing business processes by selecting it from the dropdown list when adding a new Action to a Case.

From a Case Flow

Alternatively, you can add a Trigger External API Action type directly from the Case flow itself.

To do this, open your desired Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its 'type', select 'Trigger External API Action'. This will add the Action to the Case flow.

Configuring a Trigger External API Action

You now need to configure the settings for the new Action you have added to your Case. Click on the Action in the flow to highlight it in the info section.

In the Action Info tab, you need to add the usual following information for an Action:

Setting

Description

Notes

When is it due?

Select a value from the dropdown menu of Due Date ‘flavours’

Mandatory to set live.

(See Due Date Flavours Settings for more information).

Who does it go to?

Select a value from the dropdown menu of Allocation ‘flavours’

Mandatory to set live.

(See Allocation Flavours Settings for more information).

General Settings

Select a value from the dropdown menu of Follow Up ‘flavours’

Mandatory to set live.

(See General Settings Flavours Settings for more information).

Main Card

You can select a Custom Card to display on the main section of the Action screen.

Optional. See here for more information about Custom Cards.

Side Card

You can select a Custom Card to display on the side panel of the Action screen.

Optional. See here for more information about Custom Cards.

Manual Creation

Switching this setting on allows the Action to be started manually in Work Manager.

Optional. See Adding Ad-hoc Actions section for more information.

Checklist

Here you can add local checks to the Action that help support 'custom' activities that take place for that specific Action. You can also edit the global checks for the Action type from here too, if it has any.

Optional. See here for more information about adding checklists.

Additionally, once a Trigger External Action has been added to your Case flow, a new 'External API' tab will display in the info grid.

Setting
Description
Notes

API Integration URL

Enter the API Integration URL in this column.

Response Expected

Switching this setting on means that the Action will only be marked as complete when the external system to calls back to Enate with the supplied call-back URL.

Leaving the setting off means that the Action will call the external system and close the Action, in a "fire and forget" manner.

Please note that 1 minute is the minimum value that you can enter in the 'Response Expected Within' column.

Response Expected Within (Mins)

Set how many minutes you would like Enate to to wait for a response before the Action would 'time out' and flip over to a human to progress.

If you set the 'Response Expected' slider to On but no value is entered in the 'Response Expected Within' column, the Action will call the external system and wait either until the Due Date for the Action, or indefinitely. This will depend on the General Settings flavour for the Action, see below for more details.

If 'Response Expected Within' is left blank - further details

If you set the 'Response Expected' slider to On but no value is entered in the 'Response Expected Within' column, the Action will call the external system and wait either until the Due Date for the Action, or indefinitely.

The decision on whether the Action will wait indefinitely or not is determined based on the 'Autocomplete on Timeout' setting in the General Settings flavour set for the Action.

  • If Auto-complete in General settings is set to On, the system will time the Action out when it hits the Due Date / Time.

  • If Auto-complete in General settings is set to Off, the Action will wait indefinitely.

If / When the Action DOES time out at the point of reaching the Due Date, the Action will moved to a state of 'Closed' with a reason of 'No response returned'.

Note: If you have both these settings filled (i.e. a 'Response expected minutes' value AND the 'Auto-complete on Timeout' flag set), the system will act on whichever time comes first - most likely after the 'Response expected minutes' time has been reached.

Please note that the Case owner will not be notified in this scenario.

Behaviour in various scenarios

There are a number of possible ways the system will behave, dependant upon how you have configured the various timeout settings AND how the external API actually responds. For detailed information on this, see the following attachment which lays out each combination of settings and behaviour, and the eventual result.

14KB
Trigger External API Action - Behaviour.xlsx

IDP Data Extraction Actions

Overview

The Document Extraction component automatically extracts the relevant data from files attached to incoming emails so that this data can be used in further processing of the work item, saving your agents time and effort. This also means that documents such as PDFs can be scanned and used both to start Cases in Enate and to form part of the ongoing process's activities.

When a Document Extraction Action runs for a Case, documents attached to the Case can be submitted to your desired technology for scanning and the processed output files will be returned and automatically attached to the Case.

If at any point the technology you're using is not confident enough of the results, based on a confidence threshold that you can set, Enate will instantly transfer the work to an agent in Work Manager to look over and verify, giving you that 'human in the loop' support.

Enate supports this with an 'IDP Data Extraction' Action type that you can add to your Case flows. You'll need to before you can use IDP Data Extraction Actions in your flows.

For detailed information on how IDP Data Extraction Actions work at runtime, see the dedicated Work Manager section.

Creating an IDP Data Extraction Action Type

To create an IDP Data Extraction Action, you first need to have activated the Data Extraction component in Enate Marketplace. See this article for more information.

You'll then need to set up your Case flow to support the Document Extraction component. This involves adding an 'IDP Data Extraction' Action in Enate Builder to use in your desired Case flows.

You can either add an existing one from the Actions list if one has already been created, or you can create a brand new one.

IDP Data Extraction Actions can be created in the same way any other Action is created in Enate: either from the Service Line page, or directly from within your Case flow.

To create an IDP Data Extraction Action from the Service Line page, select to create a new Action under the desired service line, give the action a name and a description and choose approval action from the type drop down.

You can also give the Action a global checklist if you wish. This contains a standard checklist of activities that will be added any time this Action type is added to a Case flow. See here for more information on checklists.

To create an IDP Document Extraction Action directly from the Case flow itself, open a Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its type, select 'Approval'. When you click 'OK, the Action will be created and added to the Case flow.

Once you have added your approval action to your flow, you will then need to fill out its settings.

On the Action Info tab you will need to set when it's due and set an Allocation rule.

Note that this Allocation should be who the Action should go to to review if the extraction technology is not confident enough in its data extraction results. If the technology you're using is confident enough about its data extraction results, this Action won't even need to be seen by a human user, it will simply be completed automatically and the Case will move on to the next Action.

There's also general settings for the Action too, and ability to set a custom card, again only really for use in the unlikely event that someone needs to intervene and view the action in Work Manager.

Next, go to the IDP Document Extraction tab to define the settings which specifically relate to the approval activities.

You'll need to fill in the Extraction Model - this is the ID of the model you want to use for that process.

You'll also need to fill in the input and output tags. The input tag is the tag that the file/document must be tagged with in Work Manager in order to be eligible for document extraction processing and output tags. The output tag is the tag that will be assigned to the file/document in Work Manager once the document extraction process has completed.

Once you have filled in the above settings details, set the Case live.

Configuring an IDP Data Extraction Action

You now need to configure the settings for the new Action you have added to your Case. Click on the Action in the flow to highlight it in the info section.

In the Action Info tab, you need to add the following information:

Setting

Description

Notes

When is it due?

Select a due date from the dropdown menu of Due Date ‘flavours’

Mandatory to set live.

(See Due Date Flavours Settings for more information).

Who does it go to?

Select a value from the dropdown menu of Allocation ‘flavours’

Mandatory to set live.

(See Allocation Flavours Settings for more information).

General Settings

Select a value from the dropdown menu of Follow Up ‘flavours’

Mandatory to set live.

(See General Settings Flavours Settings for more information).

Main Card

You can select a Custom Card to display on the main section of the Action screen.

Optional. See here for more information about Custom Cards.

Side Card

You can select a Custom Card to display on the side panel of the Action screen.

Optional. See here for more information about Custom Cards.

Manual Creation

Switching this setting on allows the Action to be started manually in Work Manager.

Optional. See Adding Ad-hoc Actions section for more information.

Checklist

Here you can add local checks to the Action that help support 'custom' activities that take place for that specific Action. You can also edit the global checks for the Action type from here too, if it has any.

Optional. See here for more information about adding checklists.

Additionally, once an IDP Document Extraction Action has been added to your Case flow, a new 'IDP Data Extraction' tab will display in the info grid.

Here you need to add the following settings that are only relevant for IDP Document Extraction Actions:

Setting

Description

Notes

Extraction Model

The ID of the Infrrd model you want to use for that process

Mandatory

Input File Tag

Only documents with this File Tag will be passed to Infrrd for processing with this Action.

Mandatory

Output File Tag

When Infrrd has finished processing documents as part of this Action, it will pass them back to Enate marking them with this File Tag.

Mandatory. All files processed by this Action will be tagged with the Output File Tag value when they are transferred back through to Enate.

Your IDP Document Extraction Action is now ready to be used in your Case flows.

ABBYY OCR FlexiCapture Actions

Overview

Enate is able to provide integration with ABBYY FlexiCapture to allow intelligent document processing to be part of your Enate processes. This means that documents such as PDFs can be scanned by ABBYY FlexiCapture both to start and to form part of your Enate processes.

When an ABBYY Action runs for a Case, documents attached to the Case can be submitted to ABBYY FlexiCapture for OCR Scanning and the processed output files will be returned and automatically attached to the Case.

Furthermore, if ABBYY FlexiCapture highlights that additional manual verification may be needed (i.e. if confidence levels in the scanned output is below threshold), the work is transferred over to an Enate agent in Work Manager to verify and adjust the data via ABBYY FlexiCapture's dedicated screen, surfaced directly within an Enate Action.

Enate supports this with an 'ABBYY OCR' Action type that you can add to your Case flows.

For detailed information on how ABBYY Actions work at runtime, see the dedicated Work Manager section.

Creating an ABBYY Action Type

To create an ABBYY FlexiCapture Action, you first need to set up an ABBYY FlexiCapture connection.

See this article for more information about how to set up an ABBYY FlexiCapture connection:

Setting up Enate & ABBYY Integration

Once you have successfully set up an ABBYY connection, you then need to create an ABBYY FlexiCapture Action type.

You can either do this in the Service Line section of Builder, or directly from your Case flow.

From the Service Lines Page

Creating an ABBYY FlexiCapture Action type from the Service Lines section of Builder adds the Action to your menu of available Actions when you're building flows subsequently in Cases.

To do this, in the Service Lines page select, which service line you would like to add the ABBYY Action to and then click on the plus symbol next to the 'Process Search' box. This will bring up a drop down menu where you can select an Action.

This will open up a new Action for you to create.

Add a name and description to your Action and then in the 'type' drop down select 'ABBYY OCR'.

You can then choose to add a global checklist to your ABBYY FlexiCapture Action. This contains a standard checklist of activities that will be added any time this Action type is added to a Case flow. See here for more information on checklists.

Once you are happy with your Action, hit save to create it. This Action can now be added to new and existing business processes by selecting it from the dropdown list when adding a new Action to a Case.

From a Case Flow

Alternatively, you can add an ABBYY FlexiCapture Action type directly from the Case flow itself.

To do this, open your desired Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its 'type', select 'ABBYY OCR'. This will add the ABBYY FlexiCapture Action to the Case flow.

Configuring an ABBYY Action

You now need to configure the settings for the new Action you have added to your Case. Click on the Action in the flow to highlight it in the info section.

In the Action Info tab, you need to add the following information:

Setting

Description

Notes

When is it due?

Select a due date from the dropdown menu of Due Date ‘flavours’

Mandatory to set live.

(See Due Date Flavours Settings for more information).

Who does it go to?

Select a value from the dropdown menu of Allocation ‘flavours’

Mandatory to set live.

(See Allocation Flavours Settings for more information).

General Settings

Select a value from the dropdown menu of Follow Up ‘flavours’

Mandatory to set live.

(See General Settings Flavours Settings for more information).

Main Card

You can select a Custom Card to display on the main section of the Action screen.

Optional. See here for more information about Custom Cards.

Side Card

You can select a Custom Card to display on the side panel of the Action screen.

Optional. See here for more information about Custom Cards.

Manual Creation

Switching this setting on allows the Action to be started manually in Work Manager.

Optional. See Adding Ad-hoc Actions section for more information.

Checklist

Here you can add local checks to the Action that help support 'custom' activities that take place for that specific Action. You can also edit the global checks for the Action type from here too, if it has any.

Optional. See here for more information about adding checklists.

Additionally, once an ABBYY Action has been added to your Case flow, a new 'ABBYY FlexiCapture' tab will display in the info grid.

Here you need to add the following settings that are only relevant for ABBYY Actions:

Setting

Description

Notes

Platform

The ABBYY Platform being used for this Action

Mandatory

Project

The ABBYY project this is part of.

Mandatory

Input File Tag

Only documents with this File Tag will be passed to ABBYY for processing with this Action.

Optional. If an Input File Tag has been specified then only files on this Action marked with this tag will be included in the ABBYY batch. If no Input File Tag is selected then all files attached to the Case will be included for scanning and processing by ABBYY FlexiCapture.

Output File Tag

When ABBYY is finished processing documents as part of this Action, it will pass them back to Enate marking them with this File Tag.

Optional. If an Output File Tag has been specified then all files processed by this Action will be tagged with the Output File Tag value when they are transferred back through to Enate.

Note : As an additional validation check, when configuring Case flows that includes ABBYY Actions, if any of the referenced platform are now deleted, the system will prompt you to replace this with an active ABBYY Platform.

Your ABBYY FlexiCapture Action is now ready to be used in your Case flows.

Wait for Sub-Cases to Complete Actions

Overview

A ‘Wait for Sub-Cases to Complete’ Action (also known as a Hold Case Action) will wait for a specific Sub-Case to reach completion before allowing the Case to move on to the next Action.

For detailed information on how ABBYY Actions work at runtime, see the dedicated Work Manager section:

'Wait for Sub Cases to Complete' Actions

Creating a Wait for Sub-Cases to Complete Action Type

You can either create a Wait for Sub-Cases to Complete Action type in the Service Line section of Builder, or directly from your Case flow.

From the Service Lines Page

Creating a Wait for Sub-Cases to Complete Action type from the Service Lines page adds the Action type to your menu of available Actions when you're building flows subsequently in Cases.

To do this, in the Service Line page, select which service line you would like to add the Wait for Sub-Cases to Complete Action to and then click on the plus symbol next to the 'process Search' box and then select 'Action'.

This will open up a new Action for you to create.

Add a name and description to your Action and then in the ‘type’ drop down select 'Wait for Sub-Cases to Complete'.

You can then choose to add a global checklist to the Action. This contains a standard checklist of activities that will be added any time this Action type is added to a Case flow. See here for more information on checklists.

Once you are happy with your Action, hit save to create it. This Action can now be added to new and existing business processes by selecting it from the dropdown list when adding a new Action to a Case.

From a Case Flow

Alternatively, you can add a Wait for Sub-Cases to Complete Action type directly from the Case flow itself.

To do this, open a Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its ‘type’, select 'Wait for Sub-Cases to Complete'. This will add the Wait for Sub-Cases to Complete Action to the Case flow.

Configuring Wait for Sub-Cases to Complete Actions

You now need to configure the settings for the new Action you have added to your Case. Click on the Action in the flow to highlight it in the info section.

In the Action Info tab, you need to add the usual following information for an Action:

Setting

Description

Notes

When is it due?

Select a value from the dropdown menu of Due Date ‘flavours’

Mandatory to set live.

(See Due Date Flavours Settings for more information).

Who does it go to?

Select a value from the dropdown menu of Allocation ‘flavours’

Mandatory to set live.

(See Allocation Flavours Settings for more information).

General Settings

Select a value from the dropdown menu of Follow Up ‘flavours’

Mandatory to set live.

(See General Settings Flavours Settings for more information).

Main Card

You can select a Custom Card to display on the main section of the Action screen.

Optional. See here for more information about Custom Cards.

Side Card

You can select a Custom Card to display on the side panel of the Action screen.

Optional. See here for more information about Custom Cards.

Manual Creation

Switching this setting on allows the Action to be started manually in Work Manager.

Optional. See Adding Ad-hoc Actions section for more information.

Checklist

Here you can add local checks to the Action that help support 'custom' activities that take place for that specific Action. You can also edit the global checks for the Action type from here too, if it has any.

Optional. See here for more information about adding checklists.

Additionally, once a 'Wait for Sub-Cases to Complete' Action has been added to your Case flow, a new 'Hold Case' tab will display in the info grid.

Setting
Description
Notes

Hold Case

If you want the Action to wait for a specific Sub-Case to finish before moving on to the next Action, add that Sub-Case here.

If you want the Action to wait for any of the Case's Sub-Cases to close before moving on to the next Action, leave the Hold Case field blank.

Auto-Close

This setting lets you automatically close the Action if no available Sub-Case is running for it.

See below for more details.

Auto-Close Option - Further Details

If the 'Auto-Close' setting is off, the ‘Wait for Sub-Cases to Complete’ Action will be assigned to a Queue where a user will pick it up and decide how to proceed if the Sub-Case the 'Wait for Sub-Cases to Complete’ Action it is set to wait for is not available - either because it has not been launched or because it was resolved before the ‘Wait for Sub-Cases to Complete’ Action was launched.

If you switch the 'Auto-Close' toggle on, instead of assigning the Action to a user to proceed, the ‘Wait for Sub-Cases to Complete’ Action will automatically close if the Sub-Case the 'Wait for Sub-Cases to Complete’ Action it is set to wait for is not running.

If the Hold Case column is left blank, the ‘Wait for Sub-Cases to Complete’ Action will wait for any Sub-Case of the Case to close before continuing and if there is no Sub Case available, the ‘Wait for Sub-Cases to Complete’ Action will automatically close.

Adding Ad-hoc Actions

There are two ways to add ad-hoc Actions, depending upon whether the Action in question also appears as part of the standard Case flow:

Ad-hoc Actions which DO appear as part of the standard Case flow

Simply tick the checkbox in the ‘Manual Creation’ column in the Action Info Grid.

Manually starting this type of ad-hoc action will then automatically launch Actions further downstream in the flow.

Ad-hoc Actions which DO NOT appear in the Case flow diagram

Select the '+' icon in the top-right of the Action Info grid and select the type of ad-hoc Action from the Actions menu popup.

Once the Action is added, it shows up in the Action info tab.

Here it will be labelled as an ad-hoc Action. This ad hoc Action is not part of the workflow, but can be launched manually by a Case Owner, if required.

All the configuration settings for this type of ad hoc Actions are same as for every other Action, with the following exceptions:

  • The Manual Creation checkbox is auto-ticked and can’t be disabled.

  • To delete this Action, you have to do it directly in the grid

Adding Action Checklists

Set activities to be carried out for an Action by creating a checklist to display on it

Overview

You can set up Actions to display dedicated checklists of activities which must be carried out and confirmed before the Action can be marked as resolved, allowing you to enforce procedure in how Actions should be completed by Agents at runtime.

In Work Manager, users will then have to confirm for each item in the checklist whether they have completed it (the options are Yes, No, N/A) and they can even add a note for each check.

You can create two different levels of Action checklists:

  • 'Global' checklists - these are added to the Action type and contain a standard checklist of activities that will be added any time this Action type is added to a Case flow. See below for more details on how to configure global checklists.

  • Local Checks - these are added to Actions already in a Case flow to help support 'custom' activities that take place for that specific Action. See below for more details on how to configure global checklists.

At runtime, users processing the Action in Work Manager will just see a single list of the checks they must complete, with no differentiation between global and local checks. They'll have to complete all of the checks in order to mark their Action as resolved.

See here for more detailed information and examples about when you would use checklists on Actions.

Defining Checklists

Defining Global Checklists

Global checklists contain a standard checklist of activities that are added to an Action type and will be added any time this Action type is added to a Case flow.

You can add a global checklist either from Global Checklist section on the Service Lines screen or from within a Case screen (from the Action's checklist popup).

To add a global checklist from the Services Line screen, go to the Service Lines screen and open the Action type you want to add the global checklist to. Add the desired checks, re-order them if necessary and click to save. These checks will be added any time the Action type is used in a Case flow.

You can also add global checks from within an Action in the Case screen itself. Simply click on the checklist icon link of an Action in a Case flow, select 'Global Checklists' from the resulting pop-up and then add the desired global checks. You can re-order them as necessary. Then click to save.

Be aware that any changes you make at a global level for checklists will also update ALL other locations where this Action is being used, and the change will take effect instantly.

Defining Local Checklists

Local checklists are added to Actions already in a Case flow to help support 'custom' activities that take place for that specific Action.

You can add a local checklist from the Action's checklist popup on the Case screen.

To do this, click on the checklist icon link of an Action in a Case flow. You'll know if there's already a checklist set to the Action as the checklist icon will be highlighted.

Clicking the icon will bring up a popup where you can create your checks. Simply click to add, then enter your description.

Once created, individual checks can be re-ordered by clicking on the drag icon then dragging and dropping. Then click to save.

Any checks created here are specific to this Action.

Once important feature to note is that once you've created a local checklist item, you can drag it up to LINK it to a global check, specifying whether it should run before or after a standard global check. You'll see the colour-coding denoting which global check it's linked to. If ever the order of global checks is adjusted, all the linked 'local' checks will move with it. Once you're happy with your overall checklist you can OK this and the checklist for this Action is saved.