Difference between revisions of "AM charts"

From InsightWiki
Jump to navigation Jump to search
Line 1: Line 1:
 
__FORCETOC__
 
__FORCETOC__
There is a [[role options|role option]] that allows users to view graphs of assessment data on the [[assessments]]. The AM charts page is used to configure custom charts. <br> <br>
+
The AM charts page is used to configure bar charts that appear on the [[assessments]] page (users will need the "Show progress charts" [[role options|role option]] enabled to see the charts). The charts can either be configured via the AM charts page, or by editing a text file on the IIS server that hosts Insight. <br> <br>
  
Charts can either be configured by using the AM charts page, or by editing a text file on the IIS server that hosts Insight. Editing the text file is often quicker and easier. <br> <br>
+
In order for charts to be displayed, grades must be collected from SIMS rather than [[TASC Software Community Portal|PARS]]. The setting for this is found via [[Preferences]] > PARS > Collect grades from PARS (this is only applicable to schools using PARS). <br> <br>
  
Note: aspects with double spaces in their names cannot be used to create charts. <br> <br>
+
[[Image:amchartexample.jpg|500px]] <br> <br>
  
==The AM charts page==
+
=Using the AM charts page=
  
To create a new chart, scroll to the bottom of the AM charts page to find a blank section. The chart will need to be given a title first, then the columns of data can be added. <br> <br>
+
At the top of the page there is a "Live" option. This must be switched on in order for charts to be displayed to users. The rest of the page is used to configure the charts. <br> <br>
  
Click on the edit button in the chart section to open a new window. <br> <br>
+
Each chart needs to be given a title. There is an edit button which opens a window to add a column to the chart. In the window there are options to select an Aspect and Result Set, from which the data will be taken. There is also a "Column title source" option used to label the column, which can be set to either Aspect, Result Set or Both. <br> <br>
  
[[Image:AM_charts_edit.jpg]] <br> <br>
+
[[Image:am_charts_labels.jpg|frame|left|The output from each Column title source setting]] <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br>
  
Then click the edit button on the right to open a window where you can select an aspect and resultset. <br> <br>
+
Each chart will need one or more columns added to it in order for it to be displayed to users. Multiple charts can be created and will look similar to the following: <br> <br>
  
This screen allows you to create any number of charts to be displayed and allows you to specify which Aspect and Resultset pairs you wish to use for each chart element. <br><br>
+
[[Image:am_charts.jpg]] <br> <br>
  
'''Toward the top of the screen is a switch that will turn 'On' your custom charts.'''
+
=Using the text file on the IIS server=
If this is 'Off', the default charts will be displayed in line with the users 'Role Options'. If it is 'On' , your configuration will be used. <br><br>
 
  
Below this, you will see a number of repeated chart configurations, initially just for the one new item. <br><br>
+
There is a file on the server that hosts Insight which can be used to create the AM charts. The file is found in the _Personalisation folder, which is typically C:\wwwroot\inetput\INSIGHT\_Personalisation. The file will either be called assessments.charts or assessments.charts.unused <br> <br>
  
Each chart is comprised of three things: <br>
+
If you have a file called assessments.charts then open that file using Notepad or a similar basic text editor (not Microsoft Word!). If you do not have an assessment.charts file but do have an assessments.charts.unused file, then edit the assessments.chart.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 an [[service pack|Insight service pack]]. <br> <br>
1. '''A Title''' - This will be displayed next to the chart.<br>
 
2. '''An Optional Y-Scale''' - Automatically chosen for the user each time unless you provide an override.<br>
 
3. '''A set of Aspect and Resultset Pairs''' - these supply the data within the chart. <br><br>
 
  
'''To add a new Aspect/Resultset pair to a chart -''' <br>
+
The first line of the file must always read:
Click the 'Edit' button located to the right of an empty or configured line. You will be asked to select an Aspect and a Resultset. <br>
+
<pre>
Separately, you will need to select how the X-Axis label of the column will be identified (You can use either OR both Aspect and Resultset names). <br><br>
+
<root>
 
+
</pre> <br>
You can continually add new charts and columns to charts, although it is advisable to periodically check how they appear to a user.
 
 
 
==Editing the file on the IIS server==
 
 
 
