Table of Contents
Electronic Waybill File XML
This document outlines the contents and format of the Alberta Education Electronic Waybill File XML as delivered by the Ministry of Education, Government of Alberta. It is based on IMT and GOA standards for digitization.
This document is intended for use by Alberta Education, Authorities and Schools within Alberta who leverage the PASI digital student record functionality.
Digitization Standards
The following URLs will provide up to date information on the digitization standards:
http://imtdocs.alberta.ca/standards/digitization-process.aspx
http://imtdocs.alberta.ca/standards/digitization-technical-requirements-3.aspx
Electronic Waybill
This section describes the xml that is submitted to PASI when loading student documents using the document submission with waybill process.
Documents
The container for the list of documents being submitted to PASI.
| Tag Name | Description | Format |
|---|---|---|
| Document | A container for the metadata associated to a document being submitted to PASI. | minOcc 1 <Document> |
Message Illustration
<Documents>
<Document>
...
</Document>
<Document>
...
</Document>
</Documents>
Document
The container for the metadata associated to a document being submitted to PASI.
It is important to note that if a metadata field is blank for a specific document being loaded as part of a Document Submission then the tag for that metadata element should be completely removed from the metadata section of that specific document. For example if Student Document Expiry Date is not required for the document being loaded then Student Document Expiry Date should not be seen as a line within the waybill for that document. If the line is entered but left blank the waybill will fail for Rule 65060 - Invalid Waybill Format.
| Tag Name | Description | Format |
|---|---|---|
| StateProvinceID | State Province ID (Alberta Student Number). Must be in the form of a number between ‘000000001’ and ‘999999999’ | minOcc 1 maxOcc 1 maxLength 9 |
| DocumentType | Must be a valid document type as defined by the GetDocumentType Service. | minOcc 1 maxOcc 1 xs:string |
| Title | The title of the document. Value must not have control characters, leading, trailing or multiple embedded spaces. Contents must not match regular expression. | minOcc 1 maxOcc 1 maxLength 200 |
| IsRelevant | Must be true or false | minOcc 1 maxOcc 1 xs:boolean |
| StudentDocumentLanguage | The language the document is in. Must be a currently available Student Document Language code class value (e.g. EN, FR, Other) | minOcc 1 maxOcc 1 |
| DocumentDate | The date the document was created. Optional depending on the document type. When provided must be in the format YYYY-MM-DD | minOcc 0 maxOcc 1 xs:date |
| DocumentExpiryDate | The date the document expires. Optional depending on the document type. When provided must be in the format YYYY-MM-DD | minOcc 0 maxOcc 1 xs:date |
| LinkedToSchoolYear | The school year the document applies to. Optional depending on the document type. When provided must be a 4 digit value (e.g. for school year 2016/2017 use 2017). | minOcc 0 maxOcc 1 xs:integer |
| IsQualityAssuranceAlreadyPerformed | Indicates if quality assurance has already been completed on the document by the organization loading the document. Must be true or false. | minOcc 1 maxOcc 1 xs:boolean |
| OriginalFileName | The original name the file that is loaded to PASI. Must have the extension .pdf. A file with this name must exist in the .zip file. This file name must be unique within this document. | minOcc 1 maxOcc 1 maxLength 200 xs:string |
| LinkedToOrganization | Optional depending on the document type. When provided must be 6 characters. Must be in the format of S.xxxx or A.xxxx where xxxx is the 4 digit code of the school or school authority the document is linked to. | minOcc 0 maxOcc 1 maxLength 6 xs:string |
| IsTextSearchable | Indicates if text character recognition and searching is available for the document. Must be true or false. | minOcc 1 maxOcc 1 xs:boolean |
| IsDigitized | Indicates if the electronic document was scanned from a hard copy document. Must be true or false. | minOcc 1 maxOcc 1 xs:boolean |
Message Illustration
<Documents>
<Document>
<StateProvinceId>123456789</StateProvinceId>
<DocumentType>IPP</DocumentType>
<Title>StudentXIPP</Title>
<IsRelevant>1</IsRelevant>
<StudentDocumentLanguage>EN</StudentDocumentLanguage>
<DocumentDate>2017-10-17</DocumentDate>
<DocumentExpiryDate>2019-12-31</DocumentExpiryDate>
<LinkedToSchoolYear>2017</LinkedToSchoolYear>
<IsQualityAssuranceAlreadyPerformed>0</IsQualityAssuranceAlreadyPerformed>
<OriginalFileName>StudentXIPP.pdf</OriginalFileName>
<LinkedToOrganization>S.4022</LinkedToOrganization>
<IsTextSearchable>1</IsTextSearchable>
<IsDigitized>1</IsDigitized>
</Document>
</Documents>
Externally Accessible PDFs
The external location for the published PDFs are located here: https://extranet.education.alberta.ca/PASI.devnet/PASI%20Documents/CurrentRelease/Integration%20Documents/