Attributes Document (EST Data Dictionary)
- Katie Macpherson (Deactivated)
Contents
Change Log
Student Transaction Type
Enterprise Type
Institution Type
Campus Type
Fund Type
Program Type
Site Type
Student Type
Address Type
Award Type
Borrower Type
Disbursement Type
Payment Period Type
Fee Type
Valid State or Province Values
Valid Country Values
Change Log
Updated | Comment | Related Build |
January 30, 2015 | Added 'fundId', 'externalFundId' and 'externalAwardId' to the 'Disbursement' node; Added 'externalFundId', 'studentCurrentLocationFundId' and 'studentCurrentLocationFundExternalId' to the 'Award' node; Added 'externalProgramId' to the 'Payment Period' node | 8.17.1(34784), 8.16.15 Patch 80 |
December 12, 2014 | Added 'academicYearId' to the 'Payment Period Node' | 8.17.1(34200), 8.16.15 Patch 55, 8.16.15 Patch 60 |
November 4, 2014 | Added 'disbursementSequence' to the 'Disbursement Node' | 8.17.1(33579), 8.16.15 Patch 46 |
October 30, 2014 | Added 'academicYearStartDate' and 'academicYearEndDate' to the 'Payment Period' Node | 8.17.1 (33504), 8.16.15 Patch 42 |
October 21, 2014 | Added 'MTFSuspended' SAP status to the 'Payment Period' node | 8.17.1 (33310), 8.16.15 Patch 42 |
August 11, 2014 | Removed schema namespaces | 8.17.1 (31748), 8.16.15 Patch 14 |
October 23, 2017 | Updated the description with additional information for the attribute "Disbursement Status" in the Disbursement Type node. |
Data Record Layout
Attribute | Description | Valid Values/Comments | Schema Field Names |
|---|---|---|---|
Student Transaction Type | Note: For Expected transaction, this type will be renamed 'Student Expected Transaction Type' | ||
Transaction ID | Transaction ID | 0 – 999999999 | id |
| The Type of EST Process being executed. |
|
|
Date Exported | Date the export was performed. | Format is CCYY-MM-DD | dateExported |
Total Student Count | Total number of students in the EST export. | totalStudentCount | |
Total Award Count | Total amount of awards in the EST export. | totalAwardCount | |
Total Disbursement Count | Total number of disbursements in the EST export. |
| |
Total Transaction Amount | Total transaction amount of the EST export. |
| |
Enterprise Type | |||
Enterprise ID | Enterprise ID | ID of the Enterprise. (REM's internally generated ID) | id |
| An identifier that is unique to the enterprise that the student is attending, and maps to another system being used by the school. | Alphanumeric |
|
Name | Enterprise Name | name | |
Description | Text description of the Enterprise | description | |
Institution Type | |||
Institution ID | Institution ID | ID of the Institution. (REM's internally generated ID) | id |
| An identifier that is unique to the Institution that the student is attending, and maps to another system being used by the school. | Alphanumeric |
|
Name | Institution Name | name | |
Description | Text Description of the Institution | description | |
Campus Type | |||
Campus ID | Campus ID | ID of the Campus. (REM's internally generated ID) | id |
| An identifier that is unique to the campus that the student is attending, and maps to another system being used by the school. | Alphanumeric |
|
Name | Campus Name | name | |
Fund Type | |||
Fund ID | Fund ID | ID of the Fund. (REM's internally generated ID) | id |
| An identifier that is unique to the Fund, and maps to another system being used by the school. | Alphanumeric |
|
Name | Fund Name | name | |
Description | Text Description of the Fund | description | |
External ID 2 | A second identifier that is unique to the Fund, and maps to another system being used by the school. | Alphanumeric |
|
School ID | Identifier for state reporting. | schoolId | |
| COD name for the fund. | Direct Graduate PLUS Loan |
|
Agency Program ID | Used to link a fund to an external program. | agencyProgramId | |
Program Type | |||
Program ID | Program ID | ID of the Program. (REM's internally generated ID) | id |
| An identifier that is unique to the program that the student is enrolled in | Maps to the External Program ID defined on Program Setup. |
|
| Academic Program Name, as set up in REM Program Setup. |
| |
Site Type | |||
Site ID | Site ID | ID of the Site. (REM's internally generated ID) | id |
| An identifier that is unique to the site that the student is attending. | Maps to the External Site ID defined on Site Setup. |
|
Name | Site Name | name | |
Description | Text Description of the Site | description | |
Student Type | |||
Student ID | Student ID | ID of the Student. (REM's internally generated ID) | id |
| An identifier that is unique to the student, chosen by the school. May be an identifier from an external system. | Alphanumeric |
|
| An identifier that is unique to the student, chosen by the school. May be an identifier from an external system. | Alphanumeric |
|
| An identifier that is unique to the student, chosen by the school. May be an identifier from an external system. | Alphanumeric |
|
| An identifier that is unique to the student, chosen by the school. May be an identifier from an external system. | Alphanumeric |
|
Social Security Number | The Student's Social Security Number | Numeric only | socialSecurityNumber |
Birth Date | The Student's Birth Date | Format is CCYY-MM-DD | birthDate |
First Name | The Student's First Name | firstName | |
Middle Name | The Student's Middle Name | middleName | |
Last Name | The Student's Last Name | lastName | |
Hold Excess Title IV | Student's response to authorization request via the student portal. | Defaults to false |
|
Pay Prior Year Minor Charges | Defaults to false |
| |
Pay Non-Institutional Charges | Defaults to false |
| |
Portal Credit Balance Option | Defaults to false |
| |
Address Type | |||
Address ID | Address ID | ID of the Address. (REM's internally generated ID) | id |
| Identifies the source from which the address data for the student originated. | COD |
|
| The type of address being provided for the student. | Billing |
|
(Address) Line 1 | The First Line of the Address for the Student | line1 | |
(Address) Line 2 | The Second Line of the Address for the Student | line2 | |
City | The Student's City of Residence | city | |
County | The Student's County of Residence | county | |
State/Province | The Student's State/ Province of Residence | stateProvince | |
Postal Code | The Student's Postal Code | postalCode | |
Country | The Nation of the Student | country | |
Award Type | |||
Award ID | ID of the Award. (REM's internally generated ID) | id | |
| External ID of the Award. This ID is sent to Regent Award, from the school, when importing award data into Regent Award. Regent Award uses this ID for matching award data during updates. |
| |
| Fund ID of the Award. (REM's internally generated Fund ID) | fundId | |
External Fund Id | The externalFundId provided for the fund on Fund Setup in Regent Award. | Optional | externalFundId |
Student Current Location Fund Id | This value is populated only when the student has transferred from one campus to another campus. This is the mapped fundId for the student's new campus. | Optional | studentCurrentLocationFundId |
Student Current Location Fund External Id | This is the 'externalId' of the fund for the 'studentCurrentLocationFundId' | Optional | studentCurrentLocationFundExternal Id |
| COD name for the award. | Direct Graduate PLUS Loan |
|
Federal Award Year | Federal Award Year tied to the award for COD purposes. | CCYY |
|
| Status of the student's award. Awards in "Offered" or "Estimated" status will never be exported. | Accepted |
|
Academic Year Begin Date | The date the student's academic year starts at the school. | Format is CCYY-MM-DD |
|
Academic Year End Date | The date the student's academic year ends at the school. | Format is CCYY-MM-DD |
|
Financial Award Begin Date | The date when classes begin for the specific period covered by aid. Cannot be prior to the student's academic year begin date. | Format is CCYY-MM-DD |
|
| The date when classes end for the specific period covered by aid. Cannot be after the student's academic year end date. | Format is CCYY-MM-DD |
|
Financial Award Create Date | Tag indicating the year corresponding to awards. | Format is CCYY |
|
Financial Award ID | Unique award identifier. | financialAwardId | |
Financial Award Number | Award identifier or Award Sequence Number (last three positions of the Financial Award ID). |
| |
Offered Amount | Total gross award amount offered to the student. |
| |
Accepted Amount | Total gross award amount accepted by the student. |
| |
| (Received from COD) Indicates whether a credit balance on a loan should be directed to the student or the borrower. | Student |
|
First Time Loan Borrower | Indicates if the student is a first time loan borrower. | 1 / 0 |
|
| The current sum of the gross disbursement amounts for this award. |
| |
Modified On | Date the award was last modified | Format is CCYY-MM-DD | modifiedOn |
Modified By | User ID who last modified the award | modifiedBy | |
Created On | Date the award was created | Format is CCYY-MM-DD | createdOn |
Created By | User ID who created the award | createdBy | |
Borrower Type | |||
Social Security Number | The Borrower's Social Security Number | Numeric only | socialSecurityNumber |
Birth Date | The Borrower's Birth Date | Format is CCYY-MM-DD | birthDate |
First Name | The Borrower's First Name |
| |
Middle Name | The Borrower's Middle Name |
| |
Last Name | The Borrower's Last Name | lastName | |
Disbursement Type | |||
Disbursement ID | Regent internally generated disbursement ID. Once assigned, this ID will not change (for all files) in order to reflect the distinct disbursement in Regent Award. | 0 – 999999999 | id |
| External ID of the Disbursement. This ID is sent to Regent Award, from the school, when importing award and disbursement data into Regent Award. Regent Award uses this ID for matching disbursement data during updates. |
| |
Disbursement Number | 1-20 disbursements | 1-20 | number |
Disbursement Sequence Number |
| 1 - 20 |
|
| The status of the disbursement. | Declined |
|
Disbursement Amount | The gross amount of the disbursement. | amount | |
Last Accepted COD Amount | The amount of the transaction is based on the lower amount of either the Accepted Amount or the Last COD Accepted Amount, minus the Amount of the disbursement that has already been paid. | lastCODAcceptedAmount | |
| The net amount of the disbursement, minus the fee. |
| |
Total Fee Amount | The total amount of fee for the disbursement. | totalFeeAmount | |
Student Accepted | Indicates whether or not the student has accepted the transaction. | 1 / 0 | studentAccepted |
Student Accepted On Date | Date that the student accepted the disbursement. | Format is CCYY-MM-DD | studentAcceptedOnDate |
Accepted Amount | Amount of the disbursement accepted by the student. | acceptedAmount | |
Auto Accepted Amount | Amount of the disbursement accepted by the student under passive acceptance. |
| |
Previous Paid Amount | Amount paid to the student in the previous disbursement transaction. |
| |
| A unique number assigned to each disbursement every time EST is run – whether Actual or Expected. |
| |
Transaction Amount | Amount paid to the student in this disbursement transaction. Represents the net amount of the transaction. | NOTE: This value is determined as follows: the lessor amount between the lastCODAcceptedAmount and the netAmount minus the paid amount = transactionAmount. For example: the lastCODAcceptedAmount = 10, the netAmount = 5, and the paid amount =5. The transactionAmount equals $0. |
|
| Date that the transaction is exported. This value is set during an Actual EST process only. If the transaction is not actually exported, the value will be null. | Format is CCYY-MM-DD |
|
| Indicates whether or not a transaction has been paid. Default value is False. This will always be false for the Expected EST process. | 1 / 0 |
|
| Date that the disbursement is scheduled to be paid to the student. | Format is CCYY-MM-DD |
|
| Adjusted date that the disbursement is scheduled to be paid to the student. | Format is CCYY-MM-DD |
|
| Date that the disbursement is initially released to the student. This field is not updated upon subsequent transactions for this disbursement. | Format is CCYY-MM-DD |
|
| Indicates whether or not the disbursement has been released to the student. Default value is False. | 1 / 0 |
|
Is R2T4 PWD | Disbursement that result from a PWD. This field is set when it is altered by a PWD. | Required | isR2T4PWD |
Is Set from R2T4 | Disbursement that result from a R2T4. This field is set anytime a disbursement is altered by the R2T4 wizard. | Required | isSetFromR2T4 |
Fund Id | Fund Id | Required | fundId |
External Fund Id | The externalFundId provided for the fund on Fund Setup in Regent Award. | Optional | externalFundId |
External Award ID | Only applies to Rebuilt Awards where Import Award data was used to augment the Rebuild Disbursements. Otherwise it will not be on the EST. | Optional | externalAwardId |
Modified On | Date the disbursement was last modified | modifiedOn | |
Modified By | User ID who last modified the disbursement | modifiedBy | |
Created On | Date the disbursement was created | createdOn | |
Created By | User ID who created the disbursement | createdBy | |
Payment Period Type | |||
Payment Period ID | Payment Period ID | ID of the Payment Period. (REM's internally generated ID) | id |
Enrollment ID | Enrollment ID associated with this payment period. | enrollmentId | |
Program ID | Program ID associated with this payment period. | programId | |
Federal Award Year | Federal Award Year associated with this payment period. |
| |
Name | Payment period name. | Name | |
Description | Payment period description. | description | |
Start Date | Start date of the payment period. | Format is CCYY-MM-DD | startDate |
End Date | End date of the payment period. | Format is CCYY-MM-DD | endDate |
Academic Year | Academic Year that the payment period is associated with. |
| |
Academic Year ID | Regent Award internal academic year id. | Optional | academicYearID |
Term External ID | An identifier that is unique to the term that the student is enrolled in. | Maps to the External Site ID defined on Term Setup. |
|
Number | Payment period number. | Number | |
| AY start date for the payment period | Can be different than the 'Academic Year Start Date' under the 'Award Type' |
|
| AY End date for the payment period | Can be different than the 'Academic Year End Date' under the 'Award Type' |
|
| Student's SAP status for the Payment Period, if applicable. | Not Calculated |
|
SAP Appeal Status | Student's SAP status for the payment period, if applicable. | Rejected |
|
Fed Crossover Option | Indicates whether or not the payment period is a crossover payment period. | Former Year |
|
Days | Number of days in the payment period. | days | |
Weeks | Number of weeks in the payment period. | weeks | |
External Program Id | The externalProgramId provided for the program on Program Setup in Regent Award. | Optional | externalProgramId |
Modified On | Date the payment period was last modified | modifiedOn | |
Modified By | User ID who last modified the payment period | modifiedBy | |
Created On | Date the payment period was created | createdOn | |
Created By | User ID who created the payment period | createdBy | |
Fee Type | |||
Fee ID | Fee ID (Regent Award's internally generated ID) | Id | |
Amount | Total dollar amount of fee applied to the disbursement. | Amount | |
| Indicates whether the fee applied was a flat amount, or a percentage of the award/disbursement. |
| |
| |||
| |||
| The percentage or flat rate amount of the fee. For example, 1.000 percent. |
| |
Fee Component Name | Name of the fee component. |
| |
| |||
| |||
| |||
Modified On | Date the fee was last modified |
| |
Modified By | User ID who last modified the fee | modifiedBy | |
Created On | Date the fee was created | createdOn | |
Created By | User ID who created the fee | createdBy |
Expected transaction exports will adhere to the same rules as an actual transaction export, without any changes to award or disbursement data. Actual EST exports will use the filename format EST_Actual_date; Expected EST exports will use the filename format EST_Expected_date.
Valid State or Province Values
AA - MILITARY-AMERICAS | NC - NORTH CAROLINA |
Valid Country Values
AFAfghanistan | CLChile |
GPGuadeloupe | MVMaldives |
RU Russian Federation | TV Tuvalu |