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.

Note: The non-editable data elements are contained in the Student Document Image (Business Object).

Attributes

This business object includes the following attributes:

Attribute Name Attribute Type Optionality Cardinality
Audit History (Student Document) Data Element Mandatory Multiple
Audit Information (Student Document) Data Element Optional Multiple
Audit User (Student Document) Data Element Mandatory Single
Audit User Organization (Student Document) Data Element Mandatory Single
Disposal Override Date Calculated Property Mandatory Single
Document Date Data Element Optional Single
Document Expiry Date (Student Document) Data Element Optional Single
Document Language (Student Document) Data Element Mandatory Single
Document Type (Student Document) Data Element Mandatory Single
Is Deleted (Student Document) Data Element Mandatory Single
Is Digitized Document Data Element Mandatory Single
Is Relevant Data Element Mandatory Single
Reference ID (Student Document) Data Element Mandatory Single
Scheduled Disposal Date Calculated Property Mandatory Single
School Year (Student Document) Data Element Optional Single
Student (Student Document) Data Element Mandatory Single
Student Document Created By Organization Data Element Mandatory Single
Student Document Image (Student Document) Data Element Mandatory Single
Student Document Problem Report Child Business Object Optional Multiple
Student Document Problem Report History Data Element Optional Multiple
Student Document Quality Assurance Child Business Object Object Single
Student Document Quality Assurance History Data Element Optional Single
Student Document Title 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):

When accessible, the following rules are applied to specific data elements on the record:

Access to the Document Image

In order to access a Student Document Image6):

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

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