On the web server, under the main Insight folder is another folder named "_Personalisation".  This folder is used to record changes to your set up which will not be reversed by applying service packs.  Inside the "_Personalisation" folder, you will initially find a file named "assessments.charts.unused".  The "unused" portion tells Insight not to use the contents of the file, so to define your own charts, in the first instance rename the file to remove the ".unused" from the end of the filename. <br> <br>
 
 
 
Open the "assessments.charts" file in a text editor such as Notepad.  You will see the definition of some sample charts, which because they are not specifically designed for your school are unlikely to work out of the box. <br> <br>
 
 
 
The first sample represents a chart showing nine samples of a single aspect over Key Stage 3. <br> <br>
 
  
 +
Following that, a new chart can be created by adding the following line of text:
 
<pre>
 
<pre>
<chart id="aspect 1" />
+
<chart id="ENTER TITLE HERE" />
<aspect chart="aspect 1" aspect="Science Attainment Level" resultset="Year 7 Autumn Term" xlabel="r" />
 
<aspect chart="aspect 1" aspect="Science Attainment Level" resultset="Year 7 Spring Term" xlabel="r"/>
 
<aspect chart="aspect 1" aspect="Science Attainment Level" resultset="Year 7 Summer Term" xlabel="r"/>
 
 
<aspect chart="aspect 1" aspect="Science Attainment Level" resultset="Year 8 Autumn Term" xlabel="r"/>
 
<aspect chart="aspect 1" aspect="Science Attainment Level" resultset="Year 8 Summer Term" xlabel="r"/>
 
<aspect chart="aspect 1" aspect="Science Attainment Level" resultset="Year 8 Spring Term" xlabel="r"/>
 
 
<aspect chart="aspect 1" aspect="Science Attainment Level" resultset="Year 9 Autumn Term" xlabel="r"/>
 
<aspect chart="aspect 1" aspect="Science Attainment Level" resultset="Year 9 Spring Term" xlabel="r"/>
 
<aspect chart="aspect 1" aspect="Science Attainment Level" resultset="Year 9 Summer Term" xlabel="r"/>
 
 
</pre>
 
</pre>
 +
Where ENTER TITLE HERE is replaced by the title for the chart. <br> <br>
  
In explanation, the first line states that there is to be a chart, and it will be identified as "aspect1".  You could call this pretty much anything, and this will also be used as the title for the chart. <br> <br>
+
Columns are then added using the following line of text, repeated for each column on the chart:
 
 
After the "chart" line follow a number of "aspect" lines, each of which represent a column in the eventual chart.  Each "aspect" line contains a number of parameters.  The first ties the line to a particular chart, so the value of "chart=" should normally be the same as the "id=" value from the preceding "chart" row. <br> <br>
 
 
 
Next follow the name of the aspect and result-set respectively.  These need to match exactly the names defined in SIMS. <br> <br>
 
 
 
Lastly there is an "xlabel" parameter, which defined the title for that column on the chart.  You can use "r" to designate that the name of the result set should be used - as the aspect stays the same in this example, this is what is used.  For the aspect name, you could use "a", or in the case of the last column in the sample, "ar". <br> <br>
 
 
 
You can use the same result-set for each column if required, and show different aspects from the same sample.  This is represented by the second sample: <br> <br>
 
 
 
 
<pre>
 
<pre>
<chart id="English Levels" />
+
<aspect chart="ENTER TITLE HERE"   aspect="ENTER ASPECT NAME"   resultset="ENTER RESULT SET NAME"   xlabel="ENTER LABEL" />
<aspect chart="English Levels" aspect="EN KS2: English Test Lev" resultset="Key Stage 2 Validated Result" xlabel="a"/>
 
<aspect chart="English Levels" aspect="EN KS2: Reading Test Level" resultset="Key Stage 2 Validated Result" xlabel="a"/>
 
<aspect chart="English Levels" aspect="EN KS2: Writing Test Level" resultset="Key Stage 2 Validated Result" xlabel="a"/>
 
 
</pre>
 
</pre>
 +
The name of the chart, the Aspect and the Result Set must be entered into the relevant sections. If the aspect is not associated with a Result Set, no text should be entered into the resultset option. The xlabel option can be set to: <br>
 +
a - for the name of the Aspect <br>
 +
r - for the name of the Result Set <br>
 +
ra - for the name of the Aspect and Result Set <br> <br>
  
In this example, three different Key Stage 2 aspects as recorded in the same result-set are plotted against each other. In this case the column titles are set to be the name of the aspect. It is expected that the y axis scale for the three aspects are of the same order of magnitude, or are suitable for direct comparison. <br> <br>
+
The lines above can be repeated to create multiple charts and columns. The final line of text must read:
 +
