Difference between revisions of "Test"

From InsightWiki
Jump to navigation Jump to search
Line 1: Line 1:
Resource booking is an additional module in Insight. It allows staff to reserve rooms or resources for their own use. Rooms will be imported automatically from SIMS and additional resources such as laptop trolleys can be manually entered into Insight. <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>
  
As Resource Booking is an additional module of Insight, a separate charge applies. Please contact <span class="plainlinks">[mailto:sales@tascsoftware.co.uk sales@tascsoftware.co.uk]</span> for further information. <br> <br>
+
=Notification bar=
  
=Configuration=
+
[[Image:snapshot_top_bar.png|thumb|The Notification bar of the Snapshot page showing Notices, Assignments and Surveys]]
  
The following '''[[role options]]''' are required to configure Resource Booking: <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>
''Manage > Resource Booking'' (On) <br>
 
''Manage > Resource Booking > Allow configuration'' (On) <br> <br>
 
  
The Resource Booking system is configured via: <br>
+
==Notices==
'''Manage > Resource Booking''' <br> <br>
 
  
Click the '''Configure''' button at the top right of the page to access the setup and management options. <br> <br>
+
The notices box can be turned on or off using the following '''[[role options|role option]]''': <br>
 +
''Snapshot > Notices'' <br> <br>
  
===Creating Resources===
+
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>
  
Resources are items that do not appear on the list of rooms in SIMS, such as laptop trolleys, iPads, the minibus, or rooms that don't appear on the timetable. <br> <br>
+
==Assignments==
  
Click '''Add''' to create a new resource. If there are multiple items in this resource (i.e. a trolley containing several laptops) you should not enter the number of separate items; this is done later. <br> <br>
+
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>
  
You can also use the '''Caretaker''' button to add staff who are responsible to maintaining the resource. These staff will receive email alerts if the resource is reported as broken or malfunctioning. <br> <br>
+
==Surveys==
  
{{Note|Insight needs to be configured to send emails. See '''[[communication setup]]''' page for further information.}} <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>
  
===Adding intervals===
+
=Alerts=
  
[[Image:resource_interval.jpg|thumb|Custom booking intervals]]
+
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>
  
All of the timetable periods, including the AM and PM periods, are available for Resource Booking by default. The '''Intervals''' tab is used to create additional booking periods such as out of hours slots or break periods. <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>
  
Click '''Add''' to create a new Interval. The '''Description''' should explain what time (and day, if relevant) the Interval occurs at e.g. "6pm - 7pm". The '''Frequency''' field determines how often in days the interval reoccurs. Typically this will be set to 1 for weekly intervals or 7 for daily intervals. <br> <br>
+
<div>[[Image:snapshot_alerts.jpg]]</div> <br> <br>
  
===Creating categories===
+
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>
  
[[Image:resource_category1.jpg|thumb|A category for rooms/resources that have computers]]
+
<div>[[Image:snapshot_alerts_rules.jpg]]</div> <br> <br>
  
Categories are used to organise rooms and resources into groups. Each category will contain a list of rooms/resources that have a certain attribute, such as containing computers or being able to take photos. <br> <br>
+
==Achievements and Behaviours==
  
Click the '''Add''' button to create a new Category. The name of the Category should be the attribute that the rooms/resources share e.g. Computers. You will see a list of all rooms and resources - use the furthest left checkbox to put the room or resource in the category. <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>
  
The '''Capacity''' field determines how many of that room or resource are available. For example, a computer room would have a Capacity of 20, if it has 20 computers. If you change the Capacity of a room/resource in one category, the Capacity will be changed for that room/resource in all other categories. <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>
  
By default a room/resource can be booked by more than one user at the same time, as long as there is enough Capacity for both users e.g. two teachers can book a computer room for the same period as long as there are enough computers for all of the students. The '''Keep together''' setting prevents this behaviour so that a room/resource can only be booked by one person at any given time. <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>
  
Select the '''Interval''' style for bookings. The default (black square) allows the room/resource to be booked using either timetabled periods or custom intervals. You can click on this toggle between the options available. Finally the '''Restrict''' button is used to limit the staff that are able to book a given room/resource. <br> <br>
+
==Attendance==
  
=Usage=
+
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>
  
===Making bookings===
+
==Exclusions==
  
