=Overview=
A [[Https://wiki.smartsimple.com/wiki/Workflows Overview|Workflow]] is a set of repeatable steps used to automate and streamline your business processes within the system (e.g. creating review forms and notifying reviewers via email). <u>'''Use case'''</u>
==Use case==
Once your application hits a specific status, there may be a handful of activities that need to be created or fields that need to be updated in order for the application to move to the next status. By using various workflow tasks, you can have all these tasks completed automatically, simplifying your granting process.
<u>'''===Example:'''</u>===
Once an application is moved to the Approved Status - you want to create a payment activity, a few report activities, send an email to the applicant, and update the Approved Date field.
=Configuration - Essentials=
<u>'''==Creating a New Workflow'''</u>== * Create You can create a new workflow by clicking the plus button on the workflows home page. INSERT IMAGE * Select '''Workflow Type''': The type will dictate which information/fields will be available when creating tasks - You can select different UTA’s, levels, contacts, organizations etc… as your workflow type. * Name the workflow and add it to a Category ** Suggested naming convention: UTA, Record Level (1/2/3) - Goal/Status *** '''EX:''' Submission Manager L1 - Approved Status ** Categories are created by your organization. We suggest creating categories based on the UTA and Record Level. *** '''EX:''' Submission Manager L1* Add a workflow description (optional). ** Include a list of tasks and branching conditions for ease of review later. ** Add notes to your workflow if you make changes to it. * Set the '''Trigger-On'''** The trigger dictates what status or action will initiate the workflow.** Depending on the workflow type, you will be selecting from a list of statuses or activities. ** For our example, we will be triggering our workflow when a record hits the Approved status. [[File:|none]] INSERT IMAGE HERE '''<strong> '''</strong> <span style="color: #ff0000;">'''*Tip*'''</span> → You can build a workflow on your production system first and test it on your backup the following 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 trigger and test your workflow without worrying about impacting your production environment. ''' ''' =Configuration - Creating Tasks=<span style="color: #0000ff;">'''*Best Practice*'''</span> → Create all of your workflow tasks before connecting the tasks.
<u>'''Creating Your First Task'''</u>[[File:add_new_wflow.png|thumb|none|800px|Add a new workflow]]
* Navigate to the Task tab found on the left side of your screen.
INSERT IMAGE ===Configuring A Workflow===:1. Select '''Workflow Type''': The type will dictate which information/fields will be available when creating tasks - You can select different UTA’s, levels, contacts, organizations etc… as your workflow type.
:2. Name the workflow and add it to a Category
::* Suggested naming convention: UTA, Record Level (1/2/3) - Goal/Status
::: '''EX:''' Submission Manager L1 - Approved Status
::
::* Categories are created by your organization. We suggest creating categories based on the UTA and Record Level.
::: '''EX:''' Submission Manager L1
* To create a new task → Click on the plus sign button found on the top left corner of your screen :3. Add a workflow description (highlighted in image aboveoptional). :::** We suggest creating an '''Acknowledgment''' as your first task type. ** Name this task '''PlaceholderInclude a list of tasks and branching conditions for ease of review later.''' :::*** This task will not have a function but will indicate that a workflow has started when looking through Add notes to your workflow history/logs on the record that has passed through this processif you make changes to it.
:4. Set the '''Trigger-On'''
:::* The trigger dictates what status or action will initiate the workflow.
:::* Depending on the workflow type, you will be selecting from a list of statuses or activities.
INSERT IMAGE :::* For our example, we will be triggering our workflow when a record hits the Approved status.[[File:Creating Approved Status Workflow- Workflow Main Set-up Page.png|thumb|none|800px|Creating Approved Status Workflow - Workflow Main Set-up Page]]<span style="color: #000000;">'''Tip:'''</span> You can build a workflow on your production system first and test it on your backup the following 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 trigger and test your workflow without worrying about impacting your production environment.
=Configuration - Advanced=
==Tasks==
<u>Navigate to the '''Creating Your Remaining Tasks (2-4)Task tab'''</u>found on the left side of your screen.
'''[[File:Creating-Task 2 – Create Payment Record '''.png|thumb|none|800px|Creating a Task]]
* Task Name → Create Payment Record
* Task Type → Create New Activity
* Select the activity type you want to create and the default status the activity should be created in.
INSERT IMAGE ===Creating The First Task===# To create a new task, click on the plus sign button found on the top left corner of your screen (highlighted in image above). # We suggest creating an '''Acknowledgment''' as your first task type. #* Name this task '''Placeholder.''' #** This task will not have a function but will indicate that a workflow has started. You will be able to see this task listed in the workflow history log on a specific record.[[File:Placeholder-Task.png|thumb|none|800px|Placeholder Task]]
===Creating The Remaining Tasks===
====Task 2 – Create Payment Record====
:1. '''Task Name:''' Create Payment Record
:2. '''Task Type:''' Create New Activity
* Under :3. Select the scheduling tab → configure the L2 '''activity type''' you want to meet your requirements. Not all fields listed in this section need to be configured - it will depend on create and the default status the activity typeshould be created in.
[[File: → Start Date / End Date: Choose the date fields that will determine the start and end date of the activity scheduling period. : → You can set the frequency the activity is scheduled Create-New- activities will be created immediately, but the date will take the frequency into account. Note that activities will only be automatically scheduled within the time frame set above. : → Select the field from the grant application that contains the grant amount. This value will then be split equally between all payment activities being scheduled. : → You can also select the field where the amount of each payment will be stored Activity- note that the total amount will be divided equally between all of the activitiesTask. : → Select the date field that will determine the scheduled activity date.: INSERT IMAGE <span style="color: #008000;">'''Note:'''</span> If you do not see png|thumb|none|800px|Creating a Scheduling Tab → make sure to toggle on advanced options found near the top right of your screen. '''New Activity Task 3 - Send Approved Receipt ''']]
* Task Name :4. Under the '''scheduling tab''' → Send Approved Receipt configure the activity to meet your requirements. Not all fields listed in this section need to be configured - it will depend on the activity type.
:::* Task Type → Acknowledgement '''Start Date / End Date:''' Choose the date fields that will determine the start and end date of the activity scheduling period.:::* You can set the frequency the activity is scheduled - activities will be created immediately, but the date will take the frequency into account. Note that activities will only be automatically scheduled within the time frame set above.:::* Select the field from the grant application that contains the grant amount. This value will then be split equally between all payment activities being scheduled.:::* You can also select the field where the amount of each payment will be stored - note that the total amount will be divided equally between all of the activities.:::* Select the date field that will store the scheduled activity date.[[File:Scheduling-tab.png|thumb|none|800px|Scheduling Tab]]
* In this case, you will be using the acknowledgment task to send an email to the applicant. You can specify who the email will be sent to under the Routing section. Select Owner if you want the email to be sent to the applicant.
'''Note:''' If you do not see a Scheduling Tab → make sure to toggle on advanced options, found near the top right of your screen.
INSERT IMAGE====Task 3 - Send Approved Receipt====:1. '''Task Name: '''Send Approved Receipt
:2. '''Task Type''' : Acknowledgement
:3. In this case, you will be using the acknowledgment task to send an email to the applicant. You can specify who the email will be sent to under the Routing section. Select Owner if you want the email to be sent to the applicant.
* You can configure the email being sent by navigating to the Message Template tab[[File:Task-routing. png|thumb|none|800px|Routing a Task]]
* Here you :4. You can specifyconfigure the email content by navigating to the '''Message Template tab'''. [[File:Message-Template-Tab.png|thumb|none|800px|Message Tab]]
: → Message type (instant message or email)5.: → Email template (Here you can create from scratch or choose an existing template).: → Add a subject to the email template.specify: → You can use the Variable Syntax helper (found in the configuration mode shortcuts) to test your email template against a record. Copy the email template and paste it into the helper. This will allow you to confirm that you are populating the correct information in your email template. * We always suggest saving your email as an event. This will store the email as an event on the user profile.* You can also add attachments to the email template here.
: → To do so you will need to reference a custom field where the document is stored::* Message type (instant message or email). The format used to reference the field is '''@#Custom Field ID#@''': → You ::* Email template (can attach multiple documentscreate from scratch or choose an existing template). They will need :::* Add a subject to be delimited by semicolonsthe email template. : → Saving the ::* We always suggest saving your email as an event . This will create store the email as an Email activity event on the Application record - this makes it easier to track communications between your organization and the applicantuser profile.
INSERT IMAGE:6. You can also add attachments to the email template here.
:::* To do so you will need to reference a custom field where a document is stored. The format used to reference the field is '''@#Custom Field ID#@'''
:::* You can attach multiple documents. They will need to be delimited by semicolons.
:7. You can use the Variable Syntax helper (found in the configuration mode shortcuts list) to test your email template against a record.
:::* Copy the email template and paste it into the helper. This will allow you to confirm that you are populating the correct information in your email template.
'''Task 4 [[File:Creating Approves Status Workflow - Create Progress Report '''Attaching Files to Email.png|thumb|none|800px|Attach a file to an email]]
* ====Task 4 - Create Progress Report====:1. '''Task Name → : '''Create Progress Report
* :2. '''Task Type → :''' Create New Activity
* :3. Select Progress Report from the activity drop-down and specify the configuration for the new activity under the Scheduling tab (visual example shown in Task 2).
====Task 5 - Create Final Report====
:1. '''Task Name:''' Create Final Report
:2. '''Task 5 - Create Final Report Type:'''Create New Activity
* Task Name → Create :3. Select the Final Reportfrom the activity drop-down.
* Task Type → Create New Activity :4. In this case you only want to generate a single Final Report, so you will not need to configure any fields under the scheduling tab.
* Select the Final Report from the activity drop====Task 6-down. Create Contract====* In this case you only want to generate a single Final Report, so you will not need to configure any fields under the scheduling tab:1. '''Task Name:''' Create Contract
:2. '''Task Type: '''Create New Activity
'''Task 6- Create Contract ''':3. In this case you only want to generate a single Contract, so you will not need to configure any fields under the scheduling tab.
* Task Name → Create Contract:4. You can also generate a contract through the '''Generate PDF task''' - but you will not be able to alter the document once the PDF is created. By creating a contract activity, you are able to make adjustments to the contract's content.
* ====Task Type → Create New Activity 7 - Update Approved Date====* In this case you only want to generate a single Contract, so you will not need to configure any fields under the scheduling tab:1. '''Task Name:''' Update Approved Date
: → You can also generate a contract through the '2. ''Generate PDF task'Task Type: '' - but you will not be able to alter the document once the PDF is created. By creating a contract activity, you are able to make adjustments to the contract's content.Update Custom Field Value
:3. '''Task 7 - Update Approved Date -Select the field you want to update: '''Date Approved
* Task Name → Update Approved Date :4. You can then enter the updated field value below.
:::* Task Type → Update Custom Field ValueIf you want to update the field to the current date - enter the following variable - '''@date(currentdate)@'''
* Select the [[File:Update-custom-field you want to update → Date Approved-task.png|thumb|none|800px|Update Custom Field Task]]
* You can then enter the updated field value below. * If you want to update the field to the current date - enter the following variable - @date(currentdate)@ INSERT IMAGE =Configuration - Creating =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 will only run tasks if they have been connected together and have applicable conditions to the current record.
===Creating your First Connector===
: 1. Click the New button on the first row of your workflow tasks.
[[File:Create-new-connector.png|thumb|none|800px|Create a new connector]]
: 2. You can leave the Name and Trigger Type as the default for your starting connector.
: 3. For the Connect To option - select the task you want the workflow to start with - in this case it will be the Placeholder task.
:::* Typically, tasks should be created in the order they will be executed in, but they can be reordered later if need be.
[[File:Start-connector-config.png|thumb|none|800px|Starting connector configuration]]
'''Create a Starting connector to kick-off your workflow. ''' * Click the <u>New</u> button on the first row of your workflow tasks. INSERT IMAGE * You can leave the Name and Trigger Type as the default for your starting connector. * For the <u>Connect To</u> option - select the task you want the workflow to start with - in this case it will be the Placeholder task. : '''→ '''Typically, tasks should be created in the order they will be executed in, but they can be reordered later if need be. ===Branching Connectors===Applications that have already been Approved have gone through this workflow before. To make sure a record that has already gone through this workflow does not go through all of the tasks again, you will need to create '''Branching Connectors.''' Branching connectors have specific conditions that will allow you to direct records to different tasks based on that condition.
For this example, the condition will be whether the Approved Date field is blank or not blank.
====Creating Branching Connectors====
: 1. Create a new connector for the placeholder task by clicking the New button beside Task 1. You will need to create as many connectors as conditions. In this case, you will be creating two connectors for this task.
: 2. Once you have clicked New - Name the connector based on the condition. In this case we want applications that already have a value in the Approved Date Field to jump tasks 2-5 and go directly to task 6 (Update Date Approved).
:::* The name for this connector should indicate the condition - in this case we will be naming it Date Approved Not Blank.
: 3. The connect to option in this case would need to be '''Updated Date Approved.'''
[[File:Branching-connector-one-config.png|thumb|none|800px|Branching connector configuration]]
'''Create Branching Connectors - this will allow you to specify which applications go to which task based on some pre-set conditions. ''' * Create a new connector for the placeholder task by clicking the New button beside Task 1. You will need to create as many connectors as conditions. In this case, you will be creating two connectors for this task. * Once you have clicked New - Name the connector based on the condition. In this case we want applications that already have a value in the Approved Date Field to jump tasks 2-5 and go directly to task 6 - Update Approved Date Field. : → The name for this connector should indicate the condition - in this case we will be naming it Date Approved Not Blank4. : → The connect to option in this case would need to be <u>Updated Date Approved.</u> INSERT IMAGE * Navigate to the '''Routing Conditions tab ''' in your connector settings - this is where you can specify which applicants applications will skip the certain workflow tasks. * : 5. You can filter by Type, Status, or custom condition. In this case we want to filter by custom condition - Condition: Approved Date Field is Not Blank. :::* The custom condition to check if the field if not blank is - '''"@Date Approved@"!="'''" INSERT IMAGE * Now you can create a second connector for the Placeholder Task that routes the applications with a Blank Approved Date Field to task 2 - Create Payment Record. INSERT IMAGE * For the routing condition - The custom condition will be that the Approved Date field is blank. * The custom condition to check if the field is blank is “@Date Approved@”-”” INSERT IMAGE * Now the placeholder task has two connectors with one routing to applications with an existing Approved Date to the Update Approved Date task and the other routing applications with no Approved Date to the Create Payment Record task. INSERT IMAGE * You will need to create connectors for the remaining tasks. This can be done by clicking the New button for each task. * Make sure that you connect the current task to the next task you want it to go to. The default is for the connector to connect to Complete - which will end your workflow.
INSERT IMAGE [[File:Branching-connector-one-routing.png|thumb|none|800px|Branching connector routing conditions]]
: 6. Now you can create a second connector for the placeholder task that routes the applications with a Blank Approved Date Field to task 2 (Create Payment Record).
[[File:Branching-connector-two-config.png|thumb|none|800px|Branching connector configuration]]
: 7. For the routing condition - The custom condition will be that the Approved Date field is blank.
:::* The custom condition to check if the field is blank is '''“@Date Approved@”-””'''
* Once you have created connectors for all of the tasks [[File:Branching- connect the final task to Completeconnector-two-routing. png|thumb|none|800px|Branching connector routing conditions]]
: 8. Now the placeholder task has two connectors with one routing applications with an existing Approved Date to the Update Approved Date task and the other routing applications with no Approved Date to the Create Payment Record task.
[[File:Branching-connector-summary-photo.png|thumb|none|800px|Branching Connectors]]
INSERT IMAGE
* Once you are ===Building the Remaining Connectors===You will need to create connectors for the remaining tasks. This can be done creating connectors your workflow should look like this (below)by clicking the New button for each task.
Make sure that you connect the current task to the next task you want it to go to. The default is for the connector to connect to Complete - which will end your workflow.
INSERT IMAGE [[File:Regular-connector-config.png|thumb|none|800px|Connector Configuration]]
Once you have created connectors for all of the tasks - connect the final task to Complete.
[[File:Complete-connector-config.png|thumb|none|800px|Connector Configuration]]
Once you are done creating connectors your workflow should look like this (below).
[[File:Full-workflow-photo.png|thumb|none|800px|Connector Configuration]]
==Testing a 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 record to the Approved status and checking the workflow history on the record. We would suggest doing this in your backup system so it does not impact your production environment.
:1. Take a test record and move the status to Approved then click submit.
[[File:Approved-status-test-record.png|thumb|none|800px|Testing your workflow]]
* Take a test record :2. Navigate to the Logs drop down near the top left of the screen and move select the status to Approved then click submitWorkflow History option.
INSERT IMAGE [[File:Workflow-history-log-location.png|thumb|none|800px|Testing your workflow]]
* Navigate :3. You will be able to see a list of completed workflow tasks from your workflow here. Make sure the Logs drop down near the top left task status is completed for each of the screen and select the Workflow History optionyour tasks.
INSERT IMAGE * You will be able to see a list of completed workflow tasks from [[File:Workflow-history-log.png|thumb|none|800px|Testing your workflow here. Make sure the task status is completed for each of your tasks. INSERT IMAGE ]]
{| class="wikitable"
|-
||Acknowledgment
||This Task will allow you to send messages to users in SmartSimple.
||Sending an email to an applicant.
|-
||Update Custom Field Value
||This Task will allow you to update the value of one or multiple custom fields.
||Update the Approved Date field on a record to the current date.
|-
||Update Standard Field Value
||This Task will allow you to update the value of one or multiple standard fields.||Update the Application Name field.
|-
||Create New Activity
||This Task will allow you to generate a new L2 record associated with your L1 record.
||Generate a Progress Report activity for a grant application.
|-
||Generate a pdf of an application after it has been submitted.
|}
===Display Settings===
{| class="wikitable"
|-
!|Option
!|Description
!|Example
|-
||
||
||
|}
=Examples=
<!--
{| class="wikitable"
!| Option
!| Description
!| Example
|-
|
|
|
|}
Sample Syntax Format:
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''@
Sample Code Block:
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>
<?xml version="1.0"?>
<Company>
<Name>Oranges Inc.</Name>
<Description>Peel.
Eat.
Repeat.</Description>
</Company>
<Company>
<Name>Bananas Ltd.</Name>
<Description>You're going to go "bananas" over our product!</Description>
</Company>
</pre>
Unordered list:
When listing information with bullet points in no order
* Point 1
* Point 2
* Point 3
Ordered list:
When listing information with numbers to denote ordered steps
# Step 1
# Step 2
# Step 3
Sample Page Header Banners:
Deprecated Feature
<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>
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">{{ DeprecatedPage }}</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">{{ Banner-Billable }}</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">{{ Banner-UnderConstruction }}</span></span>
-->