Table of Contents
Student Identity Source Document Type
Identifies the docuement type within the “identity” category.
| Data Format | A valid Source Document Type code value. |
|---|
Business Object References
This data element is used in the following business objects:
Validation Rule References
This data element is used in the following validation rules:
- Rule 10027 - Inconsistent Source Documentation for Foreign Student
- Rule 11210 - Invalid Student Identity Document
- Rule 11212 - Inconsistent Source Document for Canadian Student
- Rule 11213 - Inconsistent Source Document for Foreign Student
- Rule 11225 - Invalid Source Document Type
- Rule 11235 - Source Document Type Must Be Modified
- Rule 11236 - Invalid Source Document Type
- Rule 80001 - Invalid Student Identity Document
Functional References
This data element is used in the following functionality:
- Edit Student Identity Document
- Find Student
- Get Student
- Get Student (2018 Endpoint and Prior)
- Get Student (2019 Endpoint)
- Get Student (2020 Endpoint)
- Get Student Personal Profile
- Get Student Personal Profile (2018 End Point and Earlier)
- Get Student Personal Profile (2020 Endpoint and Prior)
- Get Student Status
- Get Student Status (2018)
- Get Student Status 2021 End Point
- Identify Student
- Import ASN
- Process Home Education Notification
- Submit Identification Information
- Submit Student
- View Student Identity Document
- View Student - Identity Tab
User Interface Guidelines
To Be Documented
Unless otherwise specified, this data element should adhere to the guidelines below.
Data Format Guidelines
When this data element is presented, it should be formatted as ….
Read Only Field
When this data element is displayed it should adhere to the following guidelines:
| Field Name | … |
|---|---|
| Null Values | Blank / N/A / … |
| Hint Text | None |
| Security Requirements | None |
Editable Field
When this data element is available to be edited, a … control should be used as outlined below:
Use this table if a Combo / Drop Down Control should be used
| Field Name | … |
|---|---|
| Mandatory? | Yes / No / Conditional Rules |
| Style | Select / Select with Autocomplete / Autocomplete |
| Selection Values | Describe the source of the selectable values |
| Selection Sort Order | By describe the sort order1) |
| Default Value | The existing value if available. Otherwise there is no default. |
| Null Value | Blank / All / Any / N/A / … |
| Allow Multiple Values? | Yes / No |
| Hint Text | None |
| Security Requirements | None |
Use this table if a Date / Time Input Control should be used
| Field Name | … |
|---|---|
| Mandatory? | Yes / No / Conditional Rules |
| Default Value | The existing value if available. Otherwise there is no default. |
| Null Value | Blank / All / Any / N/A / … |
| Hint Text | None |
| Security Requirements | None |
Use this table if an ASN Input with Find Student Control should be used
| Field Name | … |
|---|---|
| Mandatory? | Yes / No / Conditional Rules |
| Default Value | The existing value if available. Otherwise there is no default. |
| Null Value | Blank / All / Any / N/A / … |
| Security Requirements | None |
Use this table if a Checkbox Control should be used
| Checkbox Message | … |
|---|---|
| Default Value | The existing value if available. Otherwise Checked / Not Checked |
| Security Requirements | None |
Use this table if a General Input Control should be used
| Field Name | … |
|---|---|
| Mandatory? | Yes / No / Conditional Rules |
| Data Type | Alphanumeric / Numeric |
| Default Value | The existing value if available. Otherwise there is no default. |
| Null Value | Blank / All / Any / N/A / … |
| Hint Text | None |
| Security Requirements | None |
Data Grid Column
When this data element is displayed in a PASIprep Data Grid it should adhere to the following guidelines:
| Column Heading | … |
|---|---|
| Column Width | Auto / Default Width = ### px / Fixed Width = ### px / Minimum Width = ### px, Maximum Width = ### px |
| Filtering Style | None / Date / Numeric / Set / Text |
| Contains | The formatted value of the data element. |
| Null Values | Blank / N/A |
| Column Security Requirements | This column is always available. |
| Data Security Requirements | The data in this column is always available. |