PASIprep Field/Value Pair
This is a Widget for the PASIprep UI Guidelines.
A field/value pair shows a field label and either a read-only value for the field, or an input control for the field. They are usually used in Value List.
Label Guidelines
Should not end with a punctuation (no colons, question marks, etc.) - exception to the rule is boolean fields (which ends in '?')
Are top-aligned with the field value
Required fields are denoted with an asterisk (*) - this is an option provided by Angular input controls.
Displayed as title case
Commonly Used Field/Values
Below are the preferred field label and value formats for some common data elements used in different business objects (e.g. Use “Alberta Student Number” instead of “ASN”, “Preferred?” over “Is Preferred?”, etc.):
Alberta Student Number
Authority
Course
Is {field name}? (i.e. dropping the “Is” in front of most boolean fields, e.g. use “Preferred” instead of “Is Preferred”)
Organization (used if the value can be a school or an authority or others)
Reference #
School
Field Validation Messages
Standard input controls that can be used:
These widgets have 'special' behavior tailored to PASIprep:
Displaying Null Values
Displaying Boolean Values
Displaying Deleted Value
Displaying Code Values
Dependency Fields
If the entry of a field is dependent on the entry of a different field, there are two options to displaying the dependency:
Show a placeholder message in the field when an action is required first on a different field (e.g. if user must select a School Authority first before selecting a School as the options for School is dependent on the authority, when the School Authority field is blank, the School field can show “Please select an authority first” as a placeholder text), OR
Hide the field until the action that is required first is performed (e.g. if user must select a School Year first before selecting an Exam Session, the Exam Session field can be hidden until the user selects a School Year)
The first option is preferred for required fields (as the screen should not hide required fields, regardless if they have performed the dependent action yet or not).
Design and Testing Checklist
PASIprep Field/Value Pair
Are required fields identified? (if it is an editable field/value form)
Are hint texts defined for fields with labels that are not self-explanatory
Is the data format identified? (if it is an editable field/value form and the field requires a specific format)
If the value is a Code Value, is it shown in one of the accepted formats (usually Short Description would be visible)
Are commonly used field label and value pairs used when applicable?