Entity Field Specifications

This table lists the different entities in Accelerus, their fields and the properties of these. When adding new records, importing data or modifying records, the data must conform to the specifications as set out here.

Data Type	Field	Types of data allowed	Maximum characters	Mandatory
Assessment item	Item Code	Alphanumeric, underscore, hyphen, apostrophe	20	Yes
	Description	All characters	150	Yes
	Long Description	All characters	Unlimited	No
	Marking scheme	Must be a valid Marking scheme code	20	Yes
	Calculations	Any valid calculation	Unlimited	No
	Tag	Any valid tag	20 per tag	No
	Lock State	Locked/NotLocked, Yes/No, True/False	10	Yes, but defaults to unlocked
	Restricted	Restricted/Available, Yes/No, True/False	10	Yes, but defaults to available
Class	Academic Cycle	Must be a valid academic cycle	20	Yes
	Class Code	Alphanumeric, underscore, hyphen, apostrophe	20	Yes
	Subject Code	Must be a valid subject code	20	Yes
	Class Name	All characters	80	Yes
	Class Description	All characters	Unlimited	No
	Class Role eg class teacher	Must be a valid teacher	20	No
Cohort	Academic Cycle	Must be a valid academic cycle	20	Yes
	Cohort Code	Alphanumeric, underscore, hyphen, apostrophe, full stop	20	Yes
	Cohort Name	All characters	80	Yes
	Cohort Role eg coordinator	Must be a valid teacher	20	No
Enrolments	Student Code	Must be a valid student code	20	Yes
Enrolments	Class Code	Must be a valid class code	20	Yes
Marking scheme – Comment	Code	Alphanumeric, underscore, hyphen, apostrophe	20	Yes
	Description	Any characters	150	Yes
	Maximum Length	Whole numbers	10	Yes, if Limited length is ticked
Marking scheme – Numeric	Code	Alphanumeric, underscore, hyphen, apostrophe	20	Yes
	Description	All characters	150	Yes
	Minimum Value	Numeric	29	Yes
	Maximum Value	Numeric greater than or equal to minimum value	29	Yes
	Rounding Factor	Numeric – must be compatible with the number of decimals	29	Yes
	Decimal	Numeric between 0-6	1	Yes
	Displayed Value	Any characters	Unlimited	No
	Printed Value	Any characters	Unlimited	No
Marking scheme – List	Code	Alphanumeric, underscore, hyphen, apostrophe	20	Yes
	Description	Any characters	150	Yes
	Entered Value	Any characters	20	Yes
	Displayed Value	Any characters	Unlimited	No
	Printed Value	Any characters	Unlimited	No
Student	Code	Alphanumeric, space, underscore, hyphen, apostrophe	20	Yes
	Family Name	Any characters	50	Yes
	Given Name	Any characters	50	Yes
	Preferred Name	Any characters	50	Yes
	Gender	M, F or Male, Female	1	Yes
	Cohort Group	Must be a valid cohort group	20	No
	Password	All alphanumeric and keyboard characters, but defaults to the student’s code	20	Yes
	Domain User Name	All characters allowed in Microsoft Active Directory for domain user names, including backslash.	255	No, unless Active Directory without prompting selected
	Start Date	Must be a valid date	10	No
	End Date	Must be a valid date. Must be after start date	10	No
Subject	Academic Cycle	Must be a valid academic cycle	20	Yes
	Code	Alphanumeric, underscore, hyphen, apostrophe	20	Yes
	Name	Any characters	80	Yes
	Description	Any characters	Unlimited	No
	Subject Level	Must be a valid subject level	20	Yes
	Report Template Slot	Any characters	30	No
	Subject role	Must be a valid teacher	20	No
Teacher	Code	Alphanumeric, underscore, hyphen, apostrophe	20	Yes
	Family Name	Any characters	50	Yes
	Given Name	Any characters	50	Yes
	Preferred Name	Any characters	50	No
	Title	Any characters	10	No
	Start Date	Must be a valid date	10	No
	End Date	Must be a valid date. Must be after start date	10	No
	Gender	M, F or Male, Female	1	No
	Password	All alphanumeric and keyboard characters, but defaults to the teacher’s code	20	Yes
	Domain User Name	All characters allowed in Microsoft Active Directory for domain user names, including backslash.	255	No, unless Active Directory without prompting selected
School Settings – Academic Cycle Category	Code	Alphanumeric, underscore	4	Yes
School Settings – Academic Cycle Category	Category Name	Any characters	20	Yes
School Settings – Academic Cycle	Category Name	Any characters	20	Yes
School Settings – Cohort Type	Code	Alphanumeric, underscore	4	Yes
School Settings – Cohort Type	Name	All characters	50	Yes
School Settings – Subject Levels	Name	All characters	50	Yes
School Settings - Assessment Item Tags	Tag	All characters	20	Yes
School Settings - Student Custom Properties	Code	Alphanumeric, underscore	8	Yes
	Name	All characters	150	Yes
	Marking Scheme	Must be valid marking scheme code	20	Yes
	Academic Cycle Category	Must be a valid academic cycle category	20	Yes
Security	School Role Name	All characters	80	Yes
	Subject Role Name	All characters	40	Yes
	Subject Role Code	Alphanumeric, underscore	4	Yes
	Class Role Name	All characters	40	Yes
	Class Role Code	Alphanumeric, underscore	4	Yes
	Cohort Role Name	All characters	40	Yes
	Cohort Role Code	Alphanumeric, underscore	4	Yes