PASIprep UI Guidelines Checklist

NOTE: Most of these items should be part of the BA Design Template or the Guidelines itself. Once that is verified this checklist can be deprecated.

The checklists below are meant as a reminder to BAs (during design), Tech Team (during development) and QAs (during testing) on items to watch for when one of the UI page content template, UI patterns, or UI widgets from the PASIprep UI Guidelines are used.

These items are expected in a 'typical' view; however there will also be exceptions to the case which should be clearly defined in the design.

General Checklist

  1. Security requirements checklist:
    1. Does the design consider and clearly define security requirements or restrictions in terms of:
      1. Time (i.e. does date or school year of record restricts the user's access to the record)
      2. Ownership of academic record (e.g. if a school owns the Course Enrolment do they get special access?)
  2. Security considerations for:
    1. Viewing the page
      1. When the security requirements to view the screen are not satisfied, does an error page (using PASIprep Error Page Template) displays?
    2. Viewing list of business objects / records
      1. When there are security restrictions on which records the user is allowed to view, are those restricted records filtered out in the application completely?
    3. Viewing data elements of a specific record
      1. When there are security restrictions on which data elements user is allowed to view, are those data elements (displayed as columns on a business object grid, a field/value pair, etc) hidden from the user, based on the rules defined in the design?
      2. When the user does not have access to View Student information (generally means they have no access to the View Student page for the student, are all student information data elements (except ASN) hidden on screen?
    4. Access to perform an action (e.g. [Edit] to access an Edit page)
      1. When the security requirements to perform an action are not satisfied, are methods to access those functions (e.g. buttons, links, action menu items) completely hidden from the user?
    5. Perform an action (e.g. [Delete] on a View Item page)
      1. When the security requirements to perform an action are not satisfied, are methods to perform the action (e.g. buttons, action menu items) completely hidden from the user?
      2. Is this action also guarded in the service level?

Page Content Template Checklists

List Items Template

PASIprep List Items Template

A typical List Item Templated screen should have the following:

  1. Page title starts with “List”?
    1. Browser title matches page title?
  2. An identifier subtitle is provided?
  3. Page contains a single Business Object Grid?
  4. The grid follows the standard Business Object Grid guideline?
  5. A full screen mode is available for the grid?
  6. If Grid Actions are available, is the grid selectable? Can user perform actions in bulk (which is preferred)?

View Item Template

PASIprep View Item Template

A typical View Item Templated screen should have the following:

  1. Page title starts with “View”?
    1. Browser title matches page title?
  2. Are badges required by the design? If so, does each badge have a meaningful tooltip?
  3. Are there Actions (in the Action toolbox) defined in the design for the context on screen? Actions related to the current 'context' is in an Actions Toolbox? (e.g. in a “View Student Phone Number” page, the context is Student Phone Number - actions managing that Student Phone Number should be in the toolbox)
    1. Are actions in the toolbox hidden when user has no security rights (e.g. permissions/associations) to perform the action?
    2. Do users get a validation error message when they perform an action that is not permissible based on the defined business rules?
  4. Is “Details” or “Summary” the default tab?
  5. If a Business Object grid is present…
    1. If Grid Actions are available, is the grid selectable? (single-select preferred.)
  6. Is the “Audit History” tab present when the record has an audit history?
    1. If so, does the grid follow the PASIprep Audit History Grid standard?
    2. If not, is “Last Updated” information (Last Updated On/By/Org) in the Details (or Summary) tab (if available on the record)? Is it position as the last row in the content?
  7. If the item the user is viewing can be deleted, is the “Deleted” flag in the Details (or Summary) tab?
    1. If so, does it follow the Deleted value pair standard?
    2. Is it position in near the top right corner of the content (e.g. first row, last field on a Value List)?
  8. PASIprep Work Item Cards appears on the page when the record has Core Alert(s) that are not Acknowledged?
  9. For each tab:
    1. Is the UI Pattern(s) used specified in the design? (Summary Cards, Card Groups, Business Object Grids, Field Value List)
      1. For each UI Pattern used, do they follow the standard guidelines?
    2. If the content is long or there is a mix of different types of content, are they arranged into sections with meaningful title?
  10. Does the screen follow the typical Navigation Between Bulk List of Items and Individual Item View flow with how the Back browser button behaves?

For screens that displays Demographic Information 1) for a specific student

  1. Student Identifier Subtitle (for the ASN tied to the record) is displayed?
    1. The Student Identifier Subtitle is in proper format, and the ASN & Name links to the View Student page for the ASN tied to the record?
    2. This is not visible if user has no access to View Student for the student displayed?
  2. Student-related Status Badges for the ASN tied to the record is displayed?
  3. This is not visible if user has no access to View Student for the student displayed?
  4. The Primary ASN tied to record is displayed in the Details (or Summary) tab as a link to the View Student page for that ASN?
    1. Is it position as the first field labeled “Alberta Student Number”? (or as close to the top of the content as possible?)
    2. This is not a link if user has no access to View Student for the student displayed?
  5. Is there an “active status” type of field on the business object? (e.g. “Preferred?”, “Active?”, Status field that indicates whether the record is active or not, etc)
    1. If so, is it positioned next to the ASN field?
  6. Is the Reference # displayed in the Details tab as the last field (if Reference # exists for the record)?

For screens that displays Academic Information 2) for a specific student

  1. Student Identifier Subtitle (containing the ASN's student information) is displayed?
    1. The Student Identifier Subtitle is in proper format, and the ASN & Name links to the View Student page for the ASN of the student in context?
    2. This is not visible if user has no access to View Student for the student displayed?
  2. Student-related Status Badges for the primary ASN is displayed?
    1. This is not visible if user has no access to View Student for the student displayed?
  3. The ASN tied to record is displayed in the Details (or Summary) tab as a link to the View Student page for that ASN? (NOTE: this is not necessary the Primary ASN!)
    1. Is it position as the first field labeled “Alberta Student Number”? (or as close to the top of the content as possible?)
    2. This is not a link if user has no access to View Student for the student displayed?
  4. Is there an “active status” type of field on the business object? (e.g. “Preferred?”, “Active?”, Status field that indicates whether the record is active or not, etc)
    1. If so, is it positioned next to the ASN field?

Add Item Template

PASIprep Add Item Template

A typical Add Item Templated screen should have the following:

  1. Page title starts with “Add”?
    1. Browser title matches page title?
  2. Is the item related to a student? If so, is the Student Identifier subtitle present?
  3. [Save] and [Cancel] buttons visible in Action Toolbox?
    1. [Save] is the default button?
      1. Pressing [Enter] on the keyboard when focus is on any field in the form (except Text Area) triggers the [Save] button?
    2. [Save] and [Cancel] takes user back to the page they came from (or the Home Page if they did not come from a PASIprep screen?)
      1. On [Save], if user is taken back to a page with a grid showing the record, is the saved record visible and selected/highlighted?
  4. Fields are laid out and follows the standard PASIprep Field Value List / Form guidelines?
  5. When user hits [Save] and is taken back to a Business Object Grid where the new record is shown, is the new record visible and selected in the grid?
  6. Does the screen follow the typical Navigation Between Bulk List of Items and Individual Item View flow with how the [Cancel] and [Save] behaves?
  7. Does a confirmation dialog shows when the user attempts to leave the screen before they save their updates?

For screens that adds Demographic Information 3) for a specific student

  1. Student Identifier Subtitle (for the ASN tied to the record) is displayed?
    1. The Student Identifier Subtitle is in proper format, and the ASN & Name links to the View Student page for the ASN tied to the record?
    2. This is not visible if user has no access to View Student for the student displayed?
  2. Student-related Status Badges for the ASN tied to the record is displayed?
    1. This is not visible if user has no access to View Student for the student displayed?
  3. The ASN tied to record is displayed?
    1. Is it position as the first field? (or as close to the top of the content as possible?)
  4. Is the Reference # displayed as the last field (if Reference # exists for the record)?

