Difference between revisions of "Test"

From InsightWiki
Jump to navigation Jump to search
 
(77 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
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>
 
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>
 +
 +
The following Role Option is needed to access the Snapshot page: <br>
 +
''General > Snapshot'' (On) <br> <br>
 +
 +
The page is accessed via: <br>
 +
'''General > Snapshot''' <br> <br>
 +
 +
The page can be renamed with the following Role Option: <br>
 +
''General > Snapshot > Alternative menu title'' <br> <br>
  
 
=Notification bar=
 
=Notification bar=
Line 10: Line 19:
  
 
The notices box can be turned on or off using the following '''[[role options|role option]]''': <br>
 
The notices box can be turned on or off using the following '''[[role options|role option]]''': <br>
''Snapshot > Notices'' <br> <br>
+
''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>
 
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>
''Snapshot > Notices > Jump directly to notices screen'' <br> <br>
+
''General > Snapshot > Notices > Jump directly to notices screen'' <br> <br>
  
 
===Assignments===
 
===Assignments===
  
The assignments will display any outstanding assignments (that is, those that have not been marked as completed by the issuing staff member). The assignments box can be turned on or off using the setting called "Assignments" from the Snapshot [[role options]]. The assignments are colour-coded based on their status. <br> <br>
+
The Assignments box can be turned on or off using the following '''[[role options|role option]]''': <br>
 +
''General > Snapshot > Assignments'' <br> <br>
  
===Surveys===
+
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>
  
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>
+
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>
  
=Alerts=
+
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>
  
[[Image:snapshot_alerts.jpg|thumb|The Alerts section of the Snapshot page]]
+
===Surveys===
[[Image:snapshot_alerts_rules.jpg|thumb]]
 
  
The alerts bar will appear beneath the Notifications bar. There is a setting called "Alerts" in the snapshot [[role options]] that can be used to turn the entire Alerts bar off. Alternatively, each of the boxes can be turned on or off using the settings immediately beneath Alerts (in the role options, as mentioned above). <br> <br>
+
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 alerts bar can show information about positive and negative behaviour, attendance and exclusions. The alerts boxes will be coloured green, white 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''' <br> <br>
+
The surveys box can be renamed with this role option: <Br>
 +
''Snapshot > Label surveys as'' <br> <br>
  
There is also a setting called "showing rules used". This causes the alerts bar to toggle between showing the number of incidents/attendance percentage, and the boundaries that change the colour of the alerts. <br> <br>
+
===Unexplained Absences===
  
===Achievements and Behaviours===
+
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>
  
These alerts show the positive and negative behaviour for the student. The boxes can either show a count of the incidents or the number of behaviour points. The setting to decide which is shown is called "use points instead of events for behaviour" in the snapshot of [[role options]]. <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>
  
The Achievements and Behaviours alerts can be each be turned on or off using the "including Achievements" and "including Behaviours" settings respectively. Both settings are found in the snapshot section of [[role options]]. <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>
  
There is also a setting called "using behaviour incidents in the range". This defines the date range over which Insight will check for both Achievements and Behaviours. <br> <br>
+
=Alerts=
  
===Attendance===
+
[[Image:snapshot_alerts.png|thumb|The Alerts section of the Snapshot page, shown without and with rules used]]
  
The pupil's percentage attendance (based on AM and PM marks only) will be shown. This alert can be turned on or off for separate year groups - the setting to do so is called "including Attendance for years" in the snapshot section of [[role options]]. 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>
+
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>
  
===Exclusions===
+
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 exclusions panel will show the number of days that the pupil has been excluded from school. There is a setting called "all exclusions are unacceptable" which will colour the box red if the pupil has any exclusions - it is not possible to achieve this using the settings from SIMS. <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>
  
=Information panels=
+
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>
  
===Today's attendance===
+
===Achievements and Behaviours===
  
[[Image:snap_today.jpg|thumb|The Today's Attendance section of the Snapshot page]]
+
The following '''[[role options]]''' affect the information shown in the Achievements and Behaviours Alert boxes: <br>
  
This will show the pupil's attendance to school today. This panel can show the AM and PM registers, lesson registers, or both. The setting to turn this section on/off is called "This term's attendance" in the snapshot section of [[role options]]. By default the panel will be shown for all years; it can be hidden by setting the option to a number greater than the highest year at school e.g. 99. <br> <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
 +
|-
 +
|''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>
  
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> <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"
The following icons will appear to indicate attendance codes: <br>
+
|''Behaviour > Achievements''||This is must be On for the user to see the Achievements Alert
{|class="wikitable"
 
!Icon!!Meaning
 
|-
 
|[[Image:snap_pres.png]]||Present
 
 
|-
 
|-
|[[Image:snap_absent.png]]||Absent
+
|''General > Snapshot > including Achievements''||This is must be On for the user to see the Achievements Alert
 
|-
 
|-
|[[Image:snap_late.png]]||Late
+
|''Behaviour > Behaviour''||This is must be On for the user to see the Behaviour Alert
 
|-
 
|-
|[[Image:snap_nomark.png]]||Register not taken
+
|''General > Snapshot > including Behaviour''||This is must be On for the user to see the Behaviour Alert
|-
 
|[[Image:snap_future.png]]||Register in the future
 
 
|} <br>
 
|} <br>
  
===Recent behaviours===
+
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 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 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>
  
The setting to turn this panel on is called "Behaviour" in the snapshot [[role options]]. <br> <br>
+
===Exclusions===
  
===Detentions===
+
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>
  
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 reason for the detention, the date and the time will all be displayed. <br> <br>
+
=Information panels=
  
The setting to turn this panel on is called "Detentions" in the snapshot [[role options]]. <br> <br>
+
===Today's attendance===
  
===Extra curricular===
+
[[Image:snap_today.jpg|thumb|The Today's Attendance section of the Snapshot page]]
  
The Extra Curricular panel shows the three most recent extra classes for the pupil. If any classes are scheduled for the future they will take priority over classes that have already passed. The pupil's attendance, the date and the time will all be displayed. <br> <br>
+
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>
  
The setting to turn this panel on is called "Extra curriculum" in the snapshot [[role options]]. <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>
  
===Recent reports===
+
====Hiding attendance====
  
The reports panel will display any documents that have been recently added. The documents are pulled from the Linked Documents section in SIMS. In [[role options]] there are settings in the Subjects section that defined which documents will be pulled from SIMS. All AM Individual Reports will be pulled and General Documents can also be included. <br> <br>
+
{| cellpadding="5" cellspacing="0" border="1" style="border:solid 1 #CCC; border-collapse:collapse"
 +
|''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
 +
|} <br>
  
The setting to turn this panel on is in the Snapshot section of [[role options]] and is called "Recent Reports". There is a related preference, "maximum age in days" that defines the period of time that each report will appear on the snapshot page. <br> <br>
+
The following '''[[preferences]]''' can also be used to hide attendance codes: <br>
  
===This Term's Attendance===
+
{| 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
 +
|-
 +
|Lesson marks > Hide all references to lesson marks||All lesson marks will be hidden
 +
|} <br>
  
This line chart shows the pupil's attendance this term. 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. <br> <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>
  
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>
+
====Hiding Information====
  
=Behaviour Summary=
+
The rooms, times of lessons and student's attendance to each lesson can be displayed or hidden using the following role options: <br>
  
[[Image:snap_behaviour_summary.jpg|thumb|The Snapshot Behaviour Summary]]
+
{| 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
 +
|-
 +
|''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
 +
|} <br>
  
The behaviour summary section can show up to three panels, for positive and negative behaviour, and cashing in points. The "Behaviour" option in the Snapshot section of role options turns the entire section on or off. <br> <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
 +
|-
 +
|[[Image:snap_absent.png]]||Absent
 +
|-
 +
|[[Image:snap_late.png]]||Late
 +
|-
 +
|[[Image:snap_nomark.png]]||Register not taken
 +
|-
 +
|[[Image:snap_future.png]]||Register in the future
 +
|} <br>
  
If the section is turned then the Cashing In section may be shown on its own, amalgamated with the Achievements panel or hidden altogether. For Cashing In information to be shown, Insight must be linked to PARS otherwise no cashing in information will be displayed. If Insight is linked with PARS then there is an option in the PARS section of [[preferences]] called "Maintain cashin totals separate to accumulated points totals". If this option is on, then the Cashing In behaviour points will be shown in their own panel. <br> <br>
+
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>
  
=Role options=
+
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>
  
Alternative menu title
+
===Cumulative Behaviours===
  
House colours
+
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>
  
Label surveys as
+
The following preference will cause the chart to show no data: <br>
 +
''Behaviour > Hide behaviour menu items for the following years'' <br> <br>
  
Current attendance
+
This role option will hide behaviour incidents issued prior to a certain date: <br>
 +
''Behaviour > Behaviour > Earliest'' <br> <br>
  
show sessions for years
+
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>
  
show lessons for years
+
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>
  
show Rooms
+
===Cumulative Achievements===
  
show times
+
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>
  
show gridlines
+
The following preference will cause the chart to show no data: <br>
 +
''Behaviour > Hide behaviour menu items for the following years'' <br> <br>
  
show attendance symbols
+
This role option will hide achievements issued prior to a certain date: <br>
 +
''Behaviour > Achievements > Earliest'' <br> <br>
  
show hover over descriptions
+
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>
  
This terms attendance
+
===Recent behaviours===
  
Cumulative attendance
+
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>
  
Cumulative achievements
+
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>
  
Cumulative behaviours
+
The panel can also be renamed using the following role option: <br>
 +
''General > Snapshot > Use this title'' <br> <br>
  
Alerts
+
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>
  
including Attendance for years
+
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>
  
including Behaviour
+
===Detentions===
  
using behaviour incidents in the range AllThis yearThis termThis weekToday
+
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>
  
use points instead of events for behaviour
+
Detentions earlier than the date set here will not be shown: <br>
 +
''Behaviour > Detentions > Earliest'' <Br> <br>
  
including Achievements
+
===Extra curricular===
  
including Exclusion
+
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>
  
all Exclusions are unacceptable
+
Detentions earlier than the date set here will not be shown: <br>
 +
''Attendance > Extra Curriculum > Earliest'' <Br> <br>
  
showing rules used for Attendance
+
===Recent reports===
  
showing rules used for Behaviour
+
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>
  
showing rules used for Achievements
+
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>
  
showing rules used for Exclusions
+
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>
  
Behaviour
+
===This Term's Attendance===
  
use this title
+
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>
  
showing Achievements summary
+
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>
  
showing Behaviour summary
+
===Custom Panels (snapshot.bolton.xml)===
  
follow Hide behaviour menu preference
+
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.
  
Notices
+
The bolton files need to be in the following format: <br> <br>
  
excluding SIMS Events
+
<root>
 +
<title>Guidance</title>
 +
<url>https://[your Insight URL]/_Personalisation/example.html</url>
 +
<height>50</height>
 +
</root>
  
jump directly to notices screen
+
{{Note|Replace [your Insight address] with the URL you use for Insight}}
  
Assignments
+
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>
  
only show unfinished assignments
+
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>
  
jump directly to assignments screen
+
=Behaviour Summary=
  
Recent reports
+
[[Image:snap_behaviour_summary.jpg|thumb|The Snapshot Behaviour Summary]]
  
maximum age in days 012345678910111213141516171819202122232425262728
+
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>
  
Detentions
+
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>
  
Extra curriculum
+
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>
  
Server performance report
+
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>
  
=snapshot.bolton.xml=
+
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>
  
This file is used to add items to the Snapshot page in Insight. Each custom item needs to be created as a html page and saved in the _Personalisation folder. Once an item has been created, the snapshot.bolton file can be edited: <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>  
<root>
+
''Behaviour > Hide behaviour menu items for the following years''
<title>Guidance</title>
+
In order for this preference to affect the Behaviour Summary section, the following '''[[role option]]''' must also be enabled: <br>
<URL>"../_Personalisation/example.html"</URL>
+
''General > Snapshot > Follow Hide behaviour menu preference'' <br> <br>
<height>50</height>
 
</root>
 
  
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>
+
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>
  
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>
+
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.