<pre>
 +
</root>
 +
</pre> <br>
  
If one of the aspects used were to be a target or base line figure and not sampled in result-sets, a slightly difference is used in the format of the result-set parameter. <br> <br>
+
This example represents a chart showing nine samples of a single aspect over Key Stage 3.
 +
<pre>
 +
<chart id="KS3 Science Level" />
 +
<aspect chart="KS3 Science Level" aspect="Science Attainment Level" resultset="Year 7 Autumn Term" xlabel="r" />
 +
<aspect chart="KS3 Science Level" aspect="Science Attainment Level" resultset="Year 7 Spring Term" xlabel="r"/>
 +
<aspect chart="KS3 Science Level" aspect="Science Attainment Level" resultset="Year 7 Summer Term" xlabel="r"/>
 +
 +
<aspect chart="KS3 Science Level" aspect="Science Attainment Level" resultset="Year 8 Autumn Term" xlabel="r"/>
 +
<aspect chart="KS3 Science Level" aspect="Science Attainment Level" resultset="Year 8 Summer Term" xlabel="r"/>
 +
<aspect chart="KS3 Science Level" aspect="Science Attainment Level" resultset="Year 8 Spring Term" xlabel="r"/>
 +
                                       
 +
<aspect chart="KS3 Science Level" aspect="Science Attainment Level" resultset="Year 9 Autumn Term" xlabel="r"/>
 +
<aspect chart="KS3 Science Level" aspect="Science Attainment Level" resultset="Year 9 Spring Term" xlabel="r"/>
 +
<aspect chart="KS3 Science Level" aspect="Science Attainment Level" resultset="Year 9 Summer Term" xlabel="r"/>
 +
</pre> <br>
  
 +
This example shows different Aspects sampled from the same Result Set:
 
<pre>
 
<pre>
<chart id="dunno" yscale="0..20"/>
+
<chart id="GCSE Targets" />
<aspect chart="dunno" aspect="2 Levels Progress English" resultset="" xlabel="a"/>
+
<aspect chart="GCSE Targets" aspect="GCSE Art Target"            resultset="Year 10 Target" xlabel="a"/>
<aspect chart="dunno" aspect="2 Levels Progress Maths" resultset="" xlabel="a"/>
+
<aspect chart="GCSE Targets" aspect="GCSE Biology Target"        resultset="Year 10 Target" xlabel="a"/>
<aspect chart="dunno" aspect="EN KS2: Writing Test Level" resultset="Key Stage 2 Validated Result" xlabel="a"/>
+
<aspect chart="GCSE Targets" aspect="GCSE Chemistry Target"      resultset="Year 10 Target" xlabel="a"/>
 +
<aspect chart="GCSE Targets" aspect="GCSE Computing Target"      resultset="Year 10 Target" xlabel="a"/>
 +
<aspect chart="GCSE Targets" aspect="GCSE Dance Target"          resultset="Year 10 Target" xlabel="a"/>
 +
<aspect chart="GCSE Targets" aspect="GCSE Drama Target"          resultset="Year 10 Target" xlabel="a"/>
 +
<aspect chart="GCSE Targets" aspect="GCSE English Target"         resultset="Year 10 Target" xlabel="a"/>
 
</pre>
 
</pre>
 
In this example the first two columns represent result-set less aspects, and so the result-set name is left empty. As expected the column title will be the name of the aspect. <br> <br>
 
 
Additionally in this example, which mixes aspects in an unlikely way, it is also necessary to define a scale for the y axis.  This may sometimes be necessary when grades are likely to clump near the top or bottom of a scale, to the degree that the automatically selected extends may not be suitable. <br> <br>
 
 
 
  
 
[[Category:Configuration]]
 
[[Category:Configuration]]
 +
[[Category:Technical]]

Revision as of 11:33, 9 December 2015

The AM charts page is used to configure bar charts that appear on the assessments page (users will need the "Show progress charts" role option enabled to see the charts). The charts can either be configured via the AM charts page, or by editing a text file on the IIS server that hosts Insight.

In order for charts to be displayed, grades must be collected from SIMS rather than PARS. The setting for this is found via Preferences > PARS > Collect grades from PARS (this is only applicable to schools using PARS).

Amchartexample.jpg

Using the AM charts page