For screens that adds Academic Information 4) for a specific student

  1. Student Identifier Subtitle (containing the ASN's student information) is displayed?
    1. The Student Identifier Subtitle is in proper format, and the ASN & Name links to the View Student page for the ASN tied to the record in context?
    2. This is not visible if user has no access to View Student for the student displayed?
  2. Student-related Status Badges for the primary ASN is displayed?
    1. This is not visible if user has no access to View Student for the student displayed?
  3. The ASN tied to record is displayed?
    1. Is it position as the first field? (or as close to the top of the content as possible?)

Edit Item Template

PASIprep Edit Item Template

A typical Edit Item Templated screen should have the following:

  1. Page title starts with “Edit”?
    1. Browser title matches page title?
  2. Is the item related to a student? If so, is the Student Identifier subtitle present?
  3. [Save] and [Cancel] buttons visible in Action Toolbox?
    1. [Save] is the default button?
      1. Pressing [Enter] on the keyboard when focus is on any field in the form (except Text Area) triggers the [Save] button?
    2. [Save] and [Cancel] takes user back to the page they came from (or the Home Page if they did not come from a PASIprep screen?)
      1. On [Save], if user is taken back to a page with a grid showing the record, is the saved record visible and selected/highlighted?
  4. Fields are laid out and follows the standard PASIprep Field Value List / Form guidelines?
  5. Are Work Item Cards shown when there are work item(s) for the record?
  6. When user hits [Save] and is taken back to a Business Object Grid where the updated record is shown, is the updated record visible and selected in the grid?
  7. Does the screen follow the typical Navigation Between Bulk List of Items and Individual Item View flow with how the [Cancel] and [Save] behaves?
  8. PASIprep Work Item Cards appears on the page when the record has Core Alert(s) that are not Acknowledged?
  9. Does a confirmation dialog shows when the user attempts to leave the screen before they save their updates?

For screens that edits Demographic Information 5) for a specific student

  1. Student Identifier Subtitle (for the ASN tied to the record) is displayed?
    1. The Student Identifier Subtitle is in proper format, and the ASN & Name links to the View Student page for the ASN tied to the record?
    2. This is not visible if user has no access to View Student for the student displayed?
  2. Student-related Status Badges for the ASN tied to the record is displayed?
  3. The ASN tied to record is displayed and links to the View Student screen for the ASN?
    1. Is it position as the first field? (or as close to the top of the content as possible?)
    2. This is not a link if user has no access to View Student for the student displayed?
  4. Is the Reference # displayed as the last field (if Reference # exists for the record)?

