Difference between revisions of "Test"

From InsightWiki
Jump to navigation Jump to search
 
(229 intermediate revisions by the same user not shown)
Line 1: Line 1:
Notices are Insight messages. Some notices are generated automatically by Insight and others can be composed via the Notice Composer and sent to parents and students. <br> <br>
+
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>
  
=Notice Composer=
+
The following Role Option is needed to access the Snapshot page: <br>
 +
''General > Snapshot'' (On) <br> <br>
  
==Creating a Notice==
+
The page is accessed via: <br>
 +
'''General > Snapshot''' <br> <br>
  
Notices can be created in Insight using the Notice Composer. The Role Option required to access this is: <br>
+
The page can be renamed with the following Role Option: <br>
''Manage > Notice Composer'' (On) <br> <br>
+
''General > Snapshot > Alternative menu title'' <br> <br>
  
The Notice Composer is accessed via: <br>
+
=Notification bar=
'''Manage > Notice Composer''' <br> <br>
 
  
Click '''Add''' to open a window where you can create a notice. Enter the '''Date''' for the notice. The date given to a notice does not affect the time that it is sent; notices, emails and SMS messages are always 'sent' immediately. The Notice will appear on the Notices page for students and parents under the selected date, but will be visible as soon as you save the Notice. <br> <br>
+
[[Image:snapshot_top_bar.png|thumb|The Notification bar of the Snapshot page showing Notices, Assignments and Surveys]]
  
