Difference between revisions of "Creating a workflow with scheduled reminders"

From SmartWiki
Jump to: navigation, search
(→‎No summary)
(→‎No summary)
 
(63 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
=Overview=
 
=Overview=
−
Use case: Notifications that a task is due to be completed is a common requirement in grants administration. These reminders are particularly important when it comes to the completion of progress reports once a grant has been awarded. Automating these reminders reduces the administrative burden on internal staff members. This can also be helpful in the case of multi-year grants or grants with multiple reporting requirements, which can be time consuming to follow up on manually
+
Issuing notifications about upcoming task deadlines is a common requirement in grants administration. These reminders are particularly important when it comes to the completion of progress reports once a grant has been awarded. Automating these reminders reduces the administrative burden on internal staff members. This can also be helpful in the case of multi-year grants or grants with multiple reporting requirements, which can be time consuming to follow up on manually
  
−
Example: An application gets approved by a grants administrator. A report schedule is created with due dates set at 3 month intervals between the start and the end date of the grant. Automated notifications can be scheduled to remind the individual responsible to complete the task in a timely manner.
+
For example, an application gets approved by a grants administrator. A report schedule is created with due dates set at 3 month intervals between the start and the end date of the grant. Automated notifications can be scheduled to remind the individual responsible to complete the task in a timely manner.
  
−
A Workflow is a set of repeatable steps used to automate and streamline your business processes within the system.
+
This article will show you how to set up scheduled notification reminders from [[Workflows - Overview|workflows]].
  
−
=Configuration - Essentials=
+
=Configuration - Workflows=
−
* Click the Menu Icon and under the System Processes , click the '''Workflows''' link. You can also access this by going into the Global settings -> System
+
==Creating a New Workflow==
 +
The following steps outline how to set up a new workflow:
  
−
INSERT IMAGE 
+
# Click the '''Menu Icon''' and select '''Workflows''' link under System Process. You can also access this by going into the''' Global Settings''' > '''System''' tab > '''Workflows'''. <br /> [[File:Workflow Settings.png|thumb|none|800px|The <strong>Workflows</strong> link located under the <strong>Menu Icon</strong>]]
 +
# On the '''Workflows''' page, click on the plus button to create a new workflow. <br /> [[File:Workflows_Main_Page.png|thumb|none|800px|The plus button allows you to create a new <strong>Workflow</strong>]]
 +
# Select the '''Workflow Type'''. The type will dictate what options will be available when creating '''Tasks''' and where the actions will occur. For this workflow, we’re going to be selecting '''Tracking Activities'''. We are selecting '''Tracking Activities''' for this workflow because we are looking at Level 2 records which in this case are the reports. <br />[[File:Create a Report Reminder Workflow - Main setup page.png|thumb|none|800px|Main setup for creating a report reminder]]
 +
# Give the workflow a '''Name''', add the workflow to a '''Category''', and add a brief '''Description''' to summarize the tasks within it, including any branching conditions for ease of review later. It is also recommended to keep track of any changes made to the task by adding some notes. Categories are created by your organization. We suggest creating categories based on the UTA and record level. The following naming convention is recommended to avoid confusion: Activity Level (1/2/3) - Goal/Status/Reminders.
 +
# Set the '''Trigger on''' to determine what automated tasks are going to be triggered in this workflow. This will define when your workflow is triggered. Depending on the '''Workflow Type''', you will be selecting from a list of statuses. In our example, the activities will have been created in the 'Scheduled' status. This is what we will set the trigger to as a result.
 +
# A '''Termination Trigger''' should be set for any workflow that is scheduling tasks for the future. This will cancel any pending tasks if it is no longer required. In this example, if the applicant submits their reports ahead of the due date, the report status will change to 'Submitted', which can be set as a termination trigger on the workflow and prevent unnecessary reminders.
 +
# Click the '''Save''' button. The workflow is saved and the '''Workflow ID''' is now populated
  
−
* The Workflows page is displayed. Click on the plus button to create a new workflow.
+
Now you will see additional options relating to this workflow. You can add notes, view the list of tasks, workflow connections, pending queue for upcoming workflow tasks, and a history of when this workflow was triggered.
  
−
INSERT IMAGE 
 
  
−
* Select the '''Workflow type'''. The type will dictate what options will be available when creating '''tasks''' and where the actions will occur. For this workflow, we’re going to be selecting Tracking Activities. We are selecting Tracking Activities for this workflow because we are looking at level 2 records which in this case are the reports.
 
  
−
INSERT IMAGE 
+
'''Note''': The field names, activity types, and status names referenced in this example are specific to the SmartSimple Grants Demo System. If you are trying to replicate this workflow in your own system, check that you are using the correct field names, activity types and statuses specific to your system. You can build your workflow on your production system first and test it on your backup the next day. Make sure to set the '''Trigger On''' to '''Deactivate''' so the workflow won’t run. Once your workflow appears in your backup, you can set the '''Trigger On''' to the correct status and test your workflow without worrying about impacting your production environment.&nbsp;
  
−
* Give the workflow a '''Name''', add the workflow to a '''Category''' and add a brief '''Description''' to summarize the tasks within it, including any branching conditions for ease of review later. It is also recommended to keep track of any changes made to the task by adding some notes. 
+
=Configuration - Tasks=
−
** Categories are created by your organization. We suggest creating categories based on the UTA and Record Level. 
+
We recommend that you create all of your '''workflow tasks''' before connecting the tasks.&nbsp;
−
*** EX: Reports - Reminders
 
−
** Suggested naming convention: Activity Level (1/2/3) - Goal/Status/Reminders<br />
 
−
*** EX: Grants Manager L1/L2
 
  
−
* Set the '''Trigger on''' to determine what automated tasks are going to be triggered in this workflow. 
+
The following steps outline how to set up the tasks:
−
** This will define when your workflow is triggered.
 
−
** Depending on the workflow type, you will be selecting from a list of statuses. 
 
−
** In our example, the activities will have been created in ‘Scheduled’ status. This is what we will set the trigger to as a result.
 
  
−
* A '''termination trigger''' should be set for any workflow that’s scheduling tasks for the future. This will cancel any pending tasks if it is no longer required. In this example, if the applicant submits their reports ahead of the due date, the report status will change to Submitted, which can be set as a termination trigger on the workflow and prevent unnecessary reminders.
+
# Click on the '''Tasks''' on the left-hand menu. A '''workflow''' will always have a starting point and a completion point where it can terminate. In between, you can have as many different tasks in the workflow.'''&nbsp;'''
  
−
* Click the Save button. The workflow is saved and the Workflow ID is now populated
+
: [[File:Creating a New task.png|thumb|none|800px|Creating a New task]]
 +
: 2.  To create a new task, click on the plus button. Again, you would have to give the task a '''Name''', select a '''Task type''', and add a brief '''Description''' of the task. The''' task types''' mainly used in this workflow are either an '''Acknowledgement''' or a '''change in status'''. The options available will vary from task type to task type.&nbsp;
 +
==Task 1: '''Initial Delay'''==
 +
The first '''task''' is named''' Initial Delay''' since it has no function but will indicate that a '''workflow''' has started when looking through '''workflow histories''' and logs. It is a branching '''task''' without any additional function.
  
−
Now you’ll see some additional options relating to this workflow. You can add notes, view the list of tasks, workflow connections, pending queue for upcoming workflow tasks, and a history of when this workflow was triggered.
+
[[File:Initial Delay task.png|thumb|none|800px|Initial Delay task]]
  
 +
==Task 2: '''6 Week Reminder to Staff'''==
 +
 The next '''task''' will be used to send out the first email reminder to the '''Grant Staff''' about the upcoming report that is to be filled out
  
 +
[[File:6 week reminder to Grant Staff task.png|thumb|none|800px|6 week reminder to Grant Staff task]]
  
−
'''Note''': The field names, activity types, and status names referenced in this example are specific to the SmartSimple Grants Demo System. If you are trying to replicate this workflow in your own system, check that you are using the correct field names, activity types and statuses specific to your system.
+
Setting up the 6 Week Reminder to Staff task
  
−
'''*Tip*''' → You can build your workflow on your production system first and test it on your backup the next day. Make sure to set the Trigger-on to Deactivate so the workflow won’t run. Once your workflow appears in your backup, you can set the Trigger-On to the correct status and test your workflow without worrying about impacting your production environment. 
+
# We have given this a '''Task Name  '''6 Week Reminder to Staff&nbsp;
 +
# The '''Task Type''' selected here is an Acknowledgement, which will send a message to the user.
 +
# The''' Description''' is optional, but we suggest adding a brief description of what this task is performing
 +
# The''' Role''' indicates which user should receive this reminder email. In this case, it is the '''Grant Staff''' user that has been assigned to record.
 +
# You can Create a '''Default Task Connector''' to the previous task, but it is recommended to create all the tasks first and then create the connectors afterwards. In this case, the connector will need to be modified after it has been created to account for the scheduling.
 +
# Create the '''Message template''' which would include the '''Message Type''', '''Email Template''', '''From Address''', any other '''Cc Address(es)''', '''Message Format''', '''Message Subject''', and the '''Body''' of the message. You can use variables to populate content relevant to the triggering record, such as a name or grant id.
  
 +
 [[File:Message template for tasks.png|thumb|none|800px|Message template for tasks]]
  
 +
==Task 3: '''4 Week Reminder to Grantee'''==
 +
This next task will be used to send out the first email reminder to '''Grantee''' about the same upcoming report that is to be filled out.
  
−
=Configuration - Creating Tasks=
+
[[File:4 week reminder to Grantee task.png|thumb|none|800px|4 week reminder to Grantee task]]
−
'''*Best Practice*''' →  Create all of your workflow tasks before connecting the tasks. 
 
  
 +
Setting up the 4 Week Reminder to Grantee task
  
−
Navigate to the Tasks bar on the left-hand menu. A workflow will always have a starting point and a completion point where it can terminate. In between, you can have as many different tasks in  the workflow.''' '''
+
# We have given this a '''Task Name  '''4 Week Reminder to Grantee&nbsp;
 +
# The '''Task Type''' selected here is an Acknowledgement, which will send a message to the user.
 +
# The''' Description''' is optional, but we suggest adding a brief description of what this task is performing
 +
# The''' Role''' indicates which user should receive this reminder email. In this case, it is the '''Grantee/Owner '''of the record.
 +
# Create the '''Message template'''.
  
−
INSERT IMAGE 
+
==Task 4:''' 1 Week Reminder'''==
 +
 This next task will be used to send out a second email reminder to the Grantee about the same upcoming report that is to be filled out.
  
−
To create a new task, click on the plus button. Again, you would have to give the task a '''Name''', select a '''Task type''', and add a brief '''Description''' of the task. The''' task types''' mainly used in this workflow are either an '''Acknowledgement''' or a '''change in status'''. The options available will vary from task type to task type. 
+
[[File:1 week reminder to Grantee task.png|thumb|none|800px|1 week reminder to Grantee task]]
  
−
INSERT IMAGE 
+
Setting up the 1 Week Reminder to Grantee task
  
−
'''Creating the tasks'''
+
# We have given this a '''Task Name '''1 Week Reminder to Grantee&nbsp;
 +
# The '''Task Type''' selected here is an Acknowledgement, which will send a message to the user.
 +
# The''' Description''' is optional, but we suggest adding a brief description of what this task is performing
 +
# The''' Role''' indicates which user should receive this reminder email. In this case, it is the '''Grantee/Owner '''of the record.
 +
# Create the '''Message template'''.
  
−
* '''Task 1:'''<br />
+
==Task 5: '''On Due Date Reminder to Grantee'''==
−
** The first task is named Initial Delay since it has no function but will indicate that a workflow has started when looking through workflow historys and logs. It is a branching task without any additional function.
+
&nbsp;This next task will be used to send out a third email reminder to the Grantee about the same upcoming report that is to be filled out.
  
−
* '''Task 2: 6 Week Reminder to Staff'''
+
[[File:On due date reminder to Grantee task.png|thumb|none|800px|On due date reminder to Grantee task]]
  
−
      The next task will be used to send out the first email reminder to the '''Grant Staff''' about the upcoming report that is to be filled out
+
Setting up the On Due Date Reminder to Grantee task
  
−
: INSERT IMAGE 
+
# We have given this a '''Task Name '''On Due Date Reminder to Grantee
 +
# The '''Task Type''' selected here is an Acknowledgement, which will send a message to the user.
 +
# The''' Description''' is optional, but we suggest adding a brief description of what this task is performing
 +
# The''' Role''' indicates which user should receive this reminder email. In this case, it is the '''Grantee/Owner '''of the record.
 +
# Create the '''Message template'''.
  
 +
==Task 6: '''On Due Date Reminder to Grant Staff'''==
 +
&nbsp; &nbsp; &nbsp; This next task will be used to send out a third email reminder to the Grant Staff about the same upcoming report that is to be filled out.
  
−
: '''Task Name → '''6 Week Reminder to Staff 
+
[[File:On due date reminder to Grant Staff task.png|thumb|none|800px|On due date reminder to Grant Staff task]]
−
: '''Task Type''' → Acknowledgement
 
  
−
'''Description''' → Add a brief description of what this task is performing
+
Setting up the On Due Date Reminder to Grant Staff task
  
−
'''Role''' → Add the role that should receive this reminder email. In this case, it is the '''Grant Staff''' user that has been assigned to record.
+
# We have given this a '''Task Name '''On Due Date Reminder to Grantee
 +
# The '''Task Type''' selected here is an Acknowledgement, which will send a message to the user.
 +
# The''' Description''' is optional, but we suggest adding a brief description of what this task is performing
 +
# The''' Role''' indicates which user should receive this reminder email. In this case, it is the '''Grant Staff '''on the record.
 +
# Create the '''Message template'''.
  
−
: You can Create a '''Default Task Connector''' to the previous task, but it is recommended to create all the tasks first and then create the connectors afterwards. In this case, the connector will need to be modified after it has been created to account for the scheduling.
+
==Task 7: '''Status to Overdue'''==
 +
&nbsp; &nbsp; &nbsp; This task is created to change the status of the report to overdue. Note that if additional tasks need to be triggered by the overdue status, an additional workflow will need to be created and triggered.
  
−
INSERT IMAGE 
+
[[File:Status to Overdue task.png|thumb|none|800px|Status to Overdue task]]
  
−
: Create the '''Message template''' which would include the '''Message Type''', '''Email Template''', '''From Address''', any other '''Cc Address(es)''', '''Message Format''', '''Message Subject''', and the '''Body''' of the message. You can use variables to populate content relevant to the triggering record, such as a name or grant id.
+
Setting up the Status to Overdue task
−
:  
 
  
 +
# We have given this a '''Task Name '''Status to Overdue
 +
# The '''Task Type''' selected here is an Change Status, which changes the status of the record.
 +
# The''' Target '''in this case would be the current object, which is the report.
 +
# The''' Entity '''is Level One
 +
# This task will '''Change Status To '''Overdue
  
−
=Appendix=
+
=Configuration - Task Connectors=
−
==Options and Settings==
+
==Creating Task Connectors==
−
<!--Explain all applicable misc options and settings that shouldn't be explained above here...-->
+
Now that you have created all of your workflow tasks, you will need to connect them. This can be done by creating Connectors. Workflows only run tasks if they have been connected together and have applicable conditions.
−
===General Settings===
 
−
{| class="wikitable"
 
−
|-
 
−
!|Option
 
−
!|Description
 
−
!|Example
 
−
|-
 
−
||
 
−
||
 
−
||
 
−
|}
 
  
  
−
===Display Settings===
 
−
{| class="wikitable"
 
−
|-
 
−
!|Option
 
−
!|Description
 
−
!|Example
 
−
|-
 
−
||
 
−
||
 
−
||
 
−
|}
 
  
−
=Examples=
+
* Create a Starting connector to start your workflow.&nbsp;
−
<!--
+
** Click the New button on the first row of your workflow tasks.&nbsp;
  
−
{| class="wikitable"
+
[[File:Create a new task connector.png|thumb|none|800px|Create a new task connector]]
−
!| Option
 
−
!| Description
 
−
!| Example
 
−
|-
 
−
|
 
−
|
 
−
|
 
−
|}
 
  
 +
** The connector connects the starting point to the Initial Delay
 +
** Leave the '''Name''' and''' Trigger Type''' as the default for your starting connector, or name it appropriately if required.
 +
** For the '''Connect To''' option - select the task you want the workflow to start with - in this case it will be the Initial Delay task.
  
 +
[[File:Start connector configuration.png|thumb|none|800px|Start connector configuration]]
  
−
Sample Syntax Format:
+
After creating the first connector, it should look like this;
−
Empty space at start of line to highlight the row, italicize any variables that the user would fill in (as opposed to literal words that need to be used in syntax)
 
  
−
@section.''SectionNodeName''@
+
[[File:Start task connecting to Initial delay.png|thumb|none|800px|Start task connecting to Initial delay]]
  
 +
You will need to create connectors for the remaining tasks. Make sure that you connect the current task in the workflow. The default option in the connector is Complete - which will end your workflow.
  
 +
* The next connector connects the initial delay to 6 Week Reminder to Staff.
 +
** We have given it a Name, left the trigger as default and selected the task that it is connecting to.
 +
** The trigger date is set to the date that the report is due in the Application Manager
 +
** There is a delay of -42 days because the email is to be sent out 6 weeks (42 days) before the report is due.
 +
** You can select a time the email is scheduled to go out, if it is to only account for business days, and whether or not holidays are included.
  
−
Sample Code Block:
+
[[File:6 week Delay connector configuration.png|thumb|none|800px|6 week Delay connector configuration]]
−
When you want to write an example block of code, you should highlight it and also escape any special characters that might be construed as HTML formatting and outputted incorrectly by the Wiki by using a pre (pre-formatted text) tag
 
  
−
<pre>
+
* The next connector connects 6 Week Reminder to Staff to the 4 Week Reminder to Grantee.
−
<?xml version="1.0"?>
+
** We have also given it a Name, left the trigger as default and selected the task that it is connecting to.
−
<Company>
+
** The trigger date is set to the date that the report is due in the Application Manager
−
<Name>Oranges Inc.</Name>
+
** There is a delay of -28 days because the email is to be sent out 4 weeks (28 days) before the report is due.
−
<Description>Peel.
 
−
Eat.
 
−
Repeat.</Description>
 
−
</Company>
 
−
<Company>
 
−
<Name>Bananas Ltd.</Name>
 
−
<Description>You're going to go "bananas" over our product!</Description>
 
−
</Company>
 
−
</pre>
 
  
−
+
[[File:4 week Delay connector configuration.png|thumb|none|800px|4 week Delay connector configuration]]
  
−
Unordered list:
+
* The next connector connects the 4 Week Reminder to Grantee to the 1 Week Reminder to Grantee.
−
When listing information with bullet points in no order
+
** We have also given it a Name, left the trigger as default and selected the task that it is connecting to.
 +
** The trigger date is set to the date that the report is due in the Application Manager
 +
** There is a delay of -7 days because the email is to be sent out 1 week (7 days) before the report is due.
  
−
* Point 1
+
* The next 2 connectors connect 1 Week Reminder to Grantee to the On Due Date reminder to the Grantee, and then the On due date reminder to the Grant Staff respectively.
−
* Point 2
+
** The trigger date is set to the date that the report is due.
−
* Point 3
+
** There isn’t a delay required since it is supposed to be sent out the day the report is due.
  
 +
* The next connector connects On due date reminder to the Grant Staff to the Status to Overdue
 +
** If, for some reason, the report does not get filled out on the due date, the Status to Overdue task changes the status of the report to overdue.
 +
** The trigger date is set to the date that the report is due.
 +
** There is a delay of 1 day but this time, it is sent 1 day after the due date.
  
 +
[[File:Status to overdue connector configuration.png|thumb|none|800px|Status to overdue connector configuration]]
  
−
Ordered list:
+
* The last connector connects Status to Overdue to the Complete.
−
When listing information with numbers to denote ordered steps
+
** If the report gets filled out on the due date, the workflow is completed. You should then connect this task to the Complete to confirm there are no more outstanding tasks and for the workflow log display.
 +
** The trigger date is set to the date that the report is due.
 +
** There is no delay and all other options are left as default.
  
−
# Step 1
+
[[File:Status overdue to complete connector.png|thumb|none|800px|Status overdue to complete connector]]
−
# Step 2
 
−
# Step 3
 
  
 +
Once you are done creating connectors your workflow should look similar to this (below)
  
 +
[[File:Overview of tasks and connectors.png|thumb|none|800px|Overview of tasks and connectors]]
  
−
Sample Page Header Banners:
+
==Testing the Workflow==
−
Deprecated Feature
+
Now that you have built the workflow, you want to make sure that it functions correctly. You can do so by setting a test record to the Approved status and checking the workflow history on the workflow. However, this particular workflow has been scheduled to send reports as far as 6 weeks in advance, the initial delay task will be listed, and the status will display as pending while it waits for the trigger date. You would need to go to the workflow history on one of the reports to see the pending email tasks.
−
<span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="Deprecated" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name=" Deprecated" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="  Deprecated" data-bs-type="template" data-bs-id="0"><span class="mceNonEditable template" id="bs_template:@@@TPL0@@@" data-bs-name="  Deprecated" data-bs-type="template" data-bs-id="0">{{    Deprecated }}</span></span></span></span>
 
−
Deprecated Page
 
−
<span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="DeprecatedPage" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name=" DeprecatedPage" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="  DeprecatedPage" data-bs-type="template" data-bs-id="1"><span class="mceNonEditable template" id="bs_template:@@@TPL1@@@" data-bs-name="  DeprecatedPage" data-bs-type="template" data-bs-id="1">{{    DeprecatedPage }}</span></span></span></span>
 
−
Professional Services
 
−
<span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="Banner-Billable" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name=" Banner-Billable" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="  Banner-Billable" data-bs-type="template" data-bs-id="2"><span class="mceNonEditable template" id="bs_template:@@@TPL2@@@" data-bs-name="  Banner-Billable" data-bs-type="template" data-bs-id="2">{{    Banner-Billable }}</span></span></span></span>
 
−
Page Under Construction
 
−
<span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="Banner-UnderConstruction" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name=" Banner-UnderConstruction" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="  Banner-UnderConstruction" data-bs-type="template" data-bs-id="3"><span class="mceNonEditable template" id="bs_template:@@@TPL3@@@" data-bs-name="  Banner-UnderConstruction" data-bs-type="template" data-bs-id="3">{{    Banner-UnderConstruction }}</span></span></span></span>
 
  
−
-->
+
'''<strong>&nbsp;'''</strong>
 +
 
 +
Once the time comes for these emails to get sent out, here is how to check to see if the workflow is performing these tasks.
 +
 
 +
* Navigate to the Workflow page and then select the history tab;
 +
 
 +
[[File:Workflow History tab.png|thumb|none|800px|Workflow History]]
 +
 
 +
* You will be able to see a list of completed workflow tasks from your workflow here. Make sure the task status is completed for each of your tasks i.e. the last connector is set to connect to Complete, for the benefit of workflow logs against a record.
 +
 
 +
 
 +
* You can also confirm that your email was sent to the applicant by navigating to your Message Queue in the Menu. This can also be accessed by going to the Global Settings -&gt; Communication
 +
** Note: Not all of the options in the menu below will be visible in your menu.
 +
 
 +
[[File:Message Queue.png|thumb|none|800px|Message Queue]]
 +
 
 +
* You will be able to see the email sitting in the queue and you can open the body of the email by clicking the envelope icon.
 +
 
 +
=See Also=
 +
* [[Workflows - Overview|Workflows Overview]]
 +
 
 +
 
 +
 
 +
[[Category:Workflows]]

Latest revision as of 11:58, 19 May 2022

Overview

Issuing notifications about upcoming task deadlines is a common requirement in grants administration. These reminders are particularly important when it comes to the completion of progress reports once a grant has been awarded. Automating these reminders reduces the administrative burden on internal staff members. This can also be helpful in the case of multi-year grants or grants with multiple reporting requirements, which can be time consuming to follow up on manually

For example, an application gets approved by a grants administrator. A report schedule is created with due dates set at 3 month intervals between the start and the end date of the grant. Automated notifications can be scheduled to remind the individual responsible to complete the task in a timely manner.

This article will show you how to set up scheduled notification reminders from workflows.

Configuration - Workflows

Creating a New Workflow

The following steps outline how to set up a new workflow:

  1. Click the Menu Icon and select Workflows link under System Process. You can also access this by going into the Global Settings > System tab > Workflows. 
    The Workflows link located under the Menu Icon
  2. On the Workflows page, click on the plus button to create a new workflow.
    The plus button allows you to create a new Workflow
  3. Select the Workflow Type. The type will dictate what options will be available when creating Tasks and where the actions will occur. For this workflow, we’re going to be selecting Tracking Activities. We are selecting Tracking Activities for this workflow because we are looking at Level 2 records which in this case are the reports.
    Main setup for creating a report reminder
  4. Give the workflow a Name, add the workflow to a Category, and add a brief Description to summarize the tasks within it, including any branching conditions for ease of review later. It is also recommended to keep track of any changes made to the task by adding some notes. Categories are created by your organization. We suggest creating categories based on the UTA and record level. The following naming convention is recommended to avoid confusion: Activity Level (1/2/3) - Goal/Status/Reminders.
  5. Set the Trigger on to determine what automated tasks are going to be triggered in this workflow. This will define when your workflow is triggered. Depending on the Workflow Type, you will be selecting from a list of statuses. In our example, the activities will have been created in the 'Scheduled' status. This is what we will set the trigger to as a result.
  6. A Termination Trigger should be set for any workflow that is scheduling tasks for the future. This will cancel any pending tasks if it is no longer required. In this example, if the applicant submits their reports ahead of the due date, the report status will change to 'Submitted', which can be set as a termination trigger on the workflow and prevent unnecessary reminders.
  7. Click the Save button. The workflow is saved and the Workflow ID is now populated

Now you will see additional options relating to this workflow. You can add notes, view the list of tasks, workflow connections, pending queue for upcoming workflow tasks, and a history of when this workflow was triggered.


Note: The field names, activity types, and status names referenced in this example are specific to the SmartSimple Grants Demo System. If you are trying to replicate this workflow in your own system, check that you are using the correct field names, activity types and statuses specific to your system. You can build your workflow on your production system first and test it on your backup the next day. Make sure to set the Trigger On to Deactivate so the workflow won’t run. Once your workflow appears in your backup, you can set the Trigger On to the correct status and test your workflow without worrying about impacting your production environment. 

Configuration - Tasks

We recommend that you create all of your workflow tasks before connecting the tasks. 

The following steps outline how to set up the tasks:

  1. Click on the Tasks on the left-hand menu. A workflow will always have a starting point and a completion point where it can terminate. In between, you can have as many different tasks in the workflow. 
Creating a New task
2.  To create a new task, click on the plus button. Again, you would have to give the task a Name, select a Task type, and add a brief Description of the task. The task types mainly used in this workflow are either an Acknowledgement or a change in status. The options available will vary from task type to task type. 

Task 1: Initial Delay

The first task is named Initial Delay since it has no function but will indicate that a workflow has started when looking through workflow histories and logs. It is a branching task without any additional function.

Initial Delay task

Task 2: 6 Week Reminder to Staff

 The next task will be used to send out the first email reminder to the Grant Staff about the upcoming report that is to be filled out

6 week reminder to Grant Staff task

Setting up the 6 Week Reminder to Staff task

  1. We have given this a Task Name  6 Week Reminder to Staff 
  2. The Task Type selected here is an Acknowledgement, which will send a message to the user.
  3. The Description is optional, but we suggest adding a brief description of what this task is performing
  4. The Role indicates which user should receive this reminder email. In this case, it is the Grant Staff user that has been assigned to record.
  5. You can Create a Default Task Connector to the previous task, but it is recommended to create all the tasks first and then create the connectors afterwards. In this case, the connector will need to be modified after it has been created to account for the scheduling.
  6. Create the Message template which would include the Message Type, Email Template, From Address, any other Cc Address(es), Message Format, Message Subject, and the Body of the message. You can use variables to populate content relevant to the triggering record, such as a name or grant id.
 
Message template for tasks

Task 3: 4 Week Reminder to Grantee

This next task will be used to send out the first email reminder to Grantee about the same upcoming report that is to be filled out.

4 week reminder to Grantee task

Setting up the 4 Week Reminder to Grantee task

  1. We have given this a Task Name  4 Week Reminder to Grantee 
  2. The Task Type selected here is an Acknowledgement, which will send a message to the user.
  3. The Description is optional, but we suggest adding a brief description of what this task is performing
  4. The Role indicates which user should receive this reminder email. In this case, it is the Grantee/Owner of the record.
  5. Create the Message template.

Task 4: 1 Week Reminder

 This next task will be used to send out a second email reminder to the Grantee about the same upcoming report that is to be filled out.

1 week reminder to Grantee task

Setting up the 1 Week Reminder to Grantee task

  1. We have given this a Task Name 1 Week Reminder to Grantee 
  2. The Task Type selected here is an Acknowledgement, which will send a message to the user.
  3. The Description is optional, but we suggest adding a brief description of what this task is performing
  4. The Role indicates which user should receive this reminder email. In this case, it is the Grantee/Owner of the record.
  5. Create the Message template.

Task 5: On Due Date Reminder to Grantee

 This next task will be used to send out a third email reminder to the Grantee about the same upcoming report that is to be filled out.

On due date reminder to Grantee task

Setting up the On Due Date Reminder to Grantee task

  1. We have given this a Task Name On Due Date Reminder to Grantee
  2. The Task Type selected here is an Acknowledgement, which will send a message to the user.
  3. The Description is optional, but we suggest adding a brief description of what this task is performing
  4. The Role indicates which user should receive this reminder email. In this case, it is the Grantee/Owner of the record.
  5. Create the Message template.

Task 6: On Due Date Reminder to Grant Staff

      This next task will be used to send out a third email reminder to the Grant Staff about the same upcoming report that is to be filled out.

On due date reminder to Grant Staff task

Setting up the On Due Date Reminder to Grant Staff task

  1. We have given this a Task Name On Due Date Reminder to Grantee
  2. The Task Type selected here is an Acknowledgement, which will send a message to the user.
  3. The Description is optional, but we suggest adding a brief description of what this task is performing
  4. The Role indicates which user should receive this reminder email. In this case, it is the Grant Staff on the record.
  5. Create the Message template.

Task 7: Status to Overdue

      This task is created to change the status of the report to overdue. Note that if additional tasks need to be triggered by the overdue status, an additional workflow will need to be created and triggered.

Status to Overdue task

Setting up the Status to Overdue task

  1. We have given this a Task Name Status to Overdue
  2. The Task Type selected here is an Change Status, which changes the status of the record.
  3. The Target in this case would be the current object, which is the report.
  4. The Entity is Level One
  5. This task will Change Status To Overdue

Configuration - Task Connectors

Creating Task Connectors

Now that you have created all of your workflow tasks, you will need to connect them. This can be done by creating Connectors. Workflows only run tasks if they have been connected together and have applicable conditions.


  • Create a Starting connector to start your workflow. 
    • Click the New button on the first row of your workflow tasks. 
Create a new task connector
    • The connector connects the starting point to the Initial Delay
    • Leave the Name and Trigger Type as the default for your starting connector, or name it appropriately if required.
    • For the Connect To option - select the task you want the workflow to start with - in this case it will be the Initial Delay task.
Start connector configuration

After creating the first connector, it should look like this;

Start task connecting to Initial delay

You will need to create connectors for the remaining tasks. Make sure that you connect the current task in the workflow. The default option in the connector is Complete - which will end your workflow.

  • The next connector connects the initial delay to 6 Week Reminder to Staff.
    • We have given it a Name, left the trigger as default and selected the task that it is connecting to.
    • The trigger date is set to the date that the report is due in the Application Manager
    • There is a delay of -42 days because the email is to be sent out 6 weeks (42 days) before the report is due.
    • You can select a time the email is scheduled to go out, if it is to only account for business days, and whether or not holidays are included.
6 week Delay connector configuration
  • The next connector connects 6 Week Reminder to Staff to the 4 Week Reminder to Grantee.
    • We have also given it a Name, left the trigger as default and selected the task that it is connecting to.
    • The trigger date is set to the date that the report is due in the Application Manager
    • There is a delay of -28 days because the email is to be sent out 4 weeks (28 days) before the report is due.
4 week Delay connector configuration
  • The next connector connects the 4 Week Reminder to Grantee to the 1 Week Reminder to Grantee.
    • We have also given it a Name, left the trigger as default and selected the task that it is connecting to.
    • The trigger date is set to the date that the report is due in the Application Manager
    • There is a delay of -7 days because the email is to be sent out 1 week (7 days) before the report is due.
  • The next 2 connectors connect 1 Week Reminder to Grantee to the On Due Date reminder to the Grantee, and then the On due date reminder to the Grant Staff respectively.
    • The trigger date is set to the date that the report is due.
    • There isn’t a delay required since it is supposed to be sent out the day the report is due.
  • The next connector connects On due date reminder to the Grant Staff to the Status to Overdue
    • If, for some reason, the report does not get filled out on the due date, the Status to Overdue task changes the status of the report to overdue.
    • The trigger date is set to the date that the report is due.
    • There is a delay of 1 day but this time, it is sent 1 day after the due date.
Status to overdue connector configuration
  • The last connector connects Status to Overdue to the Complete.
    • If the report gets filled out on the due date, the workflow is completed. You should then connect this task to the Complete to confirm there are no more outstanding tasks and for the workflow log display.
    • The trigger date is set to the date that the report is due.
    • There is no delay and all other options are left as default.
Status overdue to complete connector

Once you are done creating connectors your workflow should look similar to this (below)

Overview of tasks and connectors

Testing the Workflow

Now that you have built the workflow, you want to make sure that it functions correctly. You can do so by setting a test record to the Approved status and checking the workflow history on the workflow. However, this particular workflow has been scheduled to send reports as far as 6 weeks in advance, the initial delay task will be listed, and the status will display as pending while it waits for the trigger date. You would need to go to the workflow history on one of the reports to see the pending email tasks.

 

Once the time comes for these emails to get sent out, here is how to check to see if the workflow is performing these tasks.

  • Navigate to the Workflow page and then select the history tab;
Workflow History
  • You will be able to see a list of completed workflow tasks from your workflow here. Make sure the task status is completed for each of your tasks i.e. the last connector is set to connect to Complete, for the benefit of workflow logs against a record.


  • You can also confirm that your email was sent to the applicant by navigating to your Message Queue in the Menu. This can also be accessed by going to the Global Settings -> Communication
    • Note: Not all of the options in the menu below will be visible in your menu.
Message Queue
  • You will be able to see the email sitting in the queue and you can open the body of the email by clicking the envelope icon.

See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Creating_a_workflow_with_scheduled_reminders&oldid=39851’