Difference between revisions of "Test"

From InsightWiki
Jump to navigation Jump to search
 
(467 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
=Setup for Emails and SMS=
+
The snapshot page gives an overview of information about the student. Various pieces of information can be displayed or hidden on this page. <br> <br>
  
−
You should check that Insight is configured to send emails or SMS messages if you are going to send usernames or passwords using either of these methods. Follow the instructions on the '''[[communication setup]]''' page to check that Insight is configured correctly for this. You do not need to do this is you are only sending passwords in letters. <br> <br>
+
The following Role Option is needed to access the Snapshot page: <br>
 +
''General > Snapshot'' (On) <br> <br>
  
−
=Designing the Messages to be used=
+
The page is accessed via: <br>
 +
'''General > Snapshot''' <br> <br>
  
−
==Password Notification Messages==
+
The page can be renamed with the following Role Option: <br>
 +
''General > Snapshot > Alternative menu title'' <br> <br>
  
−
Next you should design the message that Insight will use to send passwords. You can design separate messages for emails, letters and SMS messages. The messages are designed via: <br>
+
=Notification bar=
−
''Manage > Preferences > Welcome letter'' (used for letters) <br>
 
−
''Manage > Preferences > Introductory message for Email'' <br>
 
−
''Manage > Preferences > Introductory message for SMS'' <br> <br>
 
  
−
Enter the message that you want Insight to use when sending passwords. SMS messages are plain-text only whereas emails and letters can include formatted text and images. <br> <br>
+
[[Image:snapshot_top_bar.png|thumb|The Notification bar of the Snapshot page showing Notices, Assignments and Surveys]]
  
−
You can also include the following mail merge fields in your message: <br> <br>
+
The bar at the top of the page will show coloured boxes if the pupil has any new '''[[notices]]''' or '''[[assignments]]''', or has been invited to take part in any '''[[surveys]]'''. Each of the boxes can be clicked on; this opens an area below the box showing the new notices/assignments/surveys. <br> <br>
  
−
{|
+
===Notices===
−
! style="width: 190px; text-align: left" | Merge Field
+
 
−
! style="width: 500px; text-align: left" | Meaning
+
The notices box can be turned on or off using the following '''[[role options|role option]]''': <br>
−
! style="text-align: left" | Data Type
+
''General > Snapshot > Notices'' <br> <br>
 +
 
 +
Clicking on the Notices section will either take the user to the '''[[Notices]]''' page, or expand the Notices box on the snapshot page to display up to 10 recent notices. This behaviour is determined by the following '''[[role options|role option]]''': <br>
 +
''General > Snapshot > Notices > Jump directly to notices screen'' <br> <br>
 +
 
 +
===Assignments===
 +
 
 +
The Assignments box can be turned on or off using the following '''[[role options|role option]]''': <br>
 +
''General > Snapshot > Assignments'' <br> <br>
 +
 
 +
Assignments created in Insight will always be shown (providing they meet the conditions below). Additionally assignments from either SIMS or PARS can be shown. If you are not a PARS user then SIMS homework will automatically be displayed. See the '''[[PARS]]''' page for information about displaying assignments from PARS. <br> <br>
 +
 
 +
Clicking on the Assignments section will either take the user to the '''[[Assignments]]''' page, or expand the Assignments box on the snapshot page to display up to 10 recent assignments. This behaviour is determined by the following '''[[role options|role option]]''': <br>
 +
''General > Snapshot > Assignments > Jump directly to assignments screen'' <br> <br>
 +
 
 +
The following '''[[roles|role options]]''' will determine whether certain Assignments are displayed or hidden in Insight: <br>
 +
{| cellpadding="5" cellspacing="0" border="1" style="border:solid 1 #CCC; border-collapse:collapse"
 +
|''General > Snapshot > Only show unfinished assignments||Assignments with a Status of Complete will be hidden
 
|-
 
|-
−
| {username} || The user's username || Credentials
+
|''General > Assignments > Earliest||Assignments created prior to this date will not be shown
 
|-
 
|-
−
| {password} || The user's password || Credentials
+
|''General > Assignments > Rolling archive in weeks||Assignments with a Due Date more than this number of weeks in the past will be hidden
 
|-
 
|-
−
| {email} || The email address of the user || Email
+
|''General > Assignments > Strip old open||Assignments with a Due Date in the past and with a Status of Pending will be hidden
 
|-
 
|-
−
| {salutation} || The user's salutation, taken from the Contact details window in SIMS || Name
+
|''General > Assignments > Strip old complete||Assignments that are Complete will only be displayed if their Due Date is in the future
 
|-
 
|-
−
| {addressee} || The user's addressee field, taken from the Contact details window in SIMS || Name
+
|''General > Assignments > Strip future||Assignments which have an Issued Date in the future will be hidden
 
|-
 
|-
−
| {fullname} || The fullname of the user || Name
+
|''General > Assignments > Include exceptions||Assignments with a Status of Exception will be displayed
 +
|} <br>
 +
 
 +
===Surveys===
 +
 
 +
The surveys box will appear if the user has been invited to take part in a survey. There is no role option to turn this off. Click on the name of a survey will open the '''[[surveys]]''' page. <br> <br>
 +
 
 +
The surveys box can be renamed with this role option: <Br>
 +
''Snapshot > Label surveys as'' <br> <br>
 +
 
 +
===Unexplained Absences===
 +
 
 +
The Unexplained Absences section will display automatically if the student has any N codes in their attendance, unless the following preference includes the student's year group: <br>
 +
''Attendance > Hide the Report Absences menu item for the following years'' <br> <br>
 +
 
 +
Each date or date range where a student has N codes will be listed. Users can click on these date ranges to access the '''[[report absences]]''' page if the following '''[[roles|role options]]''' are used: <br>
 +
''Attendance > Report absences'' (On) <br>
 +
''Attendance > Report absences > Allow reporting of historical absences'' (On) <br>
 +
''Attendance > Report absences > Maximum age of absence in days'' (absences are not older than this many days) <br> <br>
 +
 
 +
It is possible to delay attendance data from being displayed in Insight. Delayed attendance data will not be counted in the Unexplained Absences box. The following '''[[preferences]]''' are used to enable the delay in Insight: <br>
 +
''Attendance > Hide marks in attendance summaries in the validation range'' (On) <br>
 +
''Attendance > The number of days taken to validate attendance marks for attendance summaries'' <br> <br>
 +
 
 +
=Alerts=
 +
 
 +
[[Image:snapshot_alerts.png|thumb|The Alerts section of the Snapshot page, shown without and with rules used]]
 +
 
 +
The alerts bar will appear beneath the Notifications bar. There are options (described below) to turn off specific parts of the Alerts section. Alternatively the following '''[[roles|role option]]''' can be used to disable the entire Alerts section: <br>
 +
''General > Snapshot > Alerts'' <br> <br>
 +
 
 +
The Alerts bar can show information about positive and negative behaviour, attendance and exclusions. The alerts boxes will be coloured green, yellow or red based on the pupil's number of behaviour points/attendance percentage/number of exclusions. The boundaries for these colours are set in SIMS via: <br>
 +
'''Tools > Setups > Student teacher view''' <br> <br>
 +
 
 +
These boundaries can be displayed or hidden using the following role options: <br>
 +
''General > Snapshot > Alerts > showing rules used for Behaviour <br>
 +
''General > Snapshot > Alerts > showing rules used for Achievements <br>
 +
''General > Snapshot > Alerts > showing rules used for Attendance <br>
 +
''General > Snapshot > Alerts > showing rules used for Exclusions <br> <br>
 +
 
 +
Additionally, the following role option changes the colouring for exclusions so that 0 exclusions is shown as green and any other number is shown as red: <br>
 +
''General > Snapshot > Alerts > All Exclusions are unacceptable <br> <br>
 +
 
 +
===Achievements and Behaviours===
 +
 
 +
The following '''[[role options]]''' affect the information shown in the Achievements and Behaviours Alert boxes: <br>
 +
 
 +
{| cellpadding="5" cellspacing="0" border="1" style="border:solid 1 #CCC; border-collapse:collapse"
 +
|''General > Snapshot > using behaviour incidents in the range''||This is the date used to calculate the numbers shown in the Alert boxes
 
|-
 
|-
−
| {forename} || The forename of the user || Name
+
|''General > Snapshot > use points instead of events for behaviour''||The Alerts will either show the number of incidents that the student has received, or the number of points from those incidents
 +
|} <br>
 +
 
 +
The following '''[[role options]]''' also must be enabled for the user to see the Achievements and Behaviour Alert boxes: <br>
 +
{| cellpadding="5" cellspacing="0" border="1" style="border:solid 1 #CCC; border-collapse:collapse"
 +
|''Behaviour > Achievements''||This is must be On for the user to see the Achievements Alert
 
|-
 
|-
−
| {surname} || The user's surname || Name
+
|''General > Snapshot > including Achievements''||This is must be On for the user to see the Achievements Alert
 
|-
 
|-
−
| {title} || The user's title i.e. Mr or Mrs || Name
+
|''Behaviour > Behaviour''||This is must be On for the user to see the Behaviour Alert
 
|-
 
|-
−
| {honours} || The user's honours, taken from the Contact details window in SIMS || Name
+
|''General > Snapshot > including Behaviour''||This is must be On for the user to see the Behaviour Alert
−
|-
 
−
| {multilineaddress} || The address of the user || Postal Address
 
−
|-
 
−
| {housenumber} || The number of the user's house || Postal Address
 
−
|-
 
−
| {housename} || The name of the user's house || Postal Address
 
−
|-
 
−
| {street} || The street the user lives on || Postal Address
 
−
|-
 
−
| {district} || The district of the user's address || Postal Address
 
−
|-
 
−
| {town} || The town the user lives in || Postal Address
 
−
|-
 
−
| {county} || The county of the contact's address || Postal Address
 
−
|-
 
−
| {country} || The country of the contact's address || Postal Address
 
−
|-
 
−
| {postcode} || The user's postcode || Postal Address
 
−
|-
 
−
| {schooladdress} || The school's address || School Details
 
−
|-
 
−
| {schoollogo} || The school's logo (''not available in SMS messages'') || School Details
 
−
|-
 
−
| {linkedstudents} || This will show a list of students linked to the user || Student Details
 
−
|-
 
−
| {linkedstudentstable} || This will show a list of students linked to the user, presented in a table <br>(''not available in SMS messages'') || Student Details
 
−
|-
 
−
| {todaysdate} || The calendar date || Other
 
−
|-
 
−
| {pagebreak} || Start a new page (''only available in Letters'') || Other
 
 
|} <br>
 
|} <br>
  
−
==Password Resets==
+
Behaviour incidents will not be included if they were issued within the number of days set in the following '''[[preferences|preference]]''': <br>
 +
''Behaviour > The number of days taken to validate negative behaviour records'' <br> <br>
 +
 
 +
Users can be prevented from accessing the Achievements or Behaviours pages using the following '''[[preferences|preference]]''', but this will not hide the Alert boxes on the snapshot page: <br>
 +
''Behaviour > Hide behaviour menu items for the following years'' <br> <br>
 +
 
 +
===Attendance===
  
−
''Manage > Preferences > Email > Message text for password resets'' <br> <br>
+
The Attendance Alert box will show the student's percentage attendance based on sessions (AM and PM only). This can be turned off using the following '''[[role option]]''': <br>
 +
''General > Snapshot > Including attendance for years'' <br>
 +
(Setting this option as an asterisk will display the alert for all year groups. Alternatively, each year group can by type, separated by a plus symbol e.g. 7+8+9) <br> <br>
  
−
This must include: <br>
+
===Exclusions===
−
{link} = this page <br> <br>
 
  
−
{|
+
The Exclusions tab will show the number of days that a student has been excluded in exclusion in SIMS. The Exclusions alert can be turned on or off using the following role option: <br>
−
! style="width: 190px; text-align: left" | Merge Field
+
''General > Snapshot > Including Exclusion'' <br> <br>
−
! style="width: 500px; text-align: left" | Meaning
+
 
−
! style="text-align: left" | Data Type
+
=Information panels=
 +
 
 +
===Today's attendance===
 +
 
 +
[[Image:snap_today.jpg|thumb|The Today's Attendance section of the Snapshot page]]
 +
 
 +
This will show the pupil's attendance to school today. This panel can show the AM and PM registers, lesson registers, or both. <br> <br>
 +
 
 +
{{Note|Note that this panel does not take account of the [[preferences#The number of days taken to validate attendance marks for attendance summaries (-1 for current week)|validation range preference]] and will show today's attendance in real time, including registers that have not been completed.}}
 +
<br>
 +
 
 +
====Hiding attendance====
 +
 
 +
{| cellpadding="5" cellspacing="0" border="1" style="border:solid 1 #CCC; border-collapse:collapse"
 +
|''General > Snapshot > Current Attendance''||Show/Hide the entire panel
 
|-
 
|-
−
| {link} || The hyperlink that parents need to click on to reset their password || Credentials
+
|''General > Snapshot > show sessions for years''||Use * to show sessions for all years, or enter years separated by a plus symbol to display for specific years only. Use 99 (or another non-existent year) to hide for all students
 
|-
 
|-
−
| {username} || The parent's Insight username || Credentials
+
|''General > Snapshot > show lessons for years''||Use * to show lessons for all years, or enter years separated by a plus symbol to display for specific years only. Use 99 (or another non-existent year) to hide for all students
−
|-
+
|} <br>
−
| {email} || The parent's email address || Email
+
 
−
|-
+
The following '''[[preferences]]''' can also be used to hide attendance codes: <br>
−
| {salutation} || The parent's salutation || Name
+
 
−
|-
+
{| cellpadding="5" cellspacing="0" border="1" style="border:solid 1 #CCC; border-collapse:collapse"
−
| {addressee} || The parent's addressee field, as taken from SIMS || Name
+
|Attendance > Only use AM sessions||PM registers will not be displayed
−
|-
 
−
| {fullname} || The parent's full name (forename and surname) || Name
 
−
|-
 
−
| {forename} || The parent's forename || Name
 
−
|-
 
−
| {surename} || The parent's surname || Name
 
−
|-
 
−
| {title} || The user's title i.e. Mr or Mrs || Name
 
−
|-
 
−
| {schooladdress} || Your school's address || School Details
 
 
|-
 
|-
−
| {todaysdate} || The calendar date || Other
+
|Lesson marks > Hide all references to lesson marks||All lesson marks will be hidden
 
|} <br>
 
|} <br>
  
−
==Password Reminders==
+
Additionally the settings in SIMS affect whether or not AM and PM registers are shown. The settings in SIMS are found via: <br>
 +
''Tools > Setups > Attendance Setup > Registration Organisation'' <br>
 +
(If Lesson Groups AM/PM are selected, the corresponding AM/PM register will be hidden from the Today's Attendance section in Insight) <br> <br>
  
−
''Manage > Preferences > Email > Forgotten password message for Email <br>
+
====Hiding Information====
−
''Manage > Preferences > SMS > Forgotten password message for SMS <br> <br>
 
  
−
If the following setting is turned On then Insight will only send an SMS to the user if they do not have an email address. If the setting is Off then Insight will send both an email and an SMS: <br>
+
The rooms, times of lessons and student's attendance to each lesson can be displayed or hidden using the following role options: <br>
−
''Manage > Preferences > Login > Prefer email when sending password reminders'' <br> <br>
 
  
−
{|
+
{| cellpadding="5" cellspacing="0" border="1" style="border:solid 1 #CCC; border-collapse:collapse"
−
! style="width: 190px; text-align: left" | Merge Field
+
|''General > Snapshot > show Rooms''||Show the room in which each lesson or session is taking place
−
! style="width: 500px; text-align: left" | Meaning
 
−
! style="text-align: left" | Data Type
 
 
|-
 
|-
−
| {username} || The user's username || Credentials
+
|''General > Snapshot > show times''||Show the start and end time of each lesson and session
 
|-
 
|-
−
| {password} || The user's password || Credentials
+
|''General > Snapshot > show attendance symbols||Show the student's attendance to each lesson or session
 +
|} <br>
 +
 
 +
If you are showing students' attendance, the following symbols will be used: <br>
 +
{| cellpadding="5" cellspacing="0" border="1" style="border:solid 1 #CCC; border-collapse:collapse"
 +
|[[Image:snap_pres.png]]||Present
 
|-
 
|-
−
| {email} || The email address of the user || Email
+
|[[Image:snap_absent.png]]||Absent
 
|-
 
|-
−
| {salutation} || The user's salutation, taken from the Contact details window in SIMS || Name
+
|[[Image:snap_late.png]]||Late
 
|-
 
|-
−
| {addressee} || The user's addressee field, taken from the Contact details window in SIMS || Name
+
|[[Image:snap_nomark.png]]||Register not taken
 
|-
 
|-
−
| {fullname} || The fullname of the user || Name
+
|[[Image:snap_future.png]]||Register in the future
−
|-
 
−
| {forename} || The forename of the user || Name
 
−
|-
 
−
| {surname} || The user's surname || Name
 
−
|-
 
−
| {title} || The user's title i.e. Mr or Mrs || Name
 
−
|-
 
−
| {honours} || The user's honours, taken from the Contact details window in SIMS || Name
 
−
|-
 
−
| {multilineaddress} || The address of the user || Postal Address
 
−
|-
 
−
| {housenumber} || The number of the user's house || Postal Address
 
−
|-
 
−
| {housename} || The name of the user's house || Postal Address
 
−
|-
 
−
| {street} || The street the user lives on || Postal Address
 
−
|-
 
−
| {district} || The district of the user's address || Postal Address
 
−
|-
 
−
| {town} || The town the user lives in || Postal Address
 
−
|-
 
−
| {county} || The county of the contact's address || Postal Address
 
−
|-
 
−
| {country} || The country of the contact's address || Postal Address
 
−
|-
 
−
| {postcode} || The user's postcode || Postal Address
 
−
|-
 
−
| {schooladdress} || The school's address || School Details
 
−
|-
 
−
| {schoollogo} || The school's logo (''not available in SMS messages'') || School Details
 
−
|-
 
−
| {todaysdate} || The calendar date || Other
 
 
|} <br>
 
|} <br>
  
−
==Match==
+
If attendance symbols are being displayed then you can also allow users to hover over the attendance symbols to see the student's actual attendance code using this role option: <br>
 +
Snapshot > show hover over descriptions <br> <br>
 +
 
 +
===Cumulative Attendance===
 +
 
 +
The Cumulative Attendance section shows a student's attendance as a line chart over the course of the academic year. This chart can be turned on for students in selected year groups using the following role option: <br>
 +
Snapshot > Cumulative attendance <br> <br>
 +
 
 +
This chart is affected by the following preference, which determines whether or not PM marks are counted for the student: <br>
 +
Attendance > Only use AM sessions <br> <br>
 +
 
 +
===Cumulative Behaviours===
 +
 
 +
The Cumulative Behaviour chart will show a running total of the student's negative behaviour over the course of the academic year. This chart can be turned on or off using the following role option: <br>
 +
''Snapshot > Cumulative behaviour'' <br> <br>
 +
 
 +
The following preference will cause the chart to show no data: <br>
 +
''Behaviour > Hide behaviour menu items for the following years'' <br> <br>
 +
 
 +
This role option will hide behaviour incidents issued prior to a certain date: <br>
 +
''Behaviour > Behaviour > Earliest'' <br> <br>
 +
 
 +
The following preference sets a validation period in days. During this period, behaviour incidents added will not be visible in Insight, including on the Cumulative Behaviour chart: <br>
 +
''Behaviour > The number of days taken to validate negative behaviour records'' <Br> <br>
 +
 
 +
If the following role option is enabled then behaviour incidents with a points value of zero will be hidden from the chart: <br>
 +
''Behaviour > Hide zero point items'' <br> <br>
 +
 
 +
===Cumulative Achievements===
 +
 
 +
The Cumulative Achievements chart will show a running total of the student's positive behaviour over the course of the academic year. This chart can be turned on or off using the following role option: <br>
 +
''General > Snapshot > Cumulative achievements '' <br> <br>
 +
 
 +
The following preference will cause the chart to show no data: <br>
 +
''Behaviour > Hide behaviour menu items for the following years'' <br> <br>
 +
 
 +
This role option will hide achievements issued prior to a certain date: <br>
 +
''Behaviour > Achievements > Earliest'' <br> <br>
 +
 
 +
If the following role option is enabled then behaviour incidents with a points value of zero will be hidden from the chart: <br>
 +
''Behaviour > Hide zero point items'' <br> <br>
 +
 
 +
===Recent behaviours===
 +
 
 +
The recent behaviour panel will show the three most recent behaviour incidents for the student. These could be positive or negative. Positive incidents will be displayed if the [[Achievements]] role option is turned on and negatives will show if the [[Behaviours]] role option is turned on. <br> <br>
 +
 
 +
The Recent Behaviour panel will show the three most recent behaviour incidents for the student. These could be positive or negative. The Recent Behaviour panel can be turned off using the following '''[[role option]]''' which will also remove the [[#Behaviour Summary|Behaviour Summary]] section from the Snapshot page. <br>
 +
General > Snapshot > Behaviour <br> <br>
 +
 
 +
The panel can also be renamed using the following role option: <br>
 +
''General > Snapshot > Use this title'' <br> <br>
 +
 
 +
Behaviour incidents will only be shown in the Recent Behaviours panel if they could also be shown on the '''[[Achievements]]''' or '''[[Behaviours]]''' pages in Insight. Therefore you can use the role options and preferences for Achievements and Behaviours to hide bheaviour incidents from the Recent Behaviours panel. <br> <br>
 +
 
 +
There is a preference to hide behaviour menu items for students in selected year groups. This preference also applies to the Recent Behaviours panel: <br>
 +
Behaviour > Hide behaviour menu items for the following years'' <br> <br>
 +
 
 +
===Detentions===
 +
 
 +
The detentions panel shows the three most recent detentions for the pupil. If any detentions are scheduled for the future they will take priority over detentions that have already passed. The '''[[role options|role option]]''' to enable this panel is found via: <br>
 +
''General > Snapshot > Detentions'' <br> <br>
 +
 
 +
Detentions earlier than the date set here will not be shown: <br>
 +
''Behaviour > Detentions > Earliest'' <Br> <br>
 +
 
 +
===Extra curricular===
 +
 
 +
The Extra Curricular panel shows the three most recent extra classes for the pupil. If any extra classes are scheduled for the future they will take priority over extra classes that have already passed. The '''[[role options|role option]]''' to enable this panel is found via: <br>
 +
''General > Snapshot > Extra Curricular'' <br> <br>
 +
 
 +
Detentions earlier than the date set here will not be shown: <br>
 +
''Attendance > Extra Curriculum > Earliest'' <Br> <br>
 +
 
 +
===Recent reports===
  
−
=Password Notification=
+
The reports panel will display any documents that have been recently added. The documents are pulled from the Linked Documents section in SIMS. This panel is enabled using the following '''[[role option]]''': <br>
 +
''General > Snapshot > Recent reports'' <br> <br>
  
−
The password notification feature is used to distribute usernames and passwords to users. This information can be send by email, SMS or postal mail. You can also download <br> <br>
+
Documents will only be displayed if the '''Last modified date''' from SIMS is within the number of days set in this '''[[role option]]''': <br>
 +
''General > Snapshot > Maximum age in days'' <br> <br>
  
−
==Filters==
+
Documents will only be displayed on the Snapshot page if they are also displayed in the '''[[subjects]]''' section of Insight. See the Subjects page for a list of role options and settings that determine whether or not documents are displayed. <br> <br>
  
−
You can filter the list of users if required, so that messages are only sent to parents of pupils in specific year groups or registration groups. You will need to use the sorting column to do this. <br> <br>
+
===This Term's Attendance===
  
−
The sorting column shows information about the pupils that the user is linked to. There will be a string of text for each pupil that the account is linked to, separated by a comma for each pupil. The first two characters are always 0. The next two characters are the pupil's year group and the final two characters are the pupil's registration group. For example, if a parent has a year 9 pupil in reg group 7F, the sorting string will read: 00077F. You can use this to find all of the parents of specific pupils. For example if you type 0009 into the sorting column filter, the page will show you all of the users linked to year 9 pupils. <br> <br>
+
This Term's Attendance is chart which shows the student's attendance to each week at school. Attendance is shown week-by-week, so if a pupil is absent for a week their attendance will drop down to 0 on the graph, for that week. The chart can be turned on or off using the following role option: <br>
 +
Snapshot > This term's attendance <br> <br>
  
−
==Sending Passwords==
+
During the first week of a new term, this chart will be blank. This is because Insight needs at least two data points before it can draw a line. You should have data showing from the second week of term onwards. <br> <br>
  
−
Once you are happy with the message that is going to be sent, you need to select the users to whom you are going to send the passwords. Use the buttons at the bottom of the page to display all users on one page.  
+
===Custom Panels (snapshot.bolton.xml)===
  
−
<div>[[Image:sorting_filter1.jpg]]</div> <br> <br>
+
You can also add custom panels to the Snapshot page. Each custom item needs to be created as a html page and saved in the _Personalisation folder. Once an item has been created, create a bolton file. You can have several bolton files. The filename will always be "snapshot_" followed by a distinct number e.g. snapshot_1.bolton snapshot_2.bolton etc.
  
−
Next select the users to whom you want to send the passwords. The checkbox at the top left will select all of the users shown on the page. Click the notify button at the top right to send your messages and/or generate your letters. Note that emails and SMS messages can only be sent if the [[preferences]] have been configured correctly. <br> <br>
+
The bolton files need to be in the following format: <br> <br>
  
−
If you have generated letters then a window will appear with multiple links. You should download each of the Users Documents files, as each is a document containing several letters to send to users. <br> <br>
+
<root>
 +
<title>Guidance</title>
 +
<url>https://[your Insight URL]/_Personalisation/example.html</url>
 +
<height>50</height>
 +
</root>
  
−
==Downloading Data for Mail Merge==
+
{{Note|Replace [your Insight address] with the URL you use for Insight}}
  
−
==Why do people not appear==
+
The title will be shown on the snapshot page about the new item. The "example" part of the URL should be replaced with the name of the html file in the _Personalisation folder and the height is the number of pixels tall that the item will be. Items are always 300px wide. <br> <br>
  
−
A user will not be eligible if their account is deactivated or if they have changed their password. If a user has changed their password and forgotten it, they can either request a password reminder via the login page or their password can be reset manually via the [[users]] page. Once a user's password has been manually reset, they will appear on the password notification page (as long as their account is also activated). <br> <br>
+
Multiple snapshot.bolton files can be used by creating a new file and adding a number to the end of "snapshot" e.g. snapshot1.bolton.xml <br> <br>
  
−
=Resetting Passwords on Behalf of Users=
+
=Behaviour Summary=
  
−
Admin users in Insight can reset passwords for users. Note that this cannot be done for accounts linked to the Active Directory, or for SIMS-linked staff accounts. <br> <br>
+
[[Image:snap_behaviour_summary.jpg|thumb|The Snapshot Behaviour Summary]]
  
−
See the '''[[User management#Resetting Passwords|User Management]]''' page for instructions to reset a user's password. <br> <br>
+
The following '''[[role option]]''' must be enabled to show the Behaviour Summary section. This role option will also enable the '''[[#recent behaviours|Recent Behaviours]]''' section of the snapshot page: <br>
 +
''General > Snapshot > Behaviour'' <br> <br>
  
−
=Users Resetting their Own Passwords=
+
There are sections for positive and negative behaviour within the Behaviour Summary section. Each can be turned on or off independently using the following '''[[role options]]''': <br>
 +
''General > Snapshot > Showing Achievements summary'' <br>
 +
''General > Snapshot > Showing Behaviour summary'' <br> <br>
  
−
When a user has forgotten their password, they will usually need to reset it to a new random password. Then the user will receive a password reminder which tells them what their new password is. If the user has a randomly generated password (either the password given to them when their account was created, or when their password was reset by an administrator) then they will not need to reset the password and will go straight to the password reminder. <br> <br>
+
The Behaviour Summary will show behaviour incidents from the range specified in this role option: <br>
 +
''General > Snapshot > Using incidents in the range'' <br> <br>
  
−
For a user to reset their password they must have an email address in Insight. They will then receive an email containing the password reset message (see the '''[[#Password Resets|password resets]]''' section of this page to configure this message). <br> <br>
+
A Cash-In section may also be shown, which will display the number of points that the student has spent on rewards, and the number of points currently available for them to spend. This feature is only available to '''[[PARS]]''' users. See the '''[[Cash In]]''' and '''[[PARS]]''' pages for more information. <br> <br>
  
−
Once the user's password has been reset, they will receive a '''password reminder''' message which will contain the new password. This message can be sent as either an email, SMS or both. (see the '''[[#Password Reminders|password reminders]]''' section of this page to configure this message). <br> <br>
+
By default the Behaviour Summary section will show data based on the number of incidents given to a student. This can be changed to show the number of behaviour points from those incidents, using the following '''[[role option]]''': <br>
 +
''General > Snapshot > Use points instead of events for behaviour'' <br> <br>
  
−
''NOTE: Email addresses are taken from the user's account in Insight. The user's mobile telephone number for SMS messages is taken from SIMS.'' <br> <br>
+
There is a preference to hide behaviour menu items for students in selected year groups. This preference can also apply to the Behaviour Summary section of the Snapshot page. The preference is found via: <br>
 +
''Behaviour > Hide behaviour menu items for the following years''
 +
In order for this preference to affect the Behaviour Summary section, the following '''[[role option]]''' must also be enabled: <br>
 +
''General > Snapshot > Follow Hide behaviour menu preference'' <br> <br>
  
−
=Password Strength=
+
Negative behaviour incidents will not be shown if this preference is used to hide them: <br>
 +
''Behaviour > The number of days taken to validate negative behaviour records'' <br> <br>
  
−
Manage > Prefs > Login > Minimum password length <br>
+
The Behaviour Summary section will not take account of any incidents that have been hidden from the '''[[Achievements]]''' or '''[[Behaviours]]''' pages, which both have their own role options that can cause incidents to be hidden. <br> <br>
−
Manage > Prefs > Login > Minimum upper case characters <br>
 
−
Manage > Prefs > Login > Minimum numeric characters <br>
 
−
Manage > Prefs > Login > Minimum symbol characters <br>
 

Latest revision as of 10:23, 11 April 2019

The snapshot page gives an overview of information about the student. Various pieces of information can be displayed or hidden on this page.

The following Role Option is needed to access the Snapshot page:
General > Snapshot (On)

The page is accessed via:
General > Snapshot

The page can be renamed with the following Role Option:
General > Snapshot > Alternative menu title

Notification bar

The Notification bar of the Snapshot page showing Notices, Assignments and Surveys

The bar at the top of the page will show coloured boxes if the pupil has any new notices or assignments, or has been invited to take part in any surveys. Each of the boxes can be clicked on; this opens an area below the box showing the new notices/assignments/surveys.

Notices

The notices box can be turned on or off using the following role option:
General > Snapshot > Notices

Clicking on the Notices section will either take the user to the Notices page, or expand the Notices box on the snapshot page to display up to 10 recent notices. This behaviour is determined by the following role option:
General > Snapshot > Notices > Jump directly to notices screen

Assignments

The Assignments box can be turned on or off using the following role option:
General > Snapshot > Assignments

Assignments created in Insight will always be shown (providing they meet the conditions below). Additionally assignments from either SIMS or PARS can be shown. If you are not a PARS user then SIMS homework will automatically be displayed. See the PARS page for information about displaying assignments from PARS.

Clicking on the Assignments section will either take the user to the Assignments page, or expand the Assignments box on the snapshot page to display up to 10 recent assignments. This behaviour is determined by the following role option:
General > Snapshot > Assignments > Jump directly to assignments screen

The following role options will determine whether certain Assignments are displayed or hidden in Insight:

General > Snapshot > Only show unfinished assignments Assignments with a Status of Complete will be hidden
General > Assignments > Earliest Assignments created prior to this date will not be shown
General > Assignments > Rolling archive in weeks Assignments with a Due Date more than this number of weeks in the past will be hidden
General > Assignments > Strip old open Assignments with a Due Date in the past and with a Status of Pending will be hidden
General > Assignments > Strip old complete Assignments that are Complete will only be displayed if their Due Date is in the future
General > Assignments > Strip future Assignments which have an Issued Date in the future will be hidden
General > Assignments > Include exceptions Assignments with a Status of Exception will be displayed


Surveys

The surveys box will appear if the user has been invited to take part in a survey. There is no role option to turn this off. Click on the name of a survey will open the surveys page.

The surveys box can be renamed with this role option:
Snapshot > Label surveys as

Unexplained Absences

The Unexplained Absences section will display automatically if the student has any N codes in their attendance, unless the following preference includes the student's year group:
Attendance > Hide the Report Absences menu item for the following years

Each date or date range where a student has N codes will be listed. Users can click on these date ranges to access the report absences page if the following role options are used:
Attendance > Report absences (On)
Attendance > Report absences > Allow reporting of historical absences (On)
Attendance > Report absences > Maximum age of absence in days (absences are not older than this many days)

It is possible to delay attendance data from being displayed in Insight. Delayed attendance data will not be counted in the Unexplained Absences box. The following preferences are used to enable the delay in Insight:
Attendance > Hide marks in attendance summaries in the validation range (On)
Attendance > The number of days taken to validate attendance marks for attendance summaries

Alerts

The Alerts section of the Snapshot page, shown without and with rules used

The alerts bar will appear beneath the Notifications bar. There are options (described below) to turn off specific parts of the Alerts section. Alternatively the following role option can be used to disable the entire Alerts section:
General > Snapshot > Alerts

The Alerts bar can show information about positive and negative behaviour, attendance and exclusions. The alerts boxes will be coloured green, yellow or red based on the pupil's number of behaviour points/attendance percentage/number of exclusions. The boundaries for these colours are set in SIMS via:
Tools > Setups > Student teacher view

These boundaries can be displayed or hidden using the following role options:
General > Snapshot > Alerts > showing rules used for Behaviour
General > Snapshot > Alerts > showing rules used for Achievements
General > Snapshot > Alerts > showing rules used for Attendance
General > Snapshot > Alerts > showing rules used for Exclusions

Additionally, the following role option changes the colouring for exclusions so that 0 exclusions is shown as green and any other number is shown as red:
General > Snapshot > Alerts > All Exclusions are unacceptable

Achievements and Behaviours

The following role options affect the information shown in the Achievements and Behaviours Alert boxes:

General > Snapshot > using behaviour incidents in the range This is the date used to calculate the numbers shown in the Alert boxes
General > Snapshot > use points instead of events for behaviour The Alerts will either show the number of incidents that the student has received, or the number of points from those incidents


The following role options also must be enabled for the user to see the Achievements and Behaviour Alert boxes:

Behaviour > Achievements This is must be On for the user to see the Achievements Alert
General > Snapshot > including Achievements This is must be On for the user to see the Achievements Alert
Behaviour > Behaviour This is must be On for the user to see the Behaviour Alert
General > Snapshot > including Behaviour This is must be On for the user to see the Behaviour Alert


Behaviour incidents will not be included if they were issued within the number of days set in the following preference:
Behaviour > The number of days taken to validate negative behaviour records

Users can be prevented from accessing the Achievements or Behaviours pages using the following preference, but this will not hide the Alert boxes on the snapshot page:
Behaviour > Hide behaviour menu items for the following years

Attendance

The Attendance Alert box will show the student's percentage attendance based on sessions (AM and PM only). This can be turned off using the following role option:
General > Snapshot > Including attendance for years
(Setting this option as an asterisk will display the alert for all year groups. Alternatively, each year group can by type, separated by a plus symbol e.g. 7+8+9)

Exclusions

The Exclusions tab will show the number of days that a student has been excluded in exclusion in SIMS. The Exclusions alert can be turned on or off using the following role option:
General > Snapshot > Including Exclusion

Information panels

Today's attendance

The Today's Attendance section of the Snapshot page

This will show the pupil's attendance to school today. This panel can show the AM and PM registers, lesson registers, or both.

iNote that this panel does not take account of the validation range preference and will show today's attendance in real time, including registers that have not been completed.


Hiding attendance

General > Snapshot > Current Attendance Show/Hide the entire panel
General > Snapshot > show sessions for years Use * to show sessions for all years, or enter years separated by a plus symbol to display for specific years only. Use 99 (or another non-existent year) to hide for all students
General > Snapshot > show lessons for years Use * to show lessons for all years, or enter years separated by a plus symbol to display for specific years only. Use 99 (or another non-existent year) to hide for all students


The following preferences can also be used to hide attendance codes:

Attendance > Only use AM sessions PM registers will not be displayed
Lesson marks > Hide all references to lesson marks All lesson marks will be hidden


Additionally the settings in SIMS affect whether or not AM and PM registers are shown. The settings in SIMS are found via:
Tools > Setups > Attendance Setup > Registration Organisation
(If Lesson Groups AM/PM are selected, the corresponding AM/PM register will be hidden from the Today's Attendance section in Insight)

Hiding Information

The rooms, times of lessons and student's attendance to each lesson can be displayed or hidden using the following role options:

General > Snapshot > show Rooms Show the room in which each lesson or session is taking place
General > Snapshot > show times Show the start and end time of each lesson and session
General > Snapshot > show attendance symbols Show the student's attendance to each lesson or session


If you are showing students' attendance, the following symbols will be used:

Snap pres.png Present
Snap absent.png Absent
Snap late.png Late
Snap nomark.png Register not taken
Snap future.png Register in the future


If attendance symbols are being displayed then you can also allow users to hover over the attendance symbols to see the student's actual attendance code using this role option:
Snapshot > show hover over descriptions

Cumulative Attendance

The Cumulative Attendance section shows a student's attendance as a line chart over the course of the academic year. This chart can be turned on for students in selected year groups using the following role option:
Snapshot > Cumulative attendance

This chart is affected by the following preference, which determines whether or not PM marks are counted for the student:
Attendance > Only use AM sessions

Cumulative Behaviours

The Cumulative Behaviour chart will show a running total of the student's negative behaviour over the course of the academic year. This chart can be turned on or off using the following role option:
Snapshot > Cumulative behaviour

The following preference will cause the chart to show no data:
Behaviour > Hide behaviour menu items for the following years

This role option will hide behaviour incidents issued prior to a certain date:
Behaviour > Behaviour > Earliest

The following preference sets a validation period in days. During this period, behaviour incidents added will not be visible in Insight, including on the Cumulative Behaviour chart:
Behaviour > The number of days taken to validate negative behaviour records

If the following role option is enabled then behaviour incidents with a points value of zero will be hidden from the chart:
Behaviour > Hide zero point items

Cumulative Achievements

The Cumulative Achievements chart will show a running total of the student's positive behaviour over the course of the academic year. This chart can be turned on or off using the following role option:
General > Snapshot > Cumulative achievements

The following preference will cause the chart to show no data:
Behaviour > Hide behaviour menu items for the following years

This role option will hide achievements issued prior to a certain date:
Behaviour > Achievements > Earliest

If the following role option is enabled then behaviour incidents with a points value of zero will be hidden from the chart:
Behaviour > Hide zero point items

Recent behaviours

The recent behaviour panel will show the three most recent behaviour incidents for the student. These could be positive or negative. Positive incidents will be displayed if the Achievements role option is turned on and negatives will show if the Behaviours role option is turned on.

The Recent Behaviour panel will show the three most recent behaviour incidents for the student. These could be positive or negative. The Recent Behaviour panel can be turned off using the following role option which will also remove the Behaviour Summary section from the Snapshot page.
General > Snapshot > Behaviour

The panel can also be renamed using the following role option:
General > Snapshot > Use this title

Behaviour incidents will only be shown in the Recent Behaviours panel if they could also be shown on the Achievements or Behaviours pages in Insight. Therefore you can use the role options and preferences for Achievements and Behaviours to hide bheaviour incidents from the Recent Behaviours panel.

There is a preference to hide behaviour menu items for students in selected year groups. This preference also applies to the Recent Behaviours panel:
Behaviour > Hide behaviour menu items for the following years

Detentions

The detentions panel shows the three most recent detentions for the pupil. If any detentions are scheduled for the future they will take priority over detentions that have already passed. The role option to enable this panel is found via:
General > Snapshot > Detentions

Detentions earlier than the date set here will not be shown:
Behaviour > Detentions > Earliest

Extra curricular

The Extra Curricular panel shows the three most recent extra classes for the pupil. If any extra classes are scheduled for the future they will take priority over extra classes that have already passed. The role option to enable this panel is found via:
General > Snapshot > Extra Curricular

Detentions earlier than the date set here will not be shown:
Attendance > Extra Curriculum > Earliest

Recent reports

The reports panel will display any documents that have been recently added. The documents are pulled from the Linked Documents section in SIMS. This panel is enabled using the following role option:
General > Snapshot > Recent reports

Documents will only be displayed if the Last modified date from SIMS is within the number of days set in this role option:
General > Snapshot > Maximum age in days

Documents will only be displayed on the Snapshot page if they are also displayed in the subjects section of Insight. See the Subjects page for a list of role options and settings that determine whether or not documents are displayed.

This Term's Attendance

This Term's Attendance is chart which shows the student's attendance to each week at school. Attendance is shown week-by-week, so if a pupil is absent for a week their attendance will drop down to 0 on the graph, for that week. The chart can be turned on or off using the following role option:
Snapshot > This term's attendance

During the first week of a new term, this chart will be blank. This is because Insight needs at least two data points before it can draw a line. You should have data showing from the second week of term onwards.

Custom Panels (snapshot.bolton.xml)

You can also add custom panels to the Snapshot page. Each custom item needs to be created as a html page and saved in the _Personalisation folder. Once an item has been created, create a bolton file. You can have several bolton files. The filename will always be "snapshot_" followed by a distinct number e.g. snapshot_1.bolton snapshot_2.bolton etc.

The bolton files need to be in the following format: 

<root>
<title>Guidance</title>
<url>https://[your Insight URL]/_Personalisation/example.html</url>
<height>50</height>
</root>
iReplace [your Insight address] with the URL you use for Insight

The title will be shown on the snapshot page about the new item. The "example" part of the URL should be replaced with the name of the html file in the _Personalisation folder and the height is the number of pixels tall that the item will be. Items are always 300px wide.

Multiple snapshot.bolton files can be used by creating a new file and adding a number to the end of "snapshot" e.g. snapshot1.bolton.xml

Behaviour Summary

The Snapshot Behaviour Summary

The following role option must be enabled to show the Behaviour Summary section. This role option will also enable the Recent Behaviours section of the snapshot page:
General > Snapshot > Behaviour

There are sections for positive and negative behaviour within the Behaviour Summary section. Each can be turned on or off independently using the following role options:
General > Snapshot > Showing Achievements summary
General > Snapshot > Showing Behaviour summary

The Behaviour Summary will show behaviour incidents from the range specified in this role option:
General > Snapshot > Using incidents in the range

A Cash-In section may also be shown, which will display the number of points that the student has spent on rewards, and the number of points currently available for them to spend. This feature is only available to PARS users. See the Cash In and PARS pages for more information.

By default the Behaviour Summary section will show data based on the number of incidents given to a student. This can be changed to show the number of behaviour points from those incidents, using the following role option:
General > Snapshot > Use points instead of events for behaviour

There is a preference to hide behaviour menu items for students in selected year groups. This preference can also apply to the Behaviour Summary section of the Snapshot page. The preference is found via:
Behaviour > Hide behaviour menu items for the following years In order for this preference to affect the Behaviour Summary section, the following role option must also be enabled:
General > Snapshot > Follow Hide behaviour menu preference

Negative behaviour incidents will not be shown if this preference is used to hide them:
Behaviour > The number of days taken to validate negative behaviour records

The Behaviour Summary section will not take account of any incidents that have been hidden from the Achievements or Behaviours pages, which both have their own role options that can cause incidents to be hidden.

Retrieved from "https://www.tascsoftware.co.uk/wiki/INSIGHT/index.php?title=Test&oldid=6299"