For screens that edits Academic Information 6) for a specific student

  1. Student Identifier Subtitle (containing the ASN's student information) is displayed?
    1. The Student Identifier Subtitle is in proper format, and the ASN & Name links to the View Student page for the ASN of the student?
    2. This is not visible if user has no access to View Student for the student displayed?
  2. Student-related Status Badges for the primary ASN is displayed?
  3. The ASN tied to record is displayed and links to the View Student screen for the ASN?
    1. Is it position as the first field? (or as close to the top of the content as possible?)
    2. Is it labeled “Alberta Student Number”?
    3. This is not a link if user has no access to View Student for the student displayed?

UI Pattern Checklists

Business Object Grids

PASIprep Business Object Grid

(Please also be aware of the Exception Cases below this list, which describes cases where not everything in the following list applies)

  1. Data display
    1. Default grid row sort order specified?
    2. Default grid column ordering specified?
    3. Default grid column visibility specified?
    4. Common Columns are utilized whenever applicable?
    5. Crosslinking is implemented as per guidelines?
    6. Records in the grid have a corresponding Audit History view screen for user to go to?
      1. If so, is there a Last Updated column (which shows the Last Updated Date/time) that takes user to the Audit History view? Is it hidden by default?
    7. Records in the grid have Last Updated On/By/Organization information but no Audit History screen?
      1. If so, those information should be included in the grid as columns
    8. Is the Work Item column present if the record has corresponding work item(s) to show in the View screen and user has permission to see the work item?
    9. Is a “Deleted?” column present when the record can be logically deleted?
    10. Are deleted records required to be shown in the design?
      1. If so are they styled properly and hidden by default?
    11. Is row highlighting required by the design?
      1. If so what rows should be emphasized and what should be de-emphasized?
        1. Cases where emphasis should be used:
          • To highlight Preferred record
          • To highlight Active record (if only one can exist at a time)
          • To highlight Current record (if only one can exist at a time)
          • To highlight records that user needs to action on
        2. Cases where de-emphasis should be used
          • Inactive records
          • Expired records
      2. Each record in the grid is linked to a student?
        1. If so, is the “ASN” (tied to the record; this may be the secondary ASN), “Student Name” (preferred name of primary ASN), “Last Name”, “Middle Name”, “First Name” and “Suffix” columns available?
          1. Does the ASN and Student Name columns link to the View Student page for the student?
          2. Is the ASN and Student Name columns visible by default if user is currently not in the View Student page?
          3. The Name columns are not visible if user has no access to View Student for the student displayed?
          4. The ASN column is not linked if user has no access to View Student for the student displayed?
      3. If the data value displayed is a Code Value, is it shown in one of the accepted formats?
      4. Column labels for commonly used fields (e.g. School, Authority, Course, ASN) follows the PASIprep Writing Guidelines?
      5. Column labels for data elements takes the full name of the data element (i.e no abbreviation)?
  2. Layout
    1. Each grid column's min width is defined to fit the header label of the column?
    2. Each grid column auto-sizes to the 'common longest' value in the grid (while respecting the max width of the column specified in the design)?
  3. Functions
    1. Filtering is enabled in each column?
      1. The right filtering type is used? (text, number, set)
    2. Sorting is enabled in each column?
    3. Export to CSV and Columns… controls are present
    4. Total count of records at the bottom of the grid is present?
    5. When there is no data to display in the grid, the grid has a message that reads “No records found.”?
    6. Is the View Icon column present when there is a corresponding View page for the record?
    7. Is the Edit Icon column present when there is a corresponding Edit page for the record?
      1. Is the column hidden when user does not have permission to edit?
      2. Is the icon hidden when user does not have permission to edit specific records in the grid?
  4. Grid Action Menu Bar
    1. Is the Checkbox column present when there is an action in the Grid Action Menu Bar that requires user to select one or more records on the grid first before the action can be performed?
      1. If bulk actions are permitted, is multi-select enabled on the grid?
    2. Are actions in the menu bar hidden when user has no security rights (e.g. permissions/associations) to perform the action?
    3. Do users get a validation error message when they perform an action that is not permissible based on the defined business rules?

Exception Cases for Business Object Grids

For “Small Grids” (grids that are roughly less than or equal to 5 columns and rows in size)

  1. Export to CSV is not required
  2. Column… control is not required (if all columns are already displayed by default)
  3. Total count of records is not required
  4. Sort and filter functions are not required

For grids that shows Demographic Information 7) for a specific student

  1. Export to CSV is not required
  2. If the screen the grid is in already contains the Student Identifier Subtitle:
    1. ASN and Student Name (and all components of the student preferred name) columns are not required
  3. A “Reference #” column should be included in the grid to display the Reference ID (can be a hidden column)
  4. A “Preferred?” column should be included in the grid (rendered with checkmark = Yes, blank = No) if applicable to the entity (e.g. Mailing Address)