[[Image:resource_reserve.jpg|thumb|The schedule and booking options for a single room]]
+
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>
[[Image:daily_resources.png|thumb|The schedule for several rooms for a single day]]
 
  
The following '''[[role options]]''' are required to book rooms or resources: <br>
+
=Information panels=
''Manage > Resource Booking'' (On) <br> <br>
 
  
The Resource Booking system is configured via: <br>
+
==Today's attendance==
'''Manage > Resource Booking''' <br> <br>
 
  
First select the date for which you would like to make a booking using the date selector at the top of the page. Note that the following '''Role option''' determines the maximum number of days in advance that you can make a booking: <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>
''Manage > Resource Booking > Maximum advance days'' <br> <br>
 
  
Next click '''Select resource''' at the top of the page and select the category that you would like to book. You will then see a list of the rooms and resources in that category. You may see a number in a grey circle next to the room/resource - this is the capacity. A computer room with 20 computers would have a capacity of 20, etc. <br> <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>
  
Once a room/resource has been selected, the schedule for that item will appear at the bottom of the page. Reserve the room/resource by clicking the '''Reserve''' button or select a new item by repeating the steps above. <br> <br>
+
[[Image:snap_today.jpg]] <br> <br>
  
The lower section of the page shows a timetable of all of the rooms and resources, broken into categories and listed in alphabetical order. The timetable will show the availability of each room and resource on the given date. The timetable is colour-coded using the colours below: <br> <br>
+
The following icons will appear to indicate attendance codes: <br>
 
+
{|class="wikitable"
{| cellpadding="5" cellspacing="0" border="1" style="border:solid 1 #CCC; border-collapse:collapse"
+
!Icon!!Meaning
! Colour !! Meaning
 
 
|-
 
|-
|style="background-color:#F5FFFA| ||Available for booking
+
|[[Image:snap_pres.png]]||Present
 
|-
 
|-
|style="background-color:#FF8C00| ||You have booked this room/resource
+
|[[Image:snap_absent.png]]||Absent
 
|-
 
|-
|style="background-color:#C0C0C0| ||There is a lesson in this room during this period
+
|[[Image:snap_late.png]]||Late
 
|-
 
|-
|style="background-color:#FFFFFF| ||A room change or cover is taking place in this room during this period
+
|[[Image:snap_nomark.png]]||Register not taken
 
|-
 
|-
|style="background-color:#DC143C| ||This resource is in downtime or has been reported as malfunctioning
+
|[[Image:snap_future.png]]||Register in the future
|-
 
|style="background-color:#FFE4E1| ||Another user has booked this room/resource during this period, or the room is being used for another purpose during this period
 
 
|} <br>
 
|} <br>
  
===Malfunctioning Resources and Downtime===
+
==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 setting to turn this panel on is called "Behaviour" in the snapshot [[role options]]. <br> <br>
 +
 
 +
[[Image:snap_recent_behaviours.jpg]] <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 reason for the detention, the date and the time will all be displayed. <br> <br>
 +
 
 +
The setting to turn this panel on is called "Detentions" in the snapshot [[role options]]. <br> <br>
 +
 
 +
[[Image:snap_dt.jpg]] <br> <br>
 +
 
 +
==Extra curricular==
 +
 
 +
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>
 +
 
 +
The setting to turn this panel on is called "Extra curriculum" in the snapshot [[role options]]. <br> <br>
 +
 
 +
[[Image:snap_ec.jpg]] <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. 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>
 +
 
 +
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>
 +
 
 +
[[Image:snap_reports.jpg]] <br> <br>
 +
 
 +
==This Term's Attendance==
 +
 
 +
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>
 +
 
 +
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>
 +
 
 +
[[Image:snap01.jpg]] <br> <br>
 +
 
 +
=Behaviour Summary=
 +
 
 +
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 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>
 +
 
 +
<div>[[Image:snap_behaviour_summary.jpg]]</div> <br> <br>
 +
 
 +
<!--
 +
COPIED FROM PERSONALISATION
 +
==snapshot.bolton.xml==
 +
 
 +
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>
 +
<root>
 +
<title>Guidance</title>
 +
<URL>"../_Personalisation/example.html"</URL>
 +
<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>
 +
 
 +
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>
 +
-->
 +
 
 +
=Role options=
 +
 
 +
Alternative menu title
 +
 
 +
House colours
 +
 
 +
Label surveys as
 +
 
 +
Current attendance
 +
 
 +
show sessions for years
 +
 
 +
