Difference between revisions of "Subjects"

From InsightWiki
Jump to navigation Jump to search
(Created page with " '''INSIGHT can display various reports stored within a student's Linked Documents in SIMS. <br> These can then be accessed externally for review by a students associated INSI...")
 
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
[[Image:subjects_menu_bar.png|thumb|The Subjects menu bar section showing two Linked Documents]]
  
'''INSIGHT can display various reports stored within a student's Linked Documents in SIMS. <br> These can then be accessed externally for review by a students associated INSIGHT users.''' <br> <br>
+
The Subjects option in Insight will show some of a pupil's Linked Documents. These documents can be printed, downloaded or viewed online. <br> <br>
  
The following types of reports can be displayed in INSIGHT:<br>
+
The Subjects section is accessed by clicking the '''Subjects''' option on the Insight Menu Bar (although Subjects can be renamed using the '''[[Roles]]''' page). <br> <br>
  
*PARS Reports
+
==Documents==
  
*Assessment Manager Individual Reports
+
By default Insight will display all of the documents with a '''Type''' of AM Individual Report and a '''Status''' of Public in SIMS. Documents with a '''Status''' of Private or Confidential are never shown. <br> <br>
  
*General Documents
+
[[Image:Pupil_Report_SIMS.png|thumb|The Pupil Report option in SIMS]]
  
*Profile Reports
+
The following preference will prevent Parental Users from viewing the documents on this page unless they have the '''Pupil Report''' option enabled in SIMS: <br>
 +
''Preferences > Reports > Use the SIMS Pupil Report field to decide whether to show reports'' (Off to show documents to all users) <br> <br>
  
 +
The AM Individual Reports can be filtered so that only some are shown using the following Role Option. Enter one or more key words or phrases into this option. AM Individual Reports will only be included if their title matches any of the key words/phrases. Each key word/phrase should appear after a plus symbol. If there are multiple key words/phrases they should be separated by a pipe symbol (|). <br>
 +
''Subjects > Report Documents filter'' <br>
 +
