User Tools

Site Tools


You were redirected here from current_student_document_detail.

Student Document

This object is used to capture the current version of the digital documents that have been added to a student’s Student Record. This object contains the editable data elements for the document.

Parent Business Objects

This business object is considered a child business object of Student.

Attributes

This business object includes the following attributes:

Attribute Name Attribute Type Optionality Cardinality
Student Document Audit Event Child Business Object
Student Document Audit Information Common Data Structure Optional Multiple
Disposal Override Date Calculated Property Optional Single
Student Document Date Data Element Conditional Single
Student Document Expiry Date Data Element Conditional Single
Document Language Data Element Mandatory Single
Student Document Type Business Object Reference
Student Document Is Deleted Data Element Mandatory Single
Is Digitized Document Data Element Mandatory Single
Is Relevant Data Element Mandatory Single
Student Document Reference ID Data Element Mandatory Single
Scheduled Disposal Date Calculated Property Mandatory Single
Student Document School Year Data Element Conditional Single
Student Document Created By Organization Business Object Reference
Student Document Problem Child Business Object
Student Document Quality Assurance Child Business Object
Student Document Title Data Element Mandatory Single

Below are the non-editable metadata and the actual image for each Student Document that has been uploaded to the Student Record.

Attribute Name Attribute Type Optionality Cardinality
Student Document Image Page Count Data Element Mandatory Single
Is Exempt From QA Data Element Mandatory Single
Is Text Searchable Data Element Mandatory Single
Linked To Organization Business Object Reference
Original File Name Data Element Mandatory Single
Quality Assurance Already Performed Data Element Mandatory Single
Student Document Uploaded by User Business Object Reference
Student Document Uploaded On Date Data Element Mandatory Single
Student Document Image Business Object Reference
Document Image Hash Data Element Mandatory Single

Derived Field - Document File Name

A unique file name that PASI generates based on the document naming conventions. When a user downloads the file, this is the file name that is used for the file.

The name will be not be stored, but will be dynamically calculated using the following template: {ASN}-{DocType}-{DocumentDate}-{SchYr}-{UploadedByOrg}.{ImageFormat} The following are optional based on the Document Type Definition:

  • {DocumentDate} will only appear if it is defined.
  • {SchYr} will only appear if Is School Year Bound is true on the definition.
  • {UploadedByOrg} will only appear if Is Organization Bound is true on the definition.

This is used when downloading Student Document PDFs.

Student Document Data Access Rules

Synchronization Rules

In order to synchronize 1) a Student Document:

Access to a Record

In order to access a Student Document2):

Access to the Document Image

In order to access the metadata for an document image6):

  • The PASI Client must have access to the Student Document
  • The Student Document record cannot be in a deleted state

Access to the Student Documents menu

Adding a new Record

In order to add a new Student Document record7):

Updating an Existing Record

In order to update8) an existing Student Document record9):

  • The PASI Client must have access to the Student Document
  • The Student Document record cannot be in a deleted state.

Deleting an Existing Record

In order to delete10) an existing Student Document record11):

  • The PASI Client must have access to the Student Document
  • The Student Document record cannot be in a deleted state.

Undeleting an Existing Record

In order to undelete12) an existing Student Document record13):

  • The PASI Client must have access to the Student Document
  • The Student Document record cannot be in an undeleted state.
1)
i.e., using the Is Data Available service
3)
associated By Ministry
4)
is the linked to organization, the governing authority of the linked to organization, or is the ministry
5)
is the organization that deleted the document, the governing authority of the organization, or is the ministry
8)
in order to change the value of any Student Document data element other than Is Deleted
10)
only update to Is Deleted from False to True
12)
only update to Is Deleted from True to False
student_document.txt · Last modified: 2022-02-17 18:39 by reggie