At the top of the page there is a "Live" option. This must be switched on in order for charts to be displayed to users. The rest of the page is used to configure the charts.

Each chart needs to be given a title. There is an edit button which opens a window to add a column to the chart. In the window there are options to select an Aspect and Result Set, from which the data will be taken. There is also a "Column title source" option used to label the column, which can be set to either Aspect, Result Set or Both.

The output from each Column title source setting























Each chart will need one or more columns added to it in order for it to be displayed to users. Multiple charts can be created and will look similar to the following:

Am charts.jpg

Using the text file on the IIS server

There is a file on the server that hosts Insight which can be used to create the AM charts. The file is found in the _Personalisation folder, which is typically C:\wwwroot\inetput\INSIGHT\_Personalisation. The file will either be called assessments.charts or assessments.charts.unused

If you have a file called assessments.charts then open that file using Notepad or a similar basic text editor (not Microsoft Word!). If you do not have an assessment.charts file but do have an assessments.charts.unused file, then edit the assessments.chart.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 an Insight service pack.

The first line of the file must always read:

<root>


Following that, a new chart can be created by adding the following line of text:

<chart id="ENTER TITLE HERE" />

Where ENTER TITLE HERE is replaced by the title for the chart.

Columns are then added using the following line of text, repeated for each column on the chart:

<aspect chart="ENTER TITLE HERE"   aspect="ENTER ASPECT NAME"   resultset="ENTER RESULT SET NAME"   xlabel="ENTER LABEL" />

The name of the chart, the Aspect and the Result Set must be entered into the relevant sections. If the aspect is not associated with a Result Set, no text should be entered into the resultset option. The xlabel option can be set to:
a - for the name of the Aspect
r - for the name of the Result Set
ra - for the name of the Aspect and Result Set

The lines above can be repeated to create multiple charts and columns. The final line of text must read:

</root>


This example represents a chart showing nine samples of a single aspect over Key Stage 3.

<chart id="KS3 Science Level" />
	<aspect chart="KS3 Science Level" 	aspect="Science Attainment Level" 	resultset="Year 7 Autumn Term" xlabel="r" />
	<aspect chart="KS3 Science Level" 	aspect="Science Attainment Level" 	resultset="Year 7 Spring Term" xlabel="r"/>
	<aspect chart="KS3 Science Level" 	aspect="Science Attainment Level" 	resultset="Year 7 Summer Term" xlabel="r"/>
	
	<aspect chart="KS3 Science Level" 	aspect="Science Attainment Level" 	resultset="Year 8 Autumn Term" xlabel="r"/>
	<aspect chart="KS3 Science Level" 	aspect="Science Attainment Level" 	resultset="Year 8 Summer Term" xlabel="r"/>
	<aspect chart="KS3 Science Level" 	aspect="Science Attainment Level" 	resultset="Year 8 Spring Term" xlabel="r"/>
	                                        
	<aspect chart="KS3 Science Level" 	aspect="Science Attainment Level" 	resultset="Year 9 Autumn Term" xlabel="r"/>	
	<aspect chart="KS3 Science Level" 	aspect="Science Attainment Level" 	resultset="Year 9 Spring Term" xlabel="r"/>
	<aspect chart="KS3 Science Level" 	aspect="Science Attainment Level" 	resultset="Year 9 Summer Term" xlabel="r"/>


This example shows different Aspects sampled from the same Result Set:

<chart id="GCSE Targets" />
	<aspect chart="GCSE Targets" 	 aspect="GCSE Art Target"             resultset="Year 10 Target" xlabel="a"/>
	<aspect chart="GCSE Targets" 	 aspect="GCSE Biology Target"         resultset="Year 10 Target" xlabel="a"/>
	<aspect chart="GCSE Targets" 	 aspect="GCSE Chemistry Target"       resultset="Year 10 Target" xlabel="a"/>
	<aspect chart="GCSE Targets" 	 aspect="GCSE Computing Target"       resultset="Year 10 Target" xlabel="a"/>
	<aspect chart="GCSE Targets" 	 aspect="GCSE Dance Target"           resultset="Year 10 Target" xlabel="a"/>
	<aspect chart="GCSE Targets" 	 aspect="GCSE Drama Target"           resultset="Year 10 Target" xlabel="a"/>
	<aspect chart="GCSE Targets" 	 aspect="GCSE English Target"         resultset="Year 10 Target" xlabel="a"/>