(For example, to filter out all AM Individual Reports that don't include either "Report" or "Assessment" you should enter +Report|+Assessment )
 +
 +
<!-- in fact these can be quite complicated. pipe means OR, ampersand means AND. OR is always outer, AND is always inner e.g.
 +
+alpha&+bravo|+alpha&+charlie
 +
means (alpha and bravo) or (alpha and charlie)
 +
use a minus sign as a prefix for NOT e.g.
 +
+alpha&+bravo|+charlie&-delta
 +
means (alpha and bravo) or (charlie and not delta)-->
 
<br>
 
<br>
  
'Once you have correctly configured all of the required settings for Linked Documents to be displayed, you will need to ensure that the 'Subject' menu item is 'ON' in the Role Options for the role associated to the users you wish to have access to the reports'
+
There are Role Options that can be used to hide documents which were uploaded to SIMS before or after a given date: <br>
 +
''Subjects > Earliest date'' (Documents uploaded before this date will be hidden) <br>
 +
''Subjects > Latest cutoff date'' (Documents uploaded after this date will be hidden) <br> <br>
 +
 +
===General Documents===
 +
 
 +
Documents where the '''Type''' is General Documents are not shown by default but can displayed. To show these documents, use the following Role Option. Enter one or more key words or phrases into this option. General Documents will be included if their title matches any of the key words/phrases. Each key word/phrase should appear after a plus symbol. If there are multiple key words/phrases they should be separated by a pipe symbol (|). <br>
 +
''Subjects > Include general documents containing'' <br> <br>
 +
 
 +
(For example, to show all documents including either "UCAS" or "Application form" you should enter +UCAS|+Application form ) <br>
 +
(If you would like to display all Linked Documents, enter a pipe symbol only into the Role Option) <br> <br>
 +
 
 +
===PDF Documents===
 +
 
 +
Some devices may not be able to display some document types correctly (this is very likely to be a problem for Insight app users trying to view XML documents). If reports have been generated in SIMS, the format of the documents may be XML. If this is the case, you may wish to convert your linked documents to PDF format which is generally more compatible. <br> <br>
 +
 
 +
There is a feature in Insight to batch convert Linked Documents to PDF format. This feature is accessed via: <br>
 +
'''Manage > [[Batch PDF processes]]''' <br> <br>
 +
 
 +
The Batch PDF Processes feature will not remove the old XML documents from SIMS, however they can be hidden from Insight using the following role option: <br>
 +
''Subjects > Hide non-PDFs'' (On) <br> <br>
 +
 
 +
Additionally you can set a date for this begin. Any non-PDF documents uploaded earlier than this date will still be shown in Insight: <br>
 +
''Subjects > only after'' <br> <br>
 +
 
 +
===Attendance===
 +
 
 +
[[Image:attendance_feedback_reports.png|thumb|A report showing Attendance and the Feedback button]]
  
<br>
+
The student's attendance can be shown alongside each document if desired. The figure given for attendance uses the AM and PM sessions only (not lesson data). To enable this feature, use the following Role Option: <br>
 +
''Subjects > Show attendance info'' (On) <br> <br>
 +
 
 +
===Report Feedback===
 +
 
 +
You can allow users to give written feedback about the reports and documents displayed in the Subjects section. The following Role Option needs to be enabled for users to do this: <br>
 +
''Subjects > Allow feedback'' (On) <br> <br>
  
===Important Info===
+
Any comments that have been added can be viewed on the Reports Viewed report (see '''[[#Reports Viewed|Reports Viewed]]''' below). <br> <br>
  
*A students Linked Documents can be added and edited in SIMS @  ‘FOCUS’ > ‘STUDENT’ > ‘STUDENT DETAILS’ > ‘LINKED DOCS’
+
Insight can also send an email to a nominated email address when Feedback is recorded for a document. To enable this feature, enter the email address into the following preference: <br>
 +
''Preferences > Email > Send emails to these addresses when Report Feedback is entered'' <br> <br>
  
*Documents that you wish to be displayed in INSIGHT must have ‘Status’ of ‘Public’ in order for INSIGHT to access and display the reports… To edit this, select a document from within ‘Linked documents’ in SIMS, click ‘Open’ and this will open a ‘Edit note/document’ window from which this can be edited.
+
{{Note|Some configuration may be required for Insight to send emails. See the '''[[communication setup]]''' page for further information.}} <br>
  
*For General Document Reports - Within the 'Documents linked to: STUDENTNAME' window, please ensure that 'General Document' is selected in the 'Type' drop down for the report you wish to be displayed.
+
==Grade Summary==
  
*The Role option 'Include General Docs containing' MUST contain a character that is present in the name of ALL General Documents you wish to be accessible in INSIGHT.
+
[[Image:grade_summary.png|thumb|The Grade Summary page]]
  
*The option 'Report Documents Filter' can then be used to specify keywords that you wish to filter on, for example 'rev' (however, its important to note that in order for this to work you must ensure that only the document you wish to be accessible contains these characters with the correct specified casing.)
+
The Grade Summary shows a list of the student's grades from Assessment Manager. Grades are divided into their corresponding Result Sets. <br> <br>
  
<br> <br>
+
The Grade Summary page is enabled using the following Role Option: <br>
 +
''Subjects > Show grade summary'' (On) <br> <br>
  
===Preferences required to show Linked Documents in INSIGHT===
+
The Grade Summary page is then accessed via: <br>
 +
'''Subjects > Grade Summary''' <br> <br>
  
'Manage' > 'Preferences' > 'Reports'
+
The Grade Summary page cannot show grades from PARS (including SIMS Assessment Manager grades that have been pulled into PARS). Therefore if you wish to use the Grade Summary page you must import the desired grades from SIMS (see '''[[Assessments#Importing Grades from SIMS|the Assessments page]]''' for more information). <br> <br>
  
*'''Use the SIMS Pupil Report field to decide whether to show reports'''
+
===Changing the Format and Display===
  
If a user can be identified with a student's contact in SIMS or not reports will be shown (this is the same as not enabling this option).
+
====Using Grade Set Descriptions====
  
Enabling this option will base the decision of whether reports are shown or hidden on whether the Pupil Report field in SIMS is selected or not.
+
The layout and display of the data on the Grade Summary page can be changed using various Role Options. The Grade Summary can display the '''Grade Description''' for each grade rather than the grade itself (as taken from the Grade Set in SIMS) if the following Role Option is enabled: <br>
 +
''Subjects > Using gradeset descriptions''' <br> <br>
  
Therefore, if this option is enabled and if the Pupil Report field in SIMS is selected reports will be shown however, if the Pupil Report field in SIMS is not selected then reports will not be shown.
+
====Reordering the Grade Summary Data====
  
<br> <br>
+
The results for the student will be arranged into Result Set groups and ordered chronologically. The default is to order to the Result Sets from oldest aat the top to newest at the bottom. You can reverse this by enabling the following role option: <br>
 +
''Subjects > Latest first'' (On) <br> <br>
  
===Role options required to display Linked Documents in INSIGHT===
+
Within each Result Set group, the aspects will be ordered alphabetically by default. You can reorder the aspects using a text file on the IIS server that hosts Insight. You will also need to enable the following Role Option: <br>
 +
''Subjects > Use _Personalisation\aspect.priorities file'' <br> <br>
  
'''These options will need to be enabled within the role that you wish to have access to the Linked Document Reports. (Not all will be applicable in every situation.)'''
+
The text file is found in the '''_Personalisation''' folder of the Insight installation, which is typically located: <br>
 +
''C:\wwwroot\inetput\INSIGHT\_Personalisation'' <br> <br>
  
*'''Earliest date''' - Enter the date from which the information can be requested.
+
The file to be edited will either be called '''aspect.priorities''' or '''aspect.priorities.unused'''. If you have a file called '''aspect.priorities''' then open that file using Notepad or a similar basic text editor (not Microsoft Word or Google Docs!). If you do not have an '''aspect.priorities''' file but do have an '''aspect.priorities.unused''' file, then edit the '''aspect.priorities.unused''' file, remove the '''.unused''' extension, then edit the file using Notepad or similar basic text editor. If you do not have either file, run a '''[[service pack|service pack]]''' then refresh the '''_Personalisation''' folder. <br> <br>
  
*'''Latest cut-off date''' - Enter the date after which information cannot be requested.
+
In the text file each aspect can be given a priority number. On the Grade Summary page, aspects are ordered by their priority (higher priority appear at the top of the list of aspects). Aspects that are not specified in the aspects.priorities file are treated as if they have a priority of 0. <br> <br>
  
*'''Hide non-PDF's''' - This option will hide anything that is not a PDF file.
+
Priorities much be specified separately for each year group. Each year group has a set of tags in the format <nowiki><ncyear value="x"> </ncyear></nowiki> <br>
 +
Each aspect can then be given a priority with a line of text in the following format <aspect.priority aspect="ASPECT NAME" priority="XX" /> <br> <br>
  
*'''Prefer HTML to PDF''' - Opt for HTML over PDF file.
+
For example, to show reorder the page so that Attainment grades are shown above Effort grades, the text file might look something like this:
 +
<aspect.priorities>
 +
    <ncyear value="10">
 +
        <aspect.priority aspect="English Attainment" priority="2" />
 +
        <aspect.priority aspect="English Effort" priority="1" />
 +
    </ncyear>
 +
    <ncyear value="11">
 +
        <aspect.priority aspect="English Attainment" priority="2" />
 +
        <aspect.priority aspect="English Effort" priority="1" />
 +
    </ncyear>
 +
</aspect.priorities>
  
*'''Report Documents Filter''' - Enter a list of keywords, each prefixed with either a plus or minus sign, and separated by pipes (press shift and backslash on your keyboard).
+
===Limiting the Data Shown===
  
*'''Include General Documents containing''' - When using Linked Documents for reports, leave this blank to not show any General Documents, or enter some filter text to select which to show.
+
You can limit the data shown on the Grade Summary page using the following Role Options: <br>
 +
''Subjects > For these years'' <br>
 +
''Subjects > For how many previous academic years'' <br>
 +
''Subjects > Or specify other amounts for specific yeargroups'' <br>
 +
''Subjects > Latest date'' <br> <br>
  
*'''Additional menu using filter''' - Setup additional menu items for individual reports.
+
The entire Grade Summary page can be hidden from students in certain year groups using the following Role Option: <br>
 +
''Subject > For these years'' <br>
 +
(Enter an asterix into this setting to show the Grade Summary page to all students, or enter specific year groups separate by a plus symbol e.g. 10+11) <br> <br>
  
*'''Show filtered for years''' - Use year groups separated by +, or the * symbol for all.
+
The following Role Option determines the number of previous years' data that will be shown on the Grade Summary: <br>
 +
''Subjects > For how many previous academic years'' <br> <br>
  
*'''Show attendance info''' - Show or hide attendance information.
+
Alternatively you can display different amounts of previous years' data for each year group if desired. To do this use the following Role Option: <br>
 +
''Or specify other amounts for specific yeargroups'' <br>
 +
(Enter each year group followed by a comma, then the number of previous years' data to be shown and separate each year group with a plus symbol. If you do not specify a year group, that group will show the number of previous year' data as specified in the '''For how many previous academic years''' option.) <br> <br>
  
*'''Alternative menu title''' - Allows user to amend (Subjects) menu title.
+
==Have Reports/Documents been Viewed?==
  
*'''Embed report titles into main menu''' - This will override any other menu titles you have entered earlier and name them after the report titles.
+
[[Image:reports_viewed.png|thumb|The Reports Viewed page showing which students' reports have been viewed by parents]]
  
<br> <br>
+
Insight can display a report showing a list of students who have/have not had their documents viewed using the Subjects feature above. This report can also show any '''Feedback''' given relating to the documents. <br> <br>
  
===Frequently reported issues===
+
The report is accessed via: <br>
<br>
+
'''Reports > Reports Viewed''' <br> <br>
  
*'''Reports are not ordered correctly''' - If you wish INSIGHT to order the reports, you must ensure that the word "YEAR" followed by a space and then a number is included in the 'Summary' for the report in SIMS. This is so that INSIGHT can calculate out how old a report is (and order them accordingly)... If INSIGHT can’t it will revert to uploaded date.
+
Select the '''Year groups''' and '''Date range''' that you would like to report on then click the '''Report''' button. The report will display the students separated into two groups; those whose reports have been viewed and those whose have not. Details about what kind of user (parent or student) viewed the report and how many times will appear in brackets after the student's name. <br> <br>
  
*'''Reports do not display correctly when accessed''' - Reports of various formats are converted to .pdf format as they are requested by a user. Often, this process if successful and ensures that a report is displayed in exactly the same way in which it is displayed originally in SIMS. However, sometimes the conversion process does not work and results in reports not being displayed correctly when accessed... To resolve this issue, please follow all outlined steps detailed here... <br>  
+
Once this list is shown at the bottom of the page, a '''Notice''' button will appear which can be used to '''[[notices|send a notice]]''' to all of the Insight accounts that linked to students whose reports have not been viewed. <br> <br>
http://tascsoftware.com/wiki/insight/index.php?title=Batch_PDF_operations
 
  
[[Category:Usage]]
+
If users have given feedback about the reports, their responses can be viewed on the '''Feedback''' tab.  <br> <br>

Latest revision as of 14:16, 5 October 2018

The Subjects menu bar section showing two Linked Documents

The Subjects option in Insight will show some of a pupil's Linked Documents. These documents can be printed, downloaded or viewed online.

The Subjects section is accessed by clicking the Subjects option on the Insight Menu Bar (although Subjects can be renamed using the Roles page).

Documents

By default Insight will display all of the documents with a Type of AM Individual Report and a Status of Public in SIMS. Documents with a Status of Private or Confidential are never shown.

The Pupil Report option in SIMS

The following preference will prevent Parental Users from viewing the documents on this page unless they have the Pupil Report option enabled in SIMS:
Preferences > Reports > Use the SIMS Pupil Report field to decide whether to show reports (Off to show documents to all users)

The AM Individual Reports can be filtered so that only some are shown using the following Role Option. Enter one or more key words or phrases into this option. AM Individual Reports will only be included if their title matches any of the key words/phrases. Each key word/phrase should appear after a plus symbol. If there are multiple key words/phrases they should be separated by a pipe symbol (|).
Subjects > Report Documents filter
(For example, to filter out all AM Individual Reports that don't include either "Report" or "Assessment" you should enter +Report|+Assessment )


There are Role Options that can be used to hide documents which were uploaded to SIMS before or after a given date:
Subjects > Earliest date (Documents uploaded before this date will be hidden)
Subjects > Latest cutoff date (Documents uploaded after this date will be hidden)

General Documents

Documents where the Type is General Documents are not shown by default but can displayed. To show these documents, use the following Role Option. Enter one or more key words or phrases into this option. General Documents will be included if their title matches any of the key words/phrases. Each key word/phrase should appear after a plus symbol. If there are multiple key words/phrases they should be separated by a pipe symbol (|).
Subjects > Include general documents containing

(For example, to show all documents including either "UCAS" or "Application form" you should enter +UCAS|+Application form )
(If you would like to display all Linked Documents, enter a pipe symbol only into the Role Option)

PDF Documents

Some devices may not be able to display some document types correctly (this is very likely to be a problem for Insight app users trying to view XML documents). If reports have been generated in SIMS, the format of the documents may be XML. If this is the case, you may wish to convert your linked documents to PDF format which is generally more compatible.

There is a feature in Insight to batch convert Linked Documents to PDF format. This feature is accessed via:
Manage > Batch PDF processes

The Batch PDF Processes feature will not remove the old XML documents from SIMS, however they can be hidden from Insight using the following role option:
Subjects > Hide non-PDFs (On)

Additionally you can set a date for this begin. Any non-PDF documents uploaded earlier than this date will still be shown in Insight:
Subjects > only after

Attendance

A report showing Attendance and the Feedback button

The student's attendance can be shown alongside each document if desired. The figure given for attendance uses the AM and PM sessions only (not lesson data). To enable this feature, use the following Role Option:
Subjects > Show attendance info (On)

Report Feedback

You can allow users to give written feedback about the reports and documents displayed in the Subjects section. The following Role Option needs to be enabled for users to do this:
Subjects > Allow feedback (On)

Any comments that have been added can be viewed on the Reports Viewed report (see Reports Viewed below).

Insight can also send an email to a nominated email address when Feedback is recorded for a document. To enable this feature, enter the email address into the following preference:
Preferences > Email > Send emails to these addresses when Report Feedback is entered

iSome configuration may be required for Insight to send emails. See the communication setup page for further information.


Grade Summary

The Grade Summary page

The Grade Summary shows a list of the student's grades from Assessment Manager. Grades are divided into their corresponding Result Sets.

The Grade Summary page is enabled using the following Role Option:
Subjects > Show grade summary (On)

The Grade Summary page is then accessed via:
Subjects > Grade Summary

The Grade Summary page cannot show grades from PARS (including SIMS Assessment Manager grades that have been pulled into PARS). Therefore if you wish to use the Grade Summary page you must import the desired grades from SIMS (see the Assessments page for more information).

Changing the Format and Display

Using Grade Set Descriptions

The layout and display of the data on the Grade Summary page can be changed using various Role Options. The Grade Summary can display the Grade Description for each grade rather than the grade itself (as taken from the Grade Set in SIMS) if the following Role Option is enabled:
Subjects > Using gradeset descriptions'

Reordering the Grade Summary Data

The results for the student will be arranged into Result Set groups and ordered chronologically. The default is to order to the Result Sets from oldest aat the top to newest at the bottom. You can reverse this by enabling the following role option:
Subjects > Latest first (On)

Within each Result Set group, the aspects will be ordered alphabetically by default. You can reorder the aspects using a text file on the IIS server that hosts Insight. You will also need to enable the following Role Option:
Subjects > Use _Personalisation\aspect.priorities file

The text file is found in the _Personalisation folder of the Insight installation, which is typically located:
C:\wwwroot\inetput\INSIGHT\_Personalisation

The file to be edited will either be called aspect.priorities or aspect.priorities.unused. If you have a file called aspect.priorities then open that file using Notepad or a similar basic text editor (not Microsoft Word or Google Docs!). If you do not have an aspect.priorities file but do have an aspect.priorities.unused file, then edit the aspect.priorities.unused file, remove the .unused extension, then edit the file using Notepad or similar basic text editor. If you do not have either file, run a service pack then refresh the _Personalisation folder.

In the text file each aspect can be given a priority number. On the Grade Summary page, aspects are ordered by their priority (higher priority appear at the top of the list of aspects). Aspects that are not specified in the aspects.priorities file are treated as if they have a priority of 0.

Priorities much be specified separately for each year group. Each year group has a set of tags in the format <ncyear value="x"> </ncyear>
Each aspect can then be given a priority with a line of text in the following format <aspect.priority aspect="ASPECT NAME" priority="XX" />

For example, to show reorder the page so that Attainment grades are shown above Effort grades, the text file might look something like this:

<aspect.priorities>
   <ncyear value="10">
       <aspect.priority aspect="English Attainment" priority="2" />
       <aspect.priority aspect="English Effort" priority="1" />
   </ncyear>
   <ncyear value="11">
       <aspect.priority aspect="English Attainment" priority="2" />
       <aspect.priority aspect="English Effort" priority="1" />
   </ncyear>
</aspect.priorities>

Limiting the Data Shown

You can limit the data shown on the Grade Summary page using the following Role Options:
Subjects > For these years
Subjects > For how many previous academic years
Subjects > Or specify other amounts for specific yeargroups
Subjects > Latest date

The entire Grade Summary page can be hidden from students in certain year groups using the following Role Option:
Subject > For these years
(Enter an asterix into this setting to show the Grade Summary page to all students, or enter specific year groups separate by a plus symbol e.g. 10+11)

The following Role Option determines the number of previous years' data that will be shown on the Grade Summary:
Subjects > For how many previous academic years

Alternatively you can display different amounts of previous years' data for each year group if desired. To do this use the following Role Option:
Or specify other amounts for specific yeargroups
(Enter each year group followed by a comma, then the number of previous years' data to be shown and separate each year group with a plus symbol. If you do not specify a year group, that group will show the number of previous year' data as specified in the For how many previous academic years option.)

Have Reports/Documents been Viewed?

The Reports Viewed page showing which students' reports have been viewed by parents

Insight can display a report showing a list of students who have/have not had their documents viewed using the Subjects feature above. This report can also show any Feedback given relating to the documents.

The report is accessed via:
Reports > Reports Viewed

Select the Year groups and Date range that you would like to report on then click the Report button. The report will display the students separated into two groups; those whose reports have been viewed and those whose have not. Details about what kind of user (parent or student) viewed the report and how many times will appear in brackets after the student's name.

Once this list is shown at the bottom of the page, a Notice button will appear which can be used to send a notice to all of the Insight accounts that linked to students whose reports have not been viewed.

If users have given feedback about the reports, their responses can be viewed on the Feedback tab.