show lessons for years
 +
 
 +
show Rooms
 +
 
 +
show times
 +
 
 +
show gridlines
 +
 
 +
show attendance symbols
 +
 
 +
show hover over descriptions
 +
 
 +
This terms attendance
 +
 
 +
Cumulative attendance
 +
 
 +
Cumulative achievements
 +
 
 +
Cumulative behaviours
 +
 
 +
Alerts
 +
 
 +
including Attendance for years
 +
 
 +
including Behaviour
 +
 
 +
using behaviour incidents in the range AllThis yearThis termThis weekToday
 +
 
 +
use points instead of events for behaviour
 +
 
 +
including Achievements
 +
 
 +
including Exclusion
 +
 
 +
all Exclusions are unacceptable
 +
 
 +
showing rules used for Attendance
 +
 
 +
showing rules used for Behaviour
 +
 
 +
showing rules used for Achievements
 +
 
 +
showing rules used for Exclusions
 +
 
 +
Behaviour
 +
 
 +
use this title
 +
 
 +
showing Achievements summary
 +
 
 +
showing Behaviour summary
 +
 
 +
follow Hide behaviour menu preference
 +
 
 +
Notices
 +
 
 +
excluding SIMS Events
 +
 
 +
jump directly to notices screen
 +
 
 +
Assignments
 +
 
 +
only show unfinished assignments
 +
 
 +
jump directly to assignments screen
  
Resources can be made unavailable by placing them into Downtime. Users can put a resource into Downtime by reporting it as malfunctioning after they have booked it. This will send an email to the caretaker for the resource (if there is one) and prevent any future bookings from being made for this resource until it is taken out of Downtime. <br> <br>
+
Recent reports
  
Resources can also be put into Downtime using the configuration screen for Resources (see the '''[[#Creating Resources|Creating Resources]]''' section for further information). This method allows Downtime to be scheduled for the future so resources can continue to be bookable until the scheduled Downtime begins. <br> <br>
+
maximum age in days 012345678910111213141516171819202122232425262728
  
To remove a resource from Downtime, go to the configuration screen for Resources and '''Delete''' the relevant Downtime period. <br> <br>
+
Detentions
  
===Reporting===
+
Extra curriculum
  
The '''Report''' button at the top right of the page is used to run reports. The report will show the bookings for selected rooms/resources over a date range. <br> <br>
+
Server performance report

Revision as of 16:20, 22 November 2018

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

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:
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:
Snapshot > Notices > Jump directly to notices screen

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.

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.

Alerts

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).

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

Snapshot alerts.jpg



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.

Snapshot alerts rules.jpg



Achievements and Behaviours

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.

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.

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.

Attendance

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

Exclusions

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.

Information panels

Today's attendance

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.

Note 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.

Snap today.jpg

The following icons will appear to indicate attendance codes:

Icon Meaning
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


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 setting to turn this panel on is called "Behaviour" in the snapshot role options.

Snap recent behaviours.jpg

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 reason for the detention, the date and the time will all be displayed.

The setting to turn this panel on is called "Detentions" in the snapshot role options.

Snap dt.jpg

Extra curricular

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.

The setting to turn this panel on is called "Extra curriculum" in the snapshot role options.

Snap ec.jpg

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. 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.

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.

Snap reports.jpg

This Term's Attendance

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.

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.

Snap01.jpg

Behaviour Summary

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.

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.

Snap behaviour summary.jpg




Role options

Alternative menu title

House colours

Label surveys as

Current attendance

show sessions for years

show lessons for years

show Rooms

show times

show gridlines

show attendance symbols

show hover over descriptions

This terms attendance

Cumulative attendance

Cumulative achievements

Cumulative behaviours

Alerts

including Attendance for years

including Behaviour

using behaviour incidents in the range AllThis yearThis termThis weekToday

use points instead of events for behaviour

including Achievements

including Exclusion

all Exclusions are unacceptable

showing rules used for Attendance

showing rules used for Behaviour

showing rules used for Achievements

showing rules used for Exclusions

Behaviour

use this title

showing Achievements summary

showing Behaviour summary

follow Hide behaviour menu preference

Notices

excluding SIMS Events

jump directly to notices screen

Assignments

only show unfinished assignments

jump directly to assignments screen

Recent reports

maximum age in days 012345678910111213141516171819202122232425262728

Detentions

Extra curriculum

Server performance report