TracCloudSuccessPlans: Difference between revisions

From Redrock Wiki

No edit summary
No edit summary
Line 96: Line 96:
<hr>
<hr>
==<b>Emails</b>==
==<b>Emails</b>==
aaaaaaaaaaaaaaaaaaa
(EDITING NOTE: TEST BEFORE WRITING MORE)
[[File:7535572.png|900px]]<br><br>


<big>Twig Tags:</big>
{{#lst:TracCloudGuideProfilePrefsTwig|SPTags}}
{{#lst:TracCloudGuideProfilePrefsTwig|SPTags}}
<hr>
<hr>

Revision as of 11:57, 4 January 2023


Success Plan Contents

Creating a Success Plan
Setup: Steps
Setup: Dashboard Display
Setup: Emails
Setup: Options
Managing Student Plans
Group Permissions
Staff & Faculty Dashboard
Reports

Success Plans


The Success Plan module allows you to track students' progress in their Success Plans. Each Success Plan contains Steps for students to complete. Each Step represents a type of task, such as visiting a center, responding to a survey, uploading a document, and more.


Creating a Success Plan

To create a success plan, go to Other > Success Plans > Hamburger menu (File:Hamburger.png) > New Success Plan. Once you save your Success Plan with a name, the following options will be available.

File:2770415.png

  • Plan Name
This is the name of the Success Plan that you will be assigning to students. This is also visible to students on the dashboard when viewing progress

  • Date Mode
This option determines how the Due in Days options of your steps is calculated. Relative to Plan Start is the most common option, meaning the student would have 5 days to complete the first step in the screenshot above, starting when they were first assigned the plan. Relative to Term Start is based on the semester start date instead. If your term started on Jan 1st, and the student was assigned the Success Plan on the 3rd, they still need to complete the first Step by Jan 5th. Fixed allows you to specify a deadline for each Step.


Steps

Click on the New Step button to create your first Step. Based on which Step Type you choose, the rest of the options on this page can differ.

File:7332126.png

  • Days from Plan Start or Date
This allows you to specify when this Step needs to be completed. You will specify the number of days if one of the relative Date Modes is used, or specify a date if the fixed Date Mode is chosen.

  • Step Type
This determines the criteria that must be met for this task. Each Step Type has its own set of options for setting the completion criteria. Most of these options are self-explanatory, so we will just go over the Types here.
Visit - Based on the student's visit. You can choose which Center, Reason, Consultant, and Section/Course List must be selected for the visit to count towards Plan completion. If these fields are left blank, they are not considered when the Step is completed.
Survey - This is based on the student responding to a specified survey. Click here for more information on SurveyTrac.
Document - The student will need to upload a document of the specified type to an appointment for this to be marked as completed. Click here for more information on Documents.
Task - Based on the student's completion of a task. Click here for more information on Tasks.
Checkout - Based on student's resource usage. A Step of this type is completed when the student checks out a resource matching the name and category entered here. Click here for more information on Resources.
Notification - This is based on the student's acknowledgement of a notification. Click here for more information on Notification Types.
Prompt - This appears as a highlighted question on the student's dashboard. You can choose the question and the confirm button title, as well as allow the student to enter notes.

  • Prompt / Confirmation Directed To
(EDITING NOTE: RE-CONFIRM WHAT THIS DOES)

File:3799967.png

  • Override Confirmation for this Step
By default, your steps will follow the Plan's Staff Confirmation preference. This option allows you to override that for a specific step, requiring or not requiring that a staff member must confirm the completion of this step. (DOUBLE-CHECK THIS)

  • Is an Optional Step
If checked, the completion of this Step does not contribute to overall completion of the Plan.

  • Do not send completion/reminder emails
This option prevents this Step from prompting emails to be sent.

  • Show prompt to complete on dashboard
This will show a reminder to the student in the form of an announcement on the dashboard. The text here can also be customized if you want to provide more specific instructions.
8867433.png

Dashboard Display

Students can be shown information about their success plans on their dashboard. The information and formatting contained here can be customized to better suit your requirements. The screenshot below is the student dashboard with the default display configuration.

File:8328440.png

This is customized from the Dashboard Display tab of your Success Plan Type. This is the default value, which can be loaded by clicking the clipboard icon in the top-left corner of this menu. Both Twig and HTML can be used to personalize this. Header displays once at the top of this form, and is expected to contain instructions or details on their Success Plan. Line Display repeats for each Step the student has been assigned, using Twig to determine if the formatting needs to change for each entry. Footer Display is the final block of text in this menu. If these fields are left blank, the Success Plan widget will not be shown on the student dashboard at all.

File:2280086.png


Emails

(EDITING NOTE: TEST BEFORE WRITING MORE) File:7535572.png

Twig Tags:

Success Plans
SuccessPlan.Name The name of your Success Plan
SPAssigned.DateStarted Start Date of the Success Plan
SPAssigned.DateCompleted Completion Date of the Success Plan
SPAssigned.DueDate Due Date for Success Plan
SPAssigned.Status The Status of the Success Plan (e.g., "In Progress")
SPAssigned.Percent The completion percentage of the Success Plan (e.g., 75)
SPStep.Sequence The sequence of the current Step
SPStep.Type The type of the current step (e.g., Visit, Task, etc.)
SPStep.DateOrOffset When this Step needs to be completed (number of days or static date based on Plan type)
SPStep.isOptional Whether or not the current Step is optional (1 or 0)
SPStep.isNoSendEmails Whether or not emails are disabled for this Step (1 or 0)
SPStep.isPromptOnDash Whether or not the prompt is set to display on the dashboard (1 or 0)
SPStep.DirectedTo Who the confirmation is directed to (0 = Student, 1 = Plan Staff, 2 = Plan Faculty, 3 = Step Staff, 4 = Step Faculty)
SPStep.OverrideRequireConfirmation Whether or not this step has been overridden to allow/disallow confirmation
SPAssignedStep.CompletedDate The completion date of your Success Plan Step
SPAssignedStep.DueDate The due date of your Success Plan Step
SPAssignedStep.CompletionOverride Whether or not the completion override option is enabled for this Step (1 or 0)
SPAssignedStep.StaffNotes Any notes entered by staff for this Step
SPAssignedStep.Confirmed Whether or not this Step has been confirmed (1 or 0)
SPAssignedStep.Index The number of the step, based on the order they were created in.


Other
{{Trigger}} The trigger that prompted this email to be sent (trigger_PlanStarted, trigger_PlanReminder1, trigger_PlanComplete, trigger_StepStarted, etc.)
{{ setResultActions('SendEmail', '0') }} If this action is reached (typically in a Twig 'if' statement), the email will not be sent
{{ setResultActions('FacultyID', '1') }} If this action is reached (in a Twig statement), the assigned Faculty will be changed to the sequence number specified here
{{ setResultActions('ConsultantID', '1') }} If this action is reached (in a Twig statement), the assigned Consultant will be changed to the sequence number specified here
{{ setResultActions('TermID', '1') }} If this action is reached (in a Twig statement), the assigned Term will be changed to the sequence number specified here
{{ setResultActions('NextPlanID', '3') }} If this action is reached (in a Twig statement), a new Success Plan will be assigned (for use in Chained Sub Plans)
{{ GetDatePlusDays(5) }} Get the current date plus the number of days specified in parentheses
{{ GetDateTimePlusDays(5) }} Get the current date AND time plus the number of days specified in parentheses
{{ createResultAction('createNotification', {'Type' : 1, 'Notes' : 'Sample Notes', 'StudentID': Student.Sequence, 'ForUID' : Student.UUID}) }} If this action is reached (in a Twig statement), the student will be sent a Notification. Enter the notification sequence where the '1' is in this example.
{{ createResultAction('createSurvey', {'SurveyID' : 1, 'StudentID': Student.Sequence, 'linkedUID' : Student.UUID}) }} If this action is reached (in a Twig statement), the student will be sent a Survey. Enter the Survey sequence where the '1' is in this example.
{{ createResultAction('createReferral', {'RefTypeID' : 1, 'StudentID': Student.Sequence, 'FacultyID' : 0, 'SectionID' : 0, 'ConsultantID' : 0, 'CenterID' : 0, 'ReasonsData' : [{"key": "###keyIndex###","reason": "Time management"}]}) }} If this action is reached (in a Twig statement), a SAGE Referral will be created for the student. Enter the Referral sequence where the "1" is in this example. Additional assignments can also be made.
{{ createResultAction('createAssignment', {'PotentialAssignmentID' : 1, 'StudentID': Student.Sequence, 'RegistrationID' : GetStudentRegID(Student.ID,'MAT100 0000 FALL%'), 'GradePoints' : 0, 'Comments' : 'Notes go here'}) }} If this action is reached (in a Twig statement), an Assignment will be created for the student. Enter the potential assignment sequence where the '1' is, and choose the section.
{{ createResultAction('createTask', {'TaskType' : 0, 'ForUID' : Student.UUID, 'StudentID': Student.Sequence, 'TaskName' : 'Test of Task Name', 'DueDate' : '2030-01-01', 'Completed' : 0 }) }} If this action is reached (in a Twig statement), a Task will be assigned to the Student. Enter the Task sequence where the '0' and choose a due date.
{{ createResultAction('updateStudent', {'Major' : 'Business', 'CustomData.cf_99' : "Text goes here' }) }} If this action is reached (in a Twig statement), student fields can be updated to the text specified here. Multiple fields can be edited at once (Major and Custom_99 in this example). Field names are case sensitive.

Options

The final tab in your Success Plan Type is Options. This contains various options to fine-tune the functionality of this Success Plan.

File:7837218.png

  • Allow Notes Per Steps
If checked, staff members will have the ability to enter notes on each Step in student profiles.

  • Steps are Confirmed
If checked, a staff member will need to confirm the completion of a Step before it's counted towards Plan completion.

  • Completion of Steps may be overridden
This allows a staff member to specify a completion date for a Step even if the criteria hasn't been met by TracCloud's own process. For example, if a student handed in a physical document rather than uploading it to an appointment, this can be used to mark that Step as completed anyway.

  • Steps may be Completed Out of Order
If this option is unchecked, Steps must be completed in order to count towards Plan completion. If checked, students can complete Steps in any order.

  • Plan / Step Reminder Options
Multiple reminder emails can be sent as the due date of a Step/Plan approaches. Use these options to determine when those reminders are sent relative to the due date of each Step/Plan.

Assigning and Managing Success Plans for Students

Plans can be assigned to individual students from the Success Plans tab of their profile. Click on Assign Plan to Student and choose the Plan type that you want to use. This page also lists the current and past Plans for this student, including assigned and due date, completion status, term, and more. Clicking the pencil icon on the left provides quick access to that Plan's options.

2436561.png

After creating a new Plan for the student (or opening an existing one), you will find the following options. This includes basic details about the student, their plan details such as due date and progress, the assigned consultant, faculty, and term, and the individual steps.

6976440.png

The options available within each Step can differ based on your Plan options. Override Completion allows you to specify if and when a Step was completed, bypassing TracCloud's automated tracking. Completion Confirmed is used to confirm that this Step has been concluded, allowing it to count towards Plan completion percentage. Notes can be used for any purpose to record additional information regarding each Step.

File:5418866.png


Group Permissions

In order to give a staff member the ability to manage Success Plan types, they must be given access to the Success Plan Table. Go to Other > Other Options > Groups > [The group you want to modify] > Admin / Modules > Table Access > Add "Success Plans" > Save. You can use the colored icon to determine what level of access is provided, as with other tables.

File:6696128.png


Staff and Faculty Dashboard

This is being implemented later.


Reports

This is being implemented later.


For information on purchasing the Success Plans Module, reach out to sales@go-redrock.com
For Success Plans functionality questions, reach out to helpdesk@go-redrock.com