For grids that shows Academic Information 8) for a specific student

  1. If user is already in the View Student page, Student Name column & Last/Middle/First Name & Suffix columns are not required.

Audit History Grid

PASIprep Audit History Grid

  1. Grid data sorts by latest to oldest records by default?
  2. Grid column default ordering specified?
  3. All columns available for the Business Object (including the Deleted? flag if it exists the object) are included in the grid and visible by default?
    1. These columns aligns with the fields presented in the View screen of the Business Object?
  4. First column (visible by default) is Updated On?
  5. Last two columns visible by default are: Updated by, and Updated by Organization?
  6. Filtering is enabled in each column?
    1. The right filtering type is used? (text, number, set)
  7. Sorting is enabled in each column?
  8. Columns… control is present?
  9. Total Count of Row at the bottom of the grid is present?
  10. Is Export to CSV required by design? If so, is it present?
  11. Each grid column's min width is defined to fit the header label of the column?
  12. Each grid column auto-sizes to the “common longest” value in the grid (while respecting the max width of the column specified in the design)?
  13. Column labels for commonly used fields (e.g. School, Authority, Course, ASN) follows the PASIprep Writing Guidelines?

For screens that adds Academic Information 9) for a specific student

  1. ASN included as column in the grid and visible by default?

Card Group

PASIprep Card Group

  1. Is the Layout specified in the design?
  2. If there are action links, are they positioned in the right area?

Summary Cards

See Card Group.

Field Value Form/List

PASIprep Field Value List / Form

  1. Is the ordering of the fields specified?
  2. Is the grouping of fields specified?
    1. A meaningful display title is assigned to each groups?
  3. Is the layout of the fields on each group specified based on the 6 column 'grid' layout? (Note: most fields should span 2 columns each unless it is exceptionally short or long)
  4. Recommended Position and Labeling for Commonly Used Fields
    1. Alberta Student Number, when viewing student-related record, should generally be the first field and labeled “Alberta Student Number” (not “ASN”)
    2. Deleted Flags (rendered as described in the PASIprep Field/Value Pair guidelines) should be positioned generally as the last field on the first row (i.e. towards the top right corner of the content)
    3. *Important status fields should be positioned in the top row (preferred) or in the first row of a group. It is also recommended that they are positioned either as the leftmost field or the rightmost field in the row.

Field Value Pair

PASIprep Field/Value Pair

  1. Are required fields identified? (if it is an editable field/value form)
  2. Are hint texts defined for fields with labels that are not self-explanatory
  3. Is the data format identified? (if it is an editable field/value form and the field requires a specific format)
  4. If the value is a Code Value, is it shown in one of the accepted formats (usually Short Description would be visible)
  5. Are commonly used field label and value pairs used when applicable?

Combobox / Dropdown

PASIprep Combobox / Dropdown

  1. Is the suitable dropdown input control used? (Select (either the single-select or the multi-select variant), Select w/ Autocomplete, Autocomplete)
    1. If Select is used, when the field is optional, was an empty option provided?
  2. Are the options listed in the design displayed accordingly?
  3. If there is an “All” or “Any” option, are they displayed properly depending on the type of dropdown? (Select vs Select w/ Autocomplete)
  4. If the options comes from a list of Code Values, is it shown in one of the accepted formats (usually Short Description would be visible)
    1. If the record is associated to a School Year, are the Code Value options filtered based on the School Year selected for the record and the effective School Year range for the code value?
  5. If the dropdown is used for School Year selection does it show the proper list of School Years options based on the record type (mark vs school enrolment)?

1), 3), 5), 7) Generally this refers to data elements that make up the response of the Get Student Personal Profile, or the actual Student
2), 4), 6), 8), 9) Generally this refers to data elements that make up the response of the Get Student Academic Profile (2018)