Smartstaff
119
edits
Changes
→No summary
=Configuration - Essentials=
* 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
[[File:|none]]INSERT IMAGE IMAGE
* The Workflows page is displayed. Click on the plus button to create a new workflow.
INSERT IMAGE 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 IMAGE
* 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.
*** EX: Reports - Reminders
** Suggested naming convention: Activity Level (1/2/3) - Goal/Status/Reminders<br data-attributes="%20/">
*** EX: Grants Manager L1/L2
* 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 ‘Scheduled’ status. This is what we will set the trigger to as a result.
'''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.
'''*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.
=Configuration - Creating Tasks=
'''*Best Practice*''' → → Create all of your workflow tasks before connecting the tasks.
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 in the workflow.''' '''
INSERT IMAGE IMAGE
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.
INSERT IMAGE IMAGE
'''Creating the tasks'''
* '''Task 1: Initial Delay'''<br data-attributes="%20/">
** 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.
* '''Task 2: 6 Week Reminder to Staff'''
INSERT IMAGE IMAGE
: '''Task Name → '''6 Week Reminder to Staff Staff
: '''Task Type''' → Acknowledgement
: '''Description''' → Add a brief description of what this task is performing
: '''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.
: 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.
INSERT IMAGE IMAGE
: 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.
* '''Task 3: 4 Week Reminder to Grantee'''
INSERT IMAGE IMAGE
: '''Task Name → '''4 Week Reminder Reminder
: '''Task Type''' → Acknowledgement
: '''Description''' → Add a description
* '''Task 4: 1 Week Reminder'''
INSERT IMAGE IMAGE
: '''Task Name → '''1 Week Reminder Reminder : '''Task Type''' → → Acknowledgement: '''Description''' → → Add a description: '''Role''' → → Add the role that should receive this reminder email - Owner: Create the the '''Message template'''
* '''Task 5: On Due Date Reminder to Grantee'''
INSERT IMAGE IMAGE
: '''Task Name → → '''On Due Date Reminder to Grantee: '''Task Type''' → → Acknowledgement: '''Description''' → → Add a description: '''Role''' → → Add the role that should receive this reminder email - Owner: Create the the '''Message template'''
* '''Task 6: On Due Date Reminder to Grant Staff'''
INSERT IMAGE IMAGE
: '''Task Name → → '''On Due Date Reminder to Staffto Staff: '''Task Type''' → → Acknowledgement: '''Description''' → → Add a description: '''Role''' → → Add the role that should receive this reminder email - Grant Grant Staff: Create the the '''Message template'''
* '''Task 7: Status to Overdue'''
INSERT IMAGE IMAGE
: '''Task Name → → '''Status to Overdue: '''Task Type''' → → Change Status: '''Target''' → Current → Current Object (report): '''Entity''' → Level → Level One
: '''Change Status To→ '''Application Manager - Overdue
=Configuration - Creating task 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.
** 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.
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.
'''<strong> '''</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.
* 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.
==Options and Settings==
<!span id="bs_comment:@@@CMT0@@@" class="mceNonEditable comment" data-bs-type="comment" data-bs-id="0">Explain all applicable misc options and settings that shouldn't be explained above here...--</span>
===General Settings===
{| class="wikitable"
=Examples=
<!span id="bs_comment:@@@CMT1@@@" class="mceNonEditable comment" data-bs-type="comment" data-bs- {| classid="1"> 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"><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></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"><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></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"><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></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"><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>span </span> -->