Table of Contents
Document Type Categories
One or more categories that the Document Type is part of. E.g., Assessments, Test Results, Identity Documents, Citizenship, Guardian Citizenship, Requests, etc.
| Data Format | A list of one or more Document Category code values. |
|---|
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 65136 - Cannot remove Citizenship Category from a Document Type that supports the Student Citizenship Status
- Rule 65137 - Cannot remove Guardian Citizenship Category from a Document Type that supports the Guardian Citizenship Status
- Rule 65138 - Cannot remove Identity Category from a Document Type that supports the Identity of the Student
- Rule 65139: Document Type having Document Category of Guardian Citizenship can't be a part of any other Document Category
Functional References
This data element is used in the following functionality:
- Add Document Type
- Add Student Document
- Edit Document Type
- Edit Student Document
- Flag Documents for QA
- Get Document Types
- Get Document Types (2019 Endpoint and prior)
- List Document Types
- Process Home Education Notification
- Update Student Document Relevancy
- View Document Type
- View Student - Learning Needs Tab
- View Student - Student Documents Tab
Data Format
When this data element is presented, it should be formatted as the short description of the Document Category code value.
Read Only Field
When this data element is displayed it should adhere to the following guidelines:
| Field Name | Category Type |
|---|---|
| Null Values | blank |
| Hint Text | None |
| Security Requirements | None |
Editable Field
When this data element is available to be edited, a Combo / Drop Down Control should be used as outlined below:
| Field Name | Category Type |
|---|---|
| Mandatory? | No |
| Style | Select |
| Selection Values | The short description of the Document Category code values. |
| Selection Sort Order | By sequence and then by short description |
| Default Value | The existing value if available. Otherwise there is no default. |
| Null Value | N/A |
| Allow Multiple Values? | No |
| 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 | Category Type |
|---|---|
| Column Width | Auto |
| Filtering Style | Set |
| Contains | The formatted value of the field. |
| Null Values | N/A |
| Column Security Requirements | This column is always available. |
| Data Security Requirements | The data in this column is always available. |