Review designer - Revision history

Admin at 13:21, 15 May 2020

2020-05-15T13:21:03Z

Admin at 13:20, 15 May 2020

2020-05-15T13:20:11Z

Admin at 13:13, 15 May 2020

2020-05-15T13:13:51Z

Admin: /* A mockup of how you would like the final report to look. */

2018-01-15T09:24:15Z

A mockup of how you would like the final report to look.

Admin: /* A list of grade element codes to be used on the report */

2018-01-04T10:49:55Z

A list of grade element codes to be used on the report

Admin: /* A mockup of how you would like the final report to look. */

2017-11-24T10:59:02Z

A mockup of how you would like the final report to look.

Admin: /* Submitting a design to be created */

2017-11-24T10:11:27Z

Submitting a design to be created

Admin: /* A list of grade element codes to be used on the report */

2017-11-23T12:03:15Z

A list of grade element codes to be used on the report

Admin: /* A list of grade element codes to be used on the report */

2017-11-22T14:24:03Z

A list of grade element codes to be used on the report

Admin: /* A list of grade element codes to be used on the report */

2017-11-17T12:50:40Z

A list of grade element codes to be used on the report

@@ Line 27: / Line 27: @@
 *If there are multiple grade element codes that are all used in the same column and all share a similar code (e.g. an "Effort" column should contain grades with codes EFF_EN, EFF_MA, EFF_SCI etc) then only the shared part of the code is needed (in this case "EFF_").
 *If the grade element is scheduled multiple times in a year then a way to distinguish the correct grades for each time period is needed. Refer back to the [[Default slip]] to find out what should be used, it will either be the EV_INST_ID, the DATE or part of the SIMSDETAIL fields. Please include the correct information for each period in the submission. For SIMS grades the SIMSDETAIL is the one that is needed, but only the part that is common to all grades in a particular column.
-*To reiterate: '''There is NO NEED to include every single grade element code where multiple codes all share a common set of letters.'''
+'''There is NO NEED to include every single grade element code where multiple codes all share a common set of letters.'''
 [[image:ExampleSubmission.PNG]]

@@ Line 18: / Line 18: @@
 *This could be a Word document or Image file and should resemble the final report as closely as possible. If it is an image file then a list of fonts and font sizes is needed.
 *It should include any images (logos etc) and layout.
-*'''Each column or other grade/comment container on the mock up should show which grade element code is to appear in that column (see below). A design submitted without these data included will be ignored.'''
+*'''Each column or other grade/comment container on the mock up should show which grade element code is to appear in that column (see below).'''
 *Where multiple columns use the same grade element code, or where the same code is reused multiple times each year, the exact Result Set, EV_INST_ID or Date range should be included. These can be found by using the [[Default slip]]. <Br> <br>
 === A list of grade element codes to be used on the report ===