The '''Expiry Date''' will cause the notice to disappear from users' inboxes on a certain date. Enter a '''Subject''' and a '''Body''' for the Notice. A list of mail merge fields can be found '''[[#Mail merge fields|below]]''', which can be used in the '''Body''' of the Notice. Use the '''Attachments''' tab at the top of the page to add attachments to the Notice. <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>
  
==Selecting Recipients==
+
===Notices===
  
Recipients for notices are selected using the '''Recipients''' tab. The '''Add''' button on the right of the page is used to select students. The notice will be sent to all Insight accounts linked to that student, which includes both parental accounts and the Insight account of the student. <br> <br>
+
The notices box can be turned on or off using the following '''[[role options|role option]]''': <br>
 +
''General > Snapshot > Notices'' <br> <br>
  
If the user has the following Role Option then they will always see a list of all academic classes when selecting recipients: <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>
''Manage > Notice Composer > Show All Subjects And Classes'' (On) <br> <br>
+
''General > Snapshot > Notices > Jump directly to notices screen'' <br> <br>
  
Otherwise the user will onlly see classes that they teach, when viewing academic classes. In this case there will be an option on the right of the page (before clicking the '''Add''' button) called '''Show All Classes''' which can be used to reveal all academic classes  in the Recipients window. <br> <br>
+
===Assignments===
  
==Email and SMS==
+
The Assignments box can be turned on or off using the following '''[[role options|role option]]''': <br>
 +
''General > Snapshot > Assignments'' <br> <br>
  
Notices sent using the notice composer can also be copied as emails and SMS messages. Insight requires some configuration before either of these types of messages can be sent. See the '''[[Communication setup]]''' page for further information about this. <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>
  
{{Add|Defer until & Hide notice}}
+
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>
  
===SMS===
+
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
 +
|-
 +
|''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
 +
|} <br>
  
A copy of the notice can be sent to parents' mobile telephone numbers using the '''SMS parents''' option when composing a notice. This option will only appear if the user has the following role option: <br>
+
===Surveys===
''Manage > Notice Composer > Allow SMS'' (On) <br> <br>
 
  
{{Add|Limit to one per address}}
+
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>
  
===Email===
+
The surveys box can be renamed with this role option: <Br>
 +
''Snapshot > Label surveys as'' <br> <br>
  
Copies of notices can also be sent as emails to either students or to parents, using the '''Email Students''' and '''Email Parents''' options. There are no role options to disable these settings, however both can be enabled by default using the following Role Option: <br>
+
===Unexplained Absences===
''Manage > Notice Composer > Email by default'' (On) <br> <br>
 
  
By default, emails from the Notice Composer will be sent from the email address specified in this preference: <br>
+
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>
''Manage > Preferences > Email > Your Reply To email address'' <br>
+
''Attendance > Hide the Report Absences menu item for the following years'' <br> <br>
The email address of the staff member that sent the notice can also be added (resulting in both email addresses receiving replies from students/parents) if the staff member has the following Role Option enabled: <br>
 
''Manage > Notice Composer > Use Individual Reply Address'' <br> <br>
 
  
===Private Response===
+
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>
  
The '''Allow Private Response''' option adds a '''Reply''' button to the notice which students and parents can use. Replies are always sent via email. <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>
Replies will always be sent to the email address listed in this preference, if one has been added: <br>
+
''Attendance > Hide marks in attendance summaries in the validation range'' (On) <br>
''Manage > Preferences > Email > Redirect all "contact" emails to this address'' <br>
+
''Attendance > The number of days taken to validate attendance marks for attendance summaries'' <br> <br>
Otherwise replies will be sent to the email address listed in this preference: <br>
+
 
''Manage > Preferences > Email > Your Reply To email address'' <br>
+
=Alerts=
{{Note|The Reply button will be hidden from parents if the '''Dynamic Parental''' role does not have the '''Contact staff''' option enabled.}}
+
 
<br>
+
[[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>
  
===BCC to Staff===
+
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>
  
The notice can also be BCC'd to staff if required, using the '''CC Staff''' tab. Every staff member with an Insight account will be listed. A blind copy of the notice can be sent to each staff member by either email or SMS, providing their Insight account has an email address/mobile telephone number associated to it. <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>
  
The user composing the notice will only be able to send BCCs via SMS if they have the following Role Option enabled: <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>
''Manage > Notice Composer > Allow SMS'' (On) <br> <br>
+
''General > Snapshot > Alerts > All Exclusions are unacceptable <br> <br>
  
==Mail Merge Fields==
+
===Achievements and Behaviours===
  
Mail merge fields can be used in notices sent from Insight. Simply type any of the merge fields below to pull data into your notices:
+
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"
 
{| cellpadding="5" cellspacing="0" border="1" style="border:solid 1 #CCC; border-collapse:collapse"
! Mailmerge field !! Ouput
+
|''General > Snapshot > using behaviour incidents in the range''||This is the date used to calculate the numbers shown in the Alert boxes
 
|-
 
|-
| {adno} || Admission Number
+
|''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
 
|-
 
|-
| {onroll} || Whether the pupil is on roll or not
+
|''General > Snapshot > including Achievements''||This is must be On for the user to see the Achievements Alert
 
|-
 
|-
| {name} || The pupil's fullname i.e. John Smith
+
|''Behaviour > Behaviour''||This is must be On for the user to see the Behaviour Alert
 
|-
 
|-
| {listname} || The pupil's surname followed by forename i.e. Smith, John
+
|''General > Snapshot > including Behaviour''||This is must be On for the user to see the Behaviour Alert
 +
|} <br>
 +
 
 +
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===
 +
 
 +
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>
 +
 
 +
===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: <br>
 +
''General > Snapshot > Including Exclusion'' <br> <br>
 +
 
 +
=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
 
|-
 
|-
| {gender} || The pupil's gender
+
|''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
 
|-
 
|-
| {year} || The year group the pupil belongs to
+
|''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>
 +
 
 +
The following '''[[preferences]]''' can also be used to hide attendance codes: <br>
 +
 
 +
{| cellpadding="5" cellspacing="0" border="1" style="border:solid 1 #CCC; border-collapse:collapse"
 +
|Attendance > Only use AM sessions||PM registers will not be displayed
 
|-
 
|-
| {reg} || The registration group the pupil belongs to
+
|Lesson marks > Hide all references to lesson marks||All lesson marks will be hidden
 +
|} <br>
 +
 
 +
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>
 +
 
 +
====Hiding Information====
 +
 
 +
The rooms, times of lessons and student's attendance to each lesson can be displayed or hidden using the following role options: <br>
 +
 
 +
{| cellpadding="5" cellspacing="0" border="1" style="border:solid 1 #CCC; border-collapse:collapse"
 +
|''General > Snapshot > show Rooms''||Show the room in which each lesson or session is taking place
 
|-
 
|-
| {forename} || The pupil's legal forename
+
|''General > Snapshot > show times''||Show the start and end time of each lesson and session
 
|-
 
|-
| {chosenforename} || The pupil's chosen forename
+
|''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
 
|-
 
|-
| {legalsurname} || The pupil's legal surname
+
|[[Image:snap_absent.png]]||Absent
 
|-
 
|-
| {surname} || The pupil's chosen surname
+
|[[Image:snap_late.png]]||Late
 
|-
 
|-
| {house} || The house the pupil belongs to
+
|[[Image:snap_nomark.png]]||Register not taken
 
|-
 
|-
| {dol} || The pupil's date of leaving
+
|[[Image:snap_future.png]]||Register in the future
|-
 
| {heshe} || Either he or she, depending on the pupil's gender
 
|-
 
| {himher} || Either him or her, depending on the pupil's gender
 
|-
 
| {hishers} || Either his or hers, depending on the pupil's gender
 
|-
 
| {hisher} || Either his or her, depending on the pupil's gender
 
|-
 
| {sondaughter} || Either son or daughter, depending on the pupil's gender
 
|-
 
| {himselfherself} || Either himself or herself, depending on the pupil's gender
 
 
|} <br>
 
|} <br>
  
==Editing and Deleting Notices==
+
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>
  
Notices can be edited and deleted from the Notice Composer page. In both of these cases, the recipients will see the updated/deleted Notice, not the original Notice. This only applies to Notices within Insight; emails and SMS messages cannot be altered or deleted once they have been sent. <br> <br>
+
===Cumulative Attendance===
  
Users may be given access to each other's notices if required, using the following Role Option: <br>
+
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>
''Manage > Notice Composer > Show other users notices'' (On) <br> <br>
+
Snapshot > Cumulative attendance <br> <br>
  
=Student and Parent View=
+
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>
  
Students and Parents can access Notices via the Notices page. The Role Option required for this is: <br>
+
===Cumulative Behaviours===
''General > Notices'' (On) <br> <br>
 
  
The Notices page is found via: <br>
+
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>
'''General > Notices''' <br> <br>
+
''Snapshot > Cumulative behaviour'' <br> <br>
  
The notice page will show a list of the messages that have been sent to the user via the Insight Notice Composer. Some automatically generated notices may also appear here. One month's messages are shown at a time. The arrow buttons at the top of the page can be used to view previous or future month's messages. <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>
  
Notices will be ordered chronologically, either earliest to latest or vice versa depending on the following preference: <br>
+
This role option will hide behaviour incidents issued prior to a certain date: <br>
''Manage > Preferences > Notices > Order Notices Newest First'' <br> <br>
+
''Behaviour > Behaviour > Earliest'' <br> <br>
  
It is also possible to display a Notices section on the '''[[Snapshot]]''' page, which has its own set of Role Options and settings. <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>
  
==Automatic Notices for Users==
+
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>
  
Insight can produce many notices automatically for users, in various circumstance as described below. <br> <br>
+
===Cumulative Achievements===
  
===Calendar Events===
+
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>
  
Several SIMS calendar events can be displayed on the Notices page in Insight. You can select the events that you would like to display using the following preference: <br>
+
The following preference will cause the chart to show no data: <br>
''Manage > Preferences > Notices > Show These SIMS Events'' (On) <br> <br>
+
''Behaviour > Hide behaviour menu items for the following years'' <br> <br>
  
Each type of event that can be displayed will be listed. Turn the events on or off as required. <br> <br>
+
This role option will hide achievements issued prior to a certain date: <br>
 +
''Behaviour > Achievements > Earliest'' <br> <br>
  
===Messages from PARS===
+
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>
  
{{Add|Manaage > Preferences > PARS > Include PARS communications in notices}}
+
===Recent behaviours===
  
===Unexplained Absences===
+
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===
 +
 
 +
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>
 +
 
 +
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>
 +
 
 +
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>
 +
 
 +
===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: <br>
 +
Snapshot > This term's attendance <br> <br>
 +
 
 +
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>
 +
 
 +
===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: <br> <br>
 +
 
 +
<root>
 +
<title>Guidance</title>
 +
<url>https://[your Insight URL]/_Personalisation/example.html</url>
 +
<height>50</height>
 +
</root>
 +
 
 +
{{Note|Replace [your Insight address] with the URL you use for Insight}}
  
A Notice will automatically be generated for unexplained absences (N codes) for students, if the following Role Option is enabled: <br>
+
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>
''Attendance > Report Absences'' (On) <br> <br>
 
  
The Notice will show a list of dates on which the student has N codes. The title of the Notice will always read "Unexplained Absences" but the body of the Notice can be edited. The body of the Notice will begin with the text from  the following preference, followed by a list of dates on which the student has N codes for their attendance: <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>
''Manage > Preferences > Notices > Notice To Use For Unexplained Absence'' <br> <br>
 
  
Users will be able to click on some or all of the dates to access the '''[[Report absences|Report Absences]]''' page for those dates if the following Role Option is enabled: <br>
+
=Behaviour Summary=
''Attendance > Report Absences > Allow reporting of historical absences'' (On) <br>
 
Dates which are upto this many days in the past will be clickable: <br>
 
''Attendance > Report Absences > Maximum age of absence in days'' <br> <br>
 
  
The dates of recent attendance codes can be hidden using the following preferences: <br>
+
[[Image:snap_behaviour_summary.jpg|thumb|The Snapshot Behaviour Summary]]
''Manage > Preferences > Attendance > Hide marks in attendance summaries in the validation range'' (On) <br>
 
''Manage > Preferences > Attendance > The number of days taken to validate attendance marks for attendance summaries (-1 for current week)'' This preference defines the number of days' attedance marks to be hidden <br> <br>
 
  
===Data Collection===
+
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>
  
{{Add|How on earth does this work?!}}
+
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>
  
===Linked Documents===
+
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>
  
{{Add|
+
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>
*Show public linked documents
 
*public linked documents earliest date
 
*do not show the following document types}}
 
  
===Medical Events===
+
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>
  
{{Add|Show medical events}}
+
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>
  
==Push Notifications==
+
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>
  
{{Add|Manage > Preferences > Notices > Push message to use when new notices are created}}
+
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>

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.