Table of Contents
List Document Order Items
The List Document Order Items option is accessible via the navigation menu category as per the header navigation menu.
The List Document Order Items page (based on the PASIprep List Items Template) will allow a PASIprep user to retrieve and view a list of Document Order Item records.
This screen provides search functionality for Student Records users to see a list of Document Order Items:
- Document Category
- Delivery Method
- Order Item Status, or
- Special Handling Status
Secured By
In order to access this screen, the user must have the following permissions:
List Document Order Items - Search
The search allows a user to search by a number of pieces of information to generate an overview of relevant document order items.
Search Fields
The page uses the PASIprep List Items Template which includes the context bar. The context bar allows user to specify the criteria to find Document Order Items.
* denotes mandatory fields
| Field Name | Description | Field Format |
|---|---|---|
| Document Category: * | A mandatory dropdown list that contains the document values from the Document Order Item Category code table sorted alphabetically. The dropdown defaults to the “Transcript (Document Order Category)” value. | PASIprep Combobox / Dropdown |
| Delivery Method: | Field values are narrowed down when a Document Category has been selected. Will contain a list of all active Child Document Delivery Methods related to the Document Order Item Category. | PASIprep Combobox / Dropdown |
| Order Item Status | A dropdown list that contains a blank value (default) and the UI Order Item Status values sorted alphabetically. | PASIprep Combobox / Dropdown |
| Date/Time Search Type* | A mandatory dropdown list that contains the following values:
| PASIprep Combobox / Dropdown |
| Start Date/Time* | A mandatory field for the user to provide a date and time. Defaults to the 30 days in the past. The field will have a hint text of “YYYY-MM-DD HH:mm”. | Date/Time |
| End Date/Time* | A mandatory field for the user to provide a date and time. Defaults to the current date and time. The field will have hint text of “YYYY-MM-DD HH:mm”. | Date/Time |
Processing on Search
When the Search button is used, PASIprep will:
- Validate the search criteria entered,
- Find records matching the search criteria as follows:
- Order/Order Items are only returned where the user satisfies the Document Order Item Data Access Rules
- Order is not deleted
- Order Item’s document category matches what was specified
- If specified, the Delivery Method will be included in the query to narrow the search results to document order items for the Delivery Method selected.
- Order Item’s status matches what was specified
- Order Item’s special handling matches what was specified
- If a Date Search Type of “When order was updated” then return Order Items on an Order that have an Last Updated On in the specified date range.
- If a Date Search Type of “When order was placed” then return Order Items on an Order that have an Order Placed Date/Time in the specified date range.
- If a Date Search Type of “When order item was sent for delivery” then return Order Items that have a Delivered On Date in the specified date range.
- Populate the data grid with the matching records.
Search Results Data fields
The sort order of the grid should be by Order Placed Date in descending order.
* denotes fields that are visible on the grid by default.
| Data | Description |
|---|---|
| {View Icon}* | Displays the View icon to view the details for the Document Order Item. When selected by the user, this opens the View Document Order Item page for the record. |
| Alberta Student Number* | ASN for the Student. Value displays as a hyperlink to the View Student - Summary Tab page for the student. |
| Student Name* | Preferred Name of the student, formatted as per the data_value_format_guidelines |
| Last Name* | Displays the surname of the student. |
| Suffix* | Displays the Name Suffix that applies to the name such as Junior, Jr., Sr., etc. |
| First Name* | Displays the given name of the student |
| Middle Name* | Displays the middle given names of the student |
| Legal Name on Document* | Displays the Student Legal Name associated with the document order item. |
| Order Item #* | Displays the Document Order Identifier and Document Order Item Number. |
| Document Order Item Category* | Displays the Document Order Item Category of the Document Order Item. |
| Document Type* | Displays the Document Type of the Document Order Item. |
| Document ID* | Displays the Document ID of the Document Order Item File on the order item. |
| Document Error* | Displays the description of the document error. |
| Order Status* | Displays the Order Status of the Document Order. |
| Order Item Status* | Displays the UI Order Item Status of the Document Order Item. |
| Is Waybill Available* | Displays the Is Waybill Available of the Document Order Item. |
| Status Change Reason* | Displays the Status Change Reason of the Document Order Item. |
| Special Handling | Displays the Special Handling Status of the Document Order Item. |
| Delivery Method* | Displays the Document Delivery Method of the Document Order Item. |
| Delivery Schedule | Displays the Schedule Task Description of the Control Schedule linked to the order item. Has a link that take the user to the View Operational Control Schedule page. If null, then show “ASAP”. |
| Recipient Name* | Displays the Recipient Name of the Document Order Item. |
| Recipient Address* | Displays the Recipient’s mailing address on the Document Order Item. |
| Recipient Is Student | Displays the Recipient Is Student of the Document Order Item. |
| Recipient Fax Number* | Displays the Recipient Fax Number of the Document Order Item. |
| # of Copies* | Displays the Number of Copies requested. |
| Request Method* | Displays a code value indicating how a request was received. |
| Document Language* | Displays the Document Language of the Document Order Item. |
| Document Processing Timeframe* | Displays the Document Processing Timeframe for the Document Order Item. |
| Order Placed* | Displays the date and time that the creator of the order completed all the items and sent the order for payment. |
| Ready for Delivery | Displays the Processed On Date/Time of the Document Order Item. |
| Sent for Delivery* | Displays the Delivered On Date/Time of the Document Order Item. |
| Digital Official Document Expiry Date | Displays the date on which Digital Official Document Consumer users will no longer be able to access the digital official document. |
| Order Requested By* | The name of the Requestor who made the original request for the order. It may be a contact name, the institution name, the student name, or a third party name. This third party may be an organization. |
| Order Entered By* | Displays the name of the person that entered the original request for the order |
| Re-Order Source Order Item | Displays the Reorder Of Document Order Item. Clicking the link takes the user to the View Document Order Item page for that order item. If blank, shows “N/A”. |
| Reorder Reason | Displays the Reorder Reason of the Document Order Item. If blank, shows “N/A”. |
| Transcript Tracking ID | Displays the Delivery Method. For “ApplyAlberta” displays the ApplyAlberta Transcript Request Identifier or for “Electronic” displays Transcript Request Identifier if it is not null. Otherwise, displays a blank value. |
| Transcript Requesting Institution | Displays the origin of the Document Order Item, otherwise displays a blank value. |
| Transcript Deliver to Client | Displays the value will come from Recipient Client Identifier. If this value is null, leave the field value blank. |
| Transcript Provided Consent for School Release | Displays a code value indicating if the student has given consent to release school information on the transcript. |
| Credential Number | Displays the Credential Number (Document Order Item) on the Document Order Item as a link to the View Awarded Credential screen. Where the credential number associated to a document order item has been deleted, the credential number still displays as a hyperlink. |
| Payment Total Cost | Displays the Total Amount on the Document Order Item; this is the calculated fee/cost for the Document Order Item. |
| Payment Amount Collected | Displays the amount of fees collected from the requestor for the Document Order Item. |
| Method | Displays the code value indicating the delivery method for the order item. |
| Reference ID | Displays a Globally Unique Identifier (GUID) used to reference the Document Order Item record. |
| Printing Job Number | Displays the print job of the Document Order Item file record link to the Document Order Item. |
| Printing Sequence Number | Displays the print sequence number of the Document Order Item file record link to the Document Order Item. |
| Is Deleted?* | Displays the IsDeleted value at the time of the update. Where Deleted, to display “Yes” and otherwise, to display “No”. |
| Updated By* | Displayed as per PASIprep Audit History Grid |
| Updated By Organization* | Displayed as per PASIprep Audit History Grid |
Grid Options
| COLUMNS | The Columns option allows the user to adjust the columns that are visible in the grid. |
|---|---|
| EXPORT TO CSV | The Export to CSV option exports the data to file. |
Google Analytics
Google Analytics is implemented as per the PASIprep Analytics Guidelines with page views tracked.