-'''It's very rare for a design to be submitted following the guidelines here, designs submitted either have actual grades inserted or every single grade element code where only one is needed. To save yourself a lot of time please read them carefully including the notes below the table.
 *The grade element codes are visible on the [[configure grading elements]] screen in the left hand column.
 *If there are multiple grade element codes that are all used in the same column and all share a similar code (e.g. an "Effort" column should contain grades with codes EFF_EN, EFF_MA, EFF_SCI etc) then only the shared part of the code is needed (in this case "EFF_").

← Older revision		Revision as of 13:13, 15 May 2020
Line 7:		Line 7:

	=Submitting a design to be created=		=Submitting a design to be created=
−
−	''Writing the script to create a Student Review is straightforward and usually takes a couple of hours. Finding out how the script should work is usually very difficult and takes weeks. A typical new design will need at least 100-150 responses back and forth on the help desk. The reason for this is that people rarely follow the guidelines below, creating a huge amount of work for themselves that is not needed.''

	The process of creating a student review design will typically take approximately two weeks from the submission of the design and a valid [[OUTPUT.XML]] until a first draft is sent to you. In most cases the first draft will need several revisions to account for anomalies in your data and layout that may not be obvious until the first draft is seen. '''You should allow at LEAST one month from the point that all of the data requested below are sent until the report is ready to print'''. <br> <br>		The process of creating a student review design will typically take approximately two weeks from the submission of the design and a valid [[OUTPUT.XML]] until a first draft is sent to you. In most cases the first draft will need several revisions to account for anomalies in your data and layout that may not be obvious until the first draft is seen. '''You should allow at LEAST one month from the point that all of the data requested below are sent until the report is ready to print'''. <br> <br>

@@ Line 21: / Line 21: @@
 *It should include any images (logos etc) and layout.
 *'''Each column or other grade/comment container on the mock up should show which grade element code is to appear in that column (see below). A design submitted without these data included will be ignored.'''
-*Where multiple columns use the same grade element code, the exact Result Set, EV_INST_ID or Date range should be included. These can be found by using the [[Default slip]]. <Br> <br>
+*Where multiple columns use the same grade element code, or where the same code is reused multiple times each year, the exact Result Set, EV_INST_ID or Date range should be included. These can be found by using the [[Default slip]]. <Br> <br>
 === A list of grade element codes to be used on the report ===

← Older revision		Revision as of 10:49, 4 January 2018
Line 36:		Line 36:

	''EFF_* means "the codes in the column all start with EFF_" so there is no need to enter every EFF_ code. You can save a LOT of time by following this particular suggestion. Any exceptions to the rule (e.g. a subject that contains two different EFF_ grade codes and only one should be used) should be mentioned.'' <br> <br>		''EFF_* means "the codes in the column all start with EFF_" so there is no need to enter every EFF_ code. You can save a LOT of time by following this particular suggestion. Any exceptions to the rule (e.g. a subject that contains two different EFF_ grade codes and only one should be used) should be mentioned.'' <br> <br>
		+
		+	Please always refer to each subject by the actual name as it appear in PARS, SIMS and in the output.xml. E.g. if a special rule is requested for Mathematics but this appears throughout the software as "Maths" then the rule will not work.

	=== A list of rules required on report===		=== A list of rules required on report===

← Older revision		Revision as of 10:11, 24 November 2017
Line 7:		Line 7:

	=Submitting a design to be created=		=Submitting a design to be created=
		+
		+	''Writing the script to create a Student Review is straightforward and usually takes a couple of hours. Finding out how the script should work is usually very difficult and takes weeks. A typical new design will need at least 100-150 responses back and forth on the help desk. The reason for this is that people rarely follow the guidelines below, creating a huge amount of work for themselves that is not needed.''

	The process of creating a student review design will typically take approximately two weeks from the submission of the design and a valid [[OUTPUT.XML]] until a first draft is sent to you. In most cases the first draft will need several revisions to account for anomalies in your data and layout that may not be obvious until the first draft is seen. '''You should allow at LEAST one month from the point that all of the data requested below are sent until the report is ready to print'''. <br> <br>		The process of creating a student review design will typically take approximately two weeks from the submission of the design and a valid [[OUTPUT.XML]] until a first draft is sent to you. In most cases the first draft will need several revisions to account for anomalies in your data and layout that may not be obvious until the first draft is seen. '''You should allow at LEAST one month from the point that all of the data requested below are sent until the report is ready to print'''. <br> <br>

@@ Line 26: / Line 26: @@
 *The grade element codes are visible on the [[configure grading elements]] screen in the left hand column.
 *If there are multiple grade element codes that are all used in the same column and all share a similar code (e.g. an "Effort" column should contain grades with codes EFF_EN, EFF_MA, EFF_SCI etc) then only the shared part of the code is needed (in this case "EFF_").
-*If the a grade element is scheduled multiple times in a year then a way to distinguish the correct grades for each time period is needed. Refer back to the [[Default slip]] to find out what should be used, it will either be the EV_INST_ID, the DATE or part of the SIMSDETAIL fields. Please include the correct information for each period in the submission. If all grades in a review period have the same DATE field (or fall within the same date range that does not overlap any other periods), it is easiest to use this.
+*If the grade element is scheduled multiple times in a year then a way to distinguish the correct grades for each time period is needed. Refer back to the [[Default slip]] to find out what should be used, it will either be the EV_INST_ID, the DATE or part of the SIMSDETAIL fields. Please include the correct information for each period in the submission. If all grades in a review period have the same DATE field (or fall within the same date range that does not overlap any other periods), it is easiest to use this.
 *'''The report mock up MUST include grade element codes IN THE DESIGN as shown in the example below. If it does not you will be asked to resend it with the correct codes included. The table below is the actual mock up of the report rather than a separate table just listing codes.'''