Difference between revisions of "Test"

From InsightWiki
Jump to navigation Jump to search
 
(561 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
=Creating Accounts (the Sync process)=
+
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>
  
−
==Parental==
+
The following Role Option is needed to access the Snapshot page: <br>
 +
''General > Snapshot'' (On) <br> <br>
  
−
First check that you have configured appropriate '''[[synchronisation rules]]''' to create accounts for parents. Parental accounts are also influence by the '''[[Preferences#User Creation|User Creation preferences]]'''. <br> <br>
+
The page is accessed via: <br>
 +
'''General > Snapshot''' <br> <br>
  
−
Once you are happy with the Synchronisation Rules and the User Creation Preferences, click the '''Process''' button at the top right of the page then select '''Synchronise'''. A window will appear. <br> <br>
+
The page can be renamed with the following Role Option: <br>
 +
''General > Snapshot > Alternative menu title'' <br> <br>
  
−
Enable the '''Set the new users' activated status as 'Activated'''' option and select '''Parental''', then click '''Synchronise'''. Insight will then scan every contact in SIMS. This may be considerably higher than the number of students you have on roll. <br> <br>
+
=Notification bar=
  
−
Once the sync has started you can continue using other areas of Insight or close the browser; the sync will continue in the background. If you do leave the Users page and then want to know how much progress has been made, go back to the Users page then click '''Process''' > '''Synchronise''' select the '''Track''' option. <br> <br>
+
[[Image:snapshot_top_bar.png|thumb|The Notification bar of the Snapshot page showing Notices, Assignments and Surveys]]
  
−
Once parents' accounts have been created, you can send their randomly generated passwords to them using the '''[[password notification]]''' page. <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>
  
−
==Student==
+
===Notices===
  
−
[[Image:sync_students_window.png|thumb|The Student Synchronisation window]]
+
The notices box can be turned on or off using the following '''[[role options|role option]]''': <br>
 +
''General > Snapshot > Notices'' <br> <br>
  
−
Student accounts can only be created by linking Insight to the Active Directory, which requires the additional module, '''[[AD links]]'''. <br> <br>
+
Clicking on the Notices section will either take the user to the '''[[Notices]]''' page, or expand the Notices box on the snapshot page to display up to 10 recent notices. This behaviour is determined by the following '''[[role options|role option]]''': <br>
 +
''General > Snapshot > Notices > Jump directly to notices screen'' <br> <br>
  
−
Once the AD Links page has been configured, check that you have configured appropriate '''[[synchronisation rules]]''' to create accounts for students. <br> <br> <br>
+
===Assignments===
  
−
By default Insight will not create accounts for students who are leavers or pre-admission. If you would like accounts to be created for these students, go to: <br> <br>
+
The Assignments box can be turned on or off using the following '''[[role options|role option]]''': <br>
−
''Manage > Preferences > User Creation'' <br>
+
''General > Snapshot > Assignments'' <br> <br>
−
There are settings here called: <br>
 
−
*'''Largest number of days in the future for admission dates of applicants''' <br>
 
−
This is the number of days after a student has gone off roll that they are still able to access their Insight account
 
−
*'''Date Of Leaving grace days before considered Off Roll''' <br>
 
−
This is the number of days before the student joins the school, in which they will be able to access their Insight account <br> <br> <br>
 
  
−
Finally run the Sync Process to create accounts for students. To do this click the '''Process''' button at the top right of the page then select '''Synchronise'''. A window will appear. <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>
  
−
The option at the top of the window reads '''Set the new users' activated status as 'Activated''''. Enable this if you want the students to be able to log in to Insight immediately. Next select the '''Students''' option. Leave the 3 checkboxes unticked then click '''Synchronise'''. <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>
  
−
==Staff==
+
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>
  
−
To create staff accounts, click the '''Process''' button at the top right of the page then click '''Synchronise'''.
+
===Surveys===
  
−
The option at the top of the window reads '''Set the new users' activated status as 'Activated''''. Enable this if you want the staff to be able to log in to Insight immediately. If you do not enable this option, then staff accounts will be deactivated, meaning they cannot log in until the accounts are activated at a later time. <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>
  
−
Select the '''Staff''' option and more options will appear in the window. Select the role that you want to give to the staff accounts from the dropdown (see the '''[[roles]]''' page for further information about roles). <br> <br>
+
The surveys box can be renamed with this role option: <Br>
 +
''Snapshot > Label surveys as'' <br> <br>
  
−
*'''Use SIMS credentials where possible''' <br>
+
===Unexplained Absences===
−
This option allows staff to use their SIMS login details to log in to Insight. The alternative is for Insight to create a new username and password for staff. <br>
 
−
*'''Only add accounts where staff have a SIMS account''' <br>
 
−
This will prevent members of staff without SIMS accounts from logging in to Insight. <br>
 
−
*'''Synchronise teaching staff''' <br>
 
−
Enable this option if you want Insight to create accounts for teachers. <br>
 
−
*'''Synchronise non-teaching staff'''
 
−
Enable this option if you want Insight to create accounts for non-teachers. <br> <br>
 
  
−
Finally, click the '''Synchronise''' button and Insight will create accounts for staff, according to the options selected. <br> <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>
 +
''Attendance > Hide the Report Absences menu item for the following years'' <br> <br>
  
−
===Single Sign On===
+
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>
  
−
[[Image:trusted_authentication.png|thumb|A Trusted Authentication Account in SIMS]]
+
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>
  
−
Insight is capable of Single Sign On (SSO) so that staff do not need to log in to Insight, as long as they are logged in to the school network via Active Directory. Staff must also have Trusted Authentication logins for SIMS. <br> <br>
+
=Alerts=
  
−
SSO requires Insight to be linked to the Active Directory, which requires the additional module, '''[[AD links]]'''. Staff must have their Person_ID number stored in the EmployeeID field of their AD record. Instructions for performing this task are found on the '''[[AD links]]''' page. <br> <br>
+
[[Image:snapshot_alerts.png|thumb|The Alerts section of the Snapshot page, shown without and with rules used]]
  
−
Once the above conditions have been satisfied, staff should use the ADSSO.aspx page of Insight to login when they are connected to the school network, e.g. <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>
−
''<nowiki>https://insight.myschoolwebsite.co.uk/insight/ADSSO.aspx</nowiki>'' <br> <br>
+
''General > Snapshot > Alerts'' <br> <br>
  
−
=Changing Usernames to Email Format (the Match process)=
+
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>
  
−
Each user in Insight has a username and an email address. Sometimes a user will change their email address, and you may want their username to also change, so that it matches their new email address. Insight can update users' usernames in bulk using the Match process. <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>
  
−
Note that the Match process will not be available if you have configured Insight to not email addresses to be used as email addresses. The setting for this is found via: <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 > Preferences > User Creation > Never use emails as usernames'' <br> <br>
+
''General > Snapshot > Alerts > All Exclusions are unacceptable <br> <br>
  
−
To run the Match process, click the '''Process''' button at the top right of the page then click '''Match'''. <br> <br>
+
===Achievements and Behaviours===
  
−
You can then choose from the following two options: <br>
+
The following '''[[role options]]''' affect the information shown in the Achievements and Behaviours Alert boxes: <br>
−
*'''Email-like usernames''' <br>
 
−
Only update an account if the username is already an email address
 
−
*'''All users''' <br>
 
−
Update all accounts <br> <br>
 
  
−
Note that no two accounts can have the same email address or the same username. <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>
  
−
Once a user's username has been updated, they will receive an email telling them what has happened. You can define the message Insight uses via: <br>
+
The following '''[[role options]]''' also must be enabled for the user to see the Achievements and Behaviour Alert boxes: <br>
−
''Manage > Preferences > Email > Message to send when a username changes as a result of an email address change'' <br> <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
 +
|-
 +
|''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
 +
|} <br>
  
−
=Automatic Overnight Synchronising and Matching=
+
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>
  
−
INSIGHT can be configured to automatically perform a sync. To do this, you will need to first go to 'Accounts' > 'Users' and then click the button labeled 'Process' in the top right of the screen and then click 'Automate'. <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>
  
−
This will open up a window which looks like this:
+
===Attendance===
−
[[File:AUTOMATE.png]]
 
  
−
You will notice that there are tabs for Parental, Teaching Staff, Non-teaching Staff and Students. <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>
−
Each of these tabs must be configured.<br> <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>
  
−
Firstly enable the option labeled 'Enable Automatic Synchronisation', then set the time you wish for the synchronization to run each day/night. <br> <br>
+
===Exclusions===
  
−
Other than this, the options available within each of the tabs will change. Within each of the tabs, there is an option to enable automatic synchronization for the type of person within the currently selected tab. e.g In the Parental tab there will be an option to 'Synchronise Parental Accounts' . This enables you to configure INSIGHT to run an automatic synch only for the individual person types you're interested in. <br> <br>
+
The Exclusions tab will show the number of days that a student has been excluded in exclusion in SIMS. The Exclusions alert can be turned on or off using the following role option: <br>
 +
''General > Snapshot > Including Exclusion'' <br> <br>
  
−
You will see that some of the options are repeated across multiple tabs and are fairly self-explanatory... But there are a couple of options which may not be so obvious. Here's a list of some such options and an explanation for what they do: <br> <br>
+
=Information panels=
  
−
'''In the Parental Tab:'''
+
===Today's attendance===
−
New Accounts are Approved - This means that newly created accounts will be activated automatically.
 
−
Run Match Process - This option ensures that parental usernames match their email address. This should not be enabled if you do not use email-like usernames. <br> <br>
 
  
−
'''In the Students Tab:'''
+
[[Image:snap_today.jpg|thumb|The Today's Attendance section of the Snapshot page]]
−
Match Legal
 
−
Match Chosen
 
−
Match Initial <br> <br>
 
  
−
These options are relevant only when you do not create student accounts by importing unique student IDs into the student's AD records.
+
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 options instead set INSIGHT to create student accounts when a match is found based on the name data in the student's name and AD records. <br> <br>
 
  
−
Once you have configured all of the options within each of the tabs as you require, click 'Ok' in the bottom right and the Automatic Synchronisation should start to happen at the time you set in the top right of the 'Automate' window. <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>
  
−
'''Important Side Note'''
+
====Hiding attendance====
−
In order for this to work you have to have KeepAlive installed and running. To check this run the '''[[service controller]]''' on the IIs server that hosts Insight. Open the 'Services' option and you can check the current state of Keep Alive. <br> <br>
 
  
−
=Logging into other users' accounts (Switching)=
+
{| 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>
  
−
=Resetting Passwords=
+
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
 +
|-
 +
|Lesson marks > Hide all references to lesson marks||All lesson marks will be hidden
 +
|} <br>
  
−
=Ye Olde Stuff=
+
Additionally the settings in SIMS affect whether or not AM and PM registers are shown. The settings in SIMS are found via: <br>
−
==The User page==
+
''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>
  
−
All of the users in Insight can be found on this page. There are several columns in the list of users that give more information about the user account. <br> <br>
+
====Hiding Information====
  
−
The activated column shows whether the account is active or not. An inactive account cannot be used to log in. There will be a tick in the Used column if the user has ever logged in, or if the Insight admin has ever logged into their account (see the Match Button, below). <br> <br>
+
The rooms, times of lessons and student's attendance to each lesson can be displayed or hidden using the following role options: <br>
  
−
When an account is first created, it will be given a randomly generated password (unless it is a SIMS or '''[[AD links|Active Directory]]''' account, which have their own passwords). There will be a tick in the Gen Pwd column if the account still has a randomly generated password; the tick will disappear once the user changes their password. The notified column tells you whether the user has had their login details sent to them via the '''[[password notification]]''' page. <br> <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
 +
|-
 +
|''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 sorting column on the far right shows information about the pupils that the user is linked to. There will be a string of text for each pupil that the account is linked to, separated by a comma for each pupil. The first two characters are always 0. The next two characters are the pupil's year group and the final two characters are the pupil's registration group. For example, if a parent has a year 9 pupil in reg group 7F, the sorting string will read: 00077F. You can use this to find all of the parents of specific pupils. For example if you type 0009 into the sorting column filter, the users page will show you all of the users linked to year 9 pupils. <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>
  
−
===Automatic Synchronisation===
+
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===
  
−
===Troubleshooting Synchronisation===
+
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>
  
−
If some users seem to be missing then check the SIMS synchronisation report, which will highlight the reasons that particular accounts were not created. The '''[[SIMS synchronisation]]''' report is usually found in the Reports section. <br> <br>
+
This chart is affected by the following preference, which determines whether or not PM marks are counted for the student: <br>
 +
Attendance > Only use AM sessions <br> <br>
  
−
<!--
+
===Cumulative Behaviours===
−
HOW TO PERFORM A PUPIL SYNC IF SCHOOL DOES NOT HAVE IDENTIFYING NUMBERS IN ACTIVE DIRECTORY
 
−
IT IS MUCH BETTER TO USE IDENTIFYING NUMBERS IN AD THAN TRYING TO DO THIS
 
  
−
Insight will scan the Active Directory, looking for students whose names match the name of students in SIMS. In Active Directory students can only have one forename and surname, whereas in SIMS students can have chosen names and/or legal names. Select whether you want Insight to check the Active Directory for students' legal names, chosen names, forename initials or a combination of the three.
+
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>
  
−
If the sync finds more than one student in Active Directory with the same name (e.g. multiple John Smiths) then Insight will try to find a unique identifier as taken from the AD Links page. If this is not possible, Insight will create accounts for these students but the Insight accounts will not be properly linked to AD. These accounts need to be manually linked after the sync has finished.
+
The following preference will cause the chart to show no data: <br>
 +
''Behaviour > Hide behaviour menu items for the following years'' <br> <br>
  
−
Once the sync has finished you will need to identify all the pupils who have not been properly linked. To do this, type the name of the role you used for students in the Rolename filter. Type the domain (from the AD Links page) into the Username filter and then click the button next to it and select Doesn't Contain.
+
This role option will hide behaviour incidents issued prior to a certain date: <br>
 +
''Behaviour > Behaviour > Earliest'' <br> <br>
  
−
You should now see a list of all of the student accounts that have not been properly linked. One at a time, select the account, click the Edit Button, then click Link in the window that opens.
+
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>
  
−
A list of the possible AD accounts will be shown. Either select the correct account or, if the correct account is not shown, use the search option to find the correct account from AD.
+
If the following role option is enabled then behaviour incidents with a points value of zero will be hidden from the chart: <br>
−
-->
+
''Behaviour > Hide zero point items'' <br> <br>
 +
 
 +
===Cumulative Achievements===
 +
 
 +
The Cumulative Achievements chart will show a running total of the student's positive behaviour over the course of the academic year. This chart can be turned on or off using the following role option: <br>
 +
''General > Snapshot > Cumulative achievements '' <br> <br>
 +
 
 +
The following preference will cause the chart to show no data: <br>
 +
''Behaviour > Hide behaviour menu items for the following years'' <br> <br>
 +
 
 +
This role option will hide achievements issued prior to a certain date: <br>
 +
''Behaviour > Achievements > Earliest'' <br> <br>
 +
 
 +
If the following role option is enabled then behaviour incidents with a points value of zero will be hidden from the chart: <br>
 +
''Behaviour > Hide zero point items'' <br> <br>
 +
 
 +
===Recent behaviours===
 +
 
 +
The recent behaviour panel will show the three most recent behaviour incidents for the student. These could be positive or negative. Positive incidents will be displayed if the [[Achievements]] role option is turned on and negatives will show if the [[Behaviours]] role option is turned on. <br> <br>
 +
 
 +
The Recent Behaviour panel will show the three most recent behaviour incidents for the student. These could be positive or negative. The Recent Behaviour panel can be turned off using the following '''[[role option]]''' which will also remove the [[#Behaviour Summary|Behaviour Summary]] section from the Snapshot page. <br>
 +
General > Snapshot > Behaviour <br> <br>
 +
 
 +
The panel can also be renamed using the following role option: <br>
 +
''General > Snapshot > Use this title'' <br> <br>
 +
 
 +
Behaviour incidents will only be shown in the Recent Behaviours panel if they could also be shown on the '''[[Achievements]]''' or '''[[Behaviours]]''' pages in Insight. Therefore you can use the role options and preferences for Achievements and Behaviours to hide bheaviour incidents from the Recent Behaviours panel. <br> <br>
 +
 
 +
There is a preference to hide behaviour menu items for students in selected year groups. This preference also applies to the Recent Behaviours panel: <br>
 +
Behaviour > Hide behaviour menu items for the following years'' <br> <br>
 +
 
 +
===Detentions===
 +
 
 +
The detentions panel shows the three most recent detentions for the pupil. If any detentions are scheduled for the future they will take priority over detentions that have already passed. The '''[[role options|role option]]''' to enable this panel is found via: <br>
 +
''General > Snapshot > Detentions'' <br> <br>
 +
 
 +
Detentions earlier than the date set here will not be shown: <br>
 +
''Behaviour > Detentions > Earliest'' <Br> <br>
 +
 
 +
===Extra curricular===
 +
 
 +
The Extra Curricular panel shows the three most recent extra classes for the pupil. If any extra classes are scheduled for the future they will take priority over extra classes that have already passed. The '''[[role options|role option]]''' to enable this panel is found via: <br>
 +
''General > Snapshot > Extra Curricular'' <br> <br>
 +
 
 +
Detentions earlier than the date set here will not be shown: <br>
 +
''Attendance > Extra Curriculum > Earliest'' <Br> <br>
 +
 
 +
===Recent reports===
 +
 
 +
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}}
 +
 
 +
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>
 +
 
 +
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>
 +
 
 +
=Behaviour Summary=
 +
 
 +
[[Image:snap_behaviour_summary.jpg|thumb|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|Recent Behaviours]]''' section of the snapshot page: <br>
 +
''General > Snapshot > Behaviour'' <br> <br>
 +
 
 +
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>
 +
 
 +
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>
 +
 
 +
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>
 +
 
 +
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>
 +
 
 +
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>
 +
 
 +
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>
 +
 
 +
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.

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