...
Table of Contents |
---|
Overview
The Access ISIR Formatted file is a flat text file that uses the ISIR Layout Format for the applicable award year. Regent Access clients have the ability to import the ISIR Formatted Access file into their Student Information System (SIS) to assist in the auto-generation of required documents and the creation of process flows in the school's Financial Aid Management (FAM) system. A process can be scheduled to run the Access ISIR formatted file in Regent. Users with the correct permissions can also export the file via Regent. An Application Export file is also provided in CSV format for each question completed on the Regent Access application.
Application Export File
The Application Export File is a CSV file that includes all fields from all applications, excluding those in a ‘Not Started’ status. The file includes information such as the user identification that the student used when creating an account, answers provided in the application, application status, and chosen signature option. The file also includes the applicant’s dependency status and Expected Family Contribution (EFC), as determined based upon responses in the application. If more than one application exists for the same user on the same export file, a separate line is listed for each unique application.
Regent Access clients may opt to consume the Application Export File into their SIS or Document Management system in order to assign additional required documents (e.g. Verification documents) to the applicant based on specific information in the application (e.g. dependency status or EFC).
The file is run through the 'Export Access Database Extract File' in Export Processes in the Regent Process menu or as a Scheduled Process from a saved parameter set. The file is delivered to clients via a Secure File Transfer Protocol (sFTP). The file is available for download via a secure File Transfer Protocol (sFTP), in the “SNAP Exports” directory. Regent Access clients are asked to provide a list of IP addresses to be whitelisted by Regent. Whitelisting is a security feature that allows clients to define a list or range of trusted IP addresses from which users can access the sFTP.
Export Access Database Extract File Options
There are three selection parameters when setting up a Access Database Extract File to be ran.
- Completed Applications Only: Options are 'Yes' and 'No.' Determines whether "completed applications only" will be included in the run of the process or if the file will also include uncompleted applications.
- Include Dependency Status: Options are 'Yes' and 'No.' Determined whether a column for dependency status will be included or will not be included in the file.
- Export Type: Options are 'Export data for applications created or modified since last export’ and ‘Export data for all applications.'
- Note: A scheduled process can be set up to create the database extract file on a regular basis and only show new/updated applications since the last time the file was exported. It's important to note that if an "ad hoc" export process is ran, the next scheduled process may not include the expected results.
Access Export File in an ISIR Layout Format
The 'Enable Regent Access' configuration must be selected if a client is using the Access export file in an ISIR Layout Format. The Access export file in an ISIR Layout Format is a flat text file that is able to be manually generated for a given award year (e.g. 2021-2022) via the Export Processes Screen or scheduled via a Scheduled Process. Once the file is generated, it is accessible and downloadable from the sFTP ExporteAccessISIRFormat folder.
Export Processes Screen:
Scheduled Via a Scheduled Process:
Both the Scheduled processes and the Export processes are found under the Processes menu selection:
Export File Criteria
An Access application is exported when all of the following conditions are met:
- Application has been signed.
- Application has an FAY that is 2020-2021 and beyond.
- Combination of the distinct FAY/FSC (Federal School Code) that have not been exported before.
An Access ISIR Formatted file will be created for each distinct Federal Award Year/Federal School Code (FAY/FSC) combination. Only the Federal School Code and associated Housing Plan for the specific file being created will display as the "1st Federal School Code" in the file. No other Federal School Codes or associated Housing Plans listed will be present. For example, if an applicant selects 10 Federal School Codes on the application, 10 unique ISIRs will be created with each school’s Federal School Code and associated Housing Plan listed for the first Federal School Code.
Each file is named with the FAY and School code distinctly identified in the file name as follows:
- "eAccess" + "ISIRFormat" +"FAY" + "FSC" (e.g. eAccess_ISIRFormat_2021_09999_PROD_87_20200612_122706113.txt).
ISIRs in Regent
If the 'Enable Regent Access' configuration is enabled and Regent has enabled the process to route the export file into Regent, the ISIRs will be made available via the ISIR tab for each Institution with a corresponding Federal School Code list on the application. If an EFC recalculation is required, a staff user with the appropriate permissions can make a correction for the respective Institution via the ISIR Verification Wizard in Regent Award to generate a subsequent ISIR Record.
Regent Access clients also have the ability to import the ISIR Formatted Access flat text file into their Student Information System (SIS) to assist in the auto-generation of required documents (e.g. verification worksheet) and the creation of process flows in the school's Financial Aid Management (FAM) system. For example, the school’s FAM can be configured to create the Verification Worksheet upon an ISIR import and made available to students to complete via the school’s current portal. The verification process may surface corrections that require an EFC recalculation to determine eligibility. If an EFC recalculation is required, a staff user with the appropriate permissions can manually add a new document requirement in Regent Award for the applicant to complete again or the school’s current verification module within the FAM can be utilized.
All Access questions are mapped and formatted using the ISIR Data Record Layout from the EDE Technical Reference for the appropriate award year ( e.g. 2021-2021). All of the FAFSA questions are available if the question is part of the state-specific application. Not all Access data fields are able to map to an ISIR field and not all ISIR data fields are questions. For example, if the student has a social security number or DACA number, the ISIR Field 2 (originalSocialSecurityNumber) and ISIR Field 220 (studentsCurrentSocialSecurityNumber) values populate with the provided SSN or DACA number. If neither a social security number or a DACA number is provided, Regent uses the system's externalId1 with prefixed 0's to derive a 9-digit social security number that is used for both fields (e.g. 000000001). Note: Regent Access creates the externalId1 in numerical order as applications are created by students.
Below is a list of all derived fields in the Access Export file. If no derived value is present in the list below, the ISIR Data Record Layout from the EDE Technical Reference for the appropriate award year ( e.g. 2021-2021) will be used if the field is able to be mapped. Note: Some questions will not be mapped, such as state-specific questions.
...
yearIndicator
...
originalSocialSecurityNumber
...
Uses the parentsStateofLegalResidence (if it has a value); or if parentsStateofLegalResidence is blank, uses the studentsStateofLegalResidence; or if parentsStateofLegalResidence AND studentsPermanentState are both blank, use studentsPermanentState
...
TASFA applications only: Calculates 1 (for student) + 1 (for spouse, if studentsMaritalStatus = 2 or 3) + number of children (studentsNumberOfChildren) + number of dependents (studentsNumberOfDependents)
...
TASFA applications only: Uses the first federal school code configured for the TASFA application.
...
Uses 1AY for initial application and 1C for a correction application.
Table of Contents |
---|
Overview
The Access ISIR Formatted file is a flat text file that uses the ISIR Layout Format for the applicable award year. Regent Access clients have the ability to import the ISIR Formatted Access file into their Student Information System (SIS) to assist in the auto-generation of required documents and the creation of process flows in the school's Financial Aid Management (FAM) system. A process can be scheduled to run the Access ISIR formatted file in Regent. Users with the correct permissions can also export the file via Regent. An Application Export file is also provided in CSV format for each question completed on the Regent Access application.
Access Database Extract File
The Access Database Extract File is a CSV file that includes all fields from all applications, excluding those in a ‘Not Started’ status. The file includes information such as the user identification that the student used when creating an account, answers provided in the application, application status, and chosen signature option. The file also includes the applicant’s dependency status and Expected Family Contribution (EFC), as determined based upon responses in the application. If more than one application exists for the same user on the same export file, a separate line is listed for each unique application.
Regent Access clients may opt to consume the Access Database Extract File into their SIS or Document Management system in order to assign additional required documents (e.g. Verification documents) to the applicant based on specific information in the application (e.g. dependency status or EFC).
The file is run through the 'Export Access Database Extract File' in Export Processes in the Regent Process menu or as a Scheduled Process from a saved parameter set. The file is delivered to clients via a Secure File Transfer Protocol (sFTP). The file is available for download via a secure File Transfer Protocol (sFTP), in the “SNAP Exports” directory. Regent Access clients are asked to provide a list of IP addresses to be whitelisted by Regent. Whitelisting is a security feature that allows clients to define a list or range of trusted IP addresses from which users can access the sFTP.
Export Access Database Extract File Process Options
There are three selection parameters when setting up an Access Database Extract File to be ran.
- Completed Applications Only: Options are 'Yes' and 'No.' Determines whether "completed applications only" will be included in the run of the process or if the file will also include uncompleted applications.
- Include Dependency Status: Options are 'Yes' and 'No.' Determined whether a column for dependency status will be included or will not be included in the file.
- Export Type: Options are 'Export data for applications created or modified since last export’ and ‘Export data for all applications.'
- Note: A scheduled process can be set up to create the database extract file on a regular basis and only show new/updated applications since the last time the file was exported. It's important to note that if an "ad hoc" export process is ran, the next scheduled process may not include the expected results.
Export Access Database Extract File Layout and Mapping
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
The table below represents the file Access Database Extract File layout and field mapping for the 2024-2025 Access master form.
|
Access Export File in an ISIR Layout Format
The 'Enable Regent Access' configuration must be selected if a client is using the Access export file in an ISIR Layout Format. The Access export file in an ISIR Layout Format is a flat text file that is able to be manually generated for a given award year (e.g. 2021-2022) via the Export Processes Screen or scheduled via a Scheduled Process. Once the file is generated, it is accessible and downloadable from the sFTP ExporteAccessISIRFormat folder.
Export Processes Screen:
Scheduled Via a Scheduled Process:
Both the Scheduled processes and the Export processes are found under the Processes menu selection:
Export File Criteria
An Access application is exported when all of the following conditions are met:
- Application has been signed.
- Application has an FAY that is 2020-2021 and beyond.
- Combination of the distinct FAY/FSC (Federal School Code) that have not been exported before.
An Access ISIR Formatted file will be created for each distinct Federal Award Year/Federal School Code (FAY/FSC) combination. Only the Federal School Code and associated Housing Plan for the specific file being created will display as the "1st Federal School Code" in the file. No other Federal School Codes or associated Housing Plans listed will be present. For example, if an applicant selects 10 Federal School Codes on the application, 10 unique ISIRs will be created with each school’s Federal School Code and associated Housing Plan listed for the first Federal School Code.
Each file is named with the FAY and School code distinctly identified in the file name as follows:
- "eAccess" + "ISIRFormat" +"FAY" + "FSC" (e.g. eAccess_ISIRFormat_2021_09999_PROD_87_20200612_122706113.txt).
ISIRs in Regent
If the 'Enable Regent Access' configuration is enabled and Regent has enabled the process to route the export file into Regent, the ISIRs will be made available via the ISIR tab for each Institution with a corresponding Federal School Code list on the application. If an EFC recalculation is required, a staff user with the appropriate permissions can make a correction for the respective Institution via the ISIR Verification Wizard in Regent Award to generate a subsequent ISIR Record.
Regent Access clients also have the ability to import the ISIR Formatted Access flat text file into their Student Information System (SIS) to assist in the auto-generation of required documents (e.g. verification worksheet) and the creation of process flows in the school's Financial Aid Management (FAM) system. For example, the school’s FAM can be configured to create the Verification Worksheet upon an ISIR import and made available to students to complete via the school’s current portal. The verification process may surface corrections that require an EFC recalculation to determine eligibility. If an EFC recalculation is required, a staff user with the appropriate permissions can manually add a new document requirement in Regent Award for the applicant to complete again or the school’s current verification module within the FAM can be utilized.
All Access questions are mapped and formatted using the ISIR Data Record Layout from the EDE Technical Reference for the appropriate award year ( e.g. 2021-2021). All of the FAFSA questions are available if the question is part of the state-specific application. Not all Access data fields are able to map to an ISIR field and not all ISIR data fields are questions. For example, if the student has a social security number or DACA number, the ISIR Field 2 (originalSocialSecurityNumber) and ISIR Field 220 (studentsCurrentSocialSecurityNumber) values populate with the provided SSN or DACA number. If neither a social security number or a DACA number is provided, Regent uses the system's externalId1 with prefixed 0's to derive a 9-digit social security number that is used for both fields (e.g. 000000001). Note: Regent Access creates the externalId1 in numerical order as applications are created by students.
Below is a list of all derived fields in the Access Export file for 2024-2025 ISIRs. If no derived value is present in the list below, the ISIR Data Record Layout from the EDE Technical Reference for the appropriate award year ( e.g. 2024-2025) will be used if the field is able to be mapped. Note: Some questions will not be mapped, such as state-specific questions.
Expand | ||||
---|---|---|---|---|
ISIR Field Name | Derived Value | |
---|---|---|
yearIndicator | Uses 4 for the 2023-2024 Award Year, 5 for 2024-2025 Award Year, etc. | |
originalSocialSecurityNumber | Uses SSN if provided; otherwise uses the student externalId1 (assigned to the student by Regent Access) with prefixed 0's to derive the 9-digit social security number | |
originalNameID | Uses the first two characters of 'studentsLastName' | |
transactionNumber | Uses transactionNumber = '01' for first time application is being exported and increments the transaction number subsequent exports | |
studentsCitizenshipStatus | Always uses 3 for neither a U.S. Citizen or an Eligible Non-Citizen | |
parentsStateofLegalResidence | Uses the parentsStateofLegalResidence (if it has a value); or if parentsStateofLegalResidence is blank, uses the studentsStateofLegalResidence; or if parentsStateofLegalResidence AND studentsPermanentState are both blank, use studentsPermanentState | |
transactionDataSourceTypeCode | Uses 1AY for initial application and 1C for a correction application. | |
transactionReceiptDate | Use the current date upon the export of the Access ISIR-formatted file. | |
applicationDataSourceTypeCode | Uses '1A' value upon export of the Access ISIR Formatted File. | |
applicationReceiptDate | Uses the application or the correction date. | |
transactionProcessedDate | Use the current date upon the export of the Access ISIR-formatted file. | |
studentsCurrentSocialSecurityNumber | Uses SSN if provided; otherwise uses DACA number if provided; otherwise uses the student externalId1 (assigned to the student by Regent Access) with prefixed 0's to derive the 9-digit social security number. | |
applicationDataSourceTypeCode | Uses '1A' value upon export of the Access ISIR Formatted File. | |
applicationReceiptDate | Uses the application or the correction date. | |
computeNumber | Always uses a value of '000'. | |
transactionProcessedDate | Use the current date upon the export of the Access ISIR-formatted file. | |
simplifiedNeedsTest | Always uses a value of 'N' populate with No ("N"). | |
correctionFlags | Always uses zeros ("0") in each of the fields. | |
highlightFlags | Always uses zeros ("0") in each of the fields. | |
FAFSADataVerifyFlags | Always uses zeros ("0") in each of the fields. | |
commentCodes | Always uses zeros ("0") in each of the fields. | |
studentIsSelectedForVerification | Always uses a value of No ("N"). | |
Filler (Access Field: AccessISIR) | A value of 1 will be present in the first position of this filler space and is able to be used to identify the ISIR is an Access ISIR, if Regent Access is enabled. | |
Filler (Access Field: mainFederalSchoolCode) | A six-digit Federal School Code will be present beginning with the second position of this filler space and is able to be used to identify the school code to which the file is being routed, if Regent Access is enabled. | |
Filler (Access Field: studentExternalId) | The Regent Award studentExternalId for the default Institution (e.g. state-level) will be present if Regent Access is enabled and right justified and allow up to 60 characters in lengthcorrectionFlags | Always uses zeros ("0") in each of the fields. |
highlightFlags | Always uses zeros ("0") in each of the fields. | |
commentCodes | Always uses zeros ("0") in each of the fields. | |
studentIsSelectedForVerification | Always uses a value of No ("N"). | |
dependencyStatusCode | Dependency Status. For the initial 6.6.0.0 release, some "Unsub Only" students with special circumstances have the "X" values replaced with "Z" values. Possible values: D = Dependent, I = Independent, X = Rejected Dependent (allows awarding Unsub loans only), Y = Rejected Independent, and Z = Provisional Independent (2024-2025 and later). | |
efc | For 2024-2025 FAY and later, holds the value of the Student Aid Index (SAI). Numeric values, -1500 to 999999 or Blank For 2023-2024 FAY and earlier, holds the value of the Expected Family Contribution (EFC). | |
provisionalSAI | New for 2024-2025 and later. Provisional Student Aid Index (Provisional SAI). Numeric value, calculated instead of SAI for students with a Provisional Independent dependency status ("Z"). Numeric values, -1500 to 999999 or Blank | |
FISAPTotalIncome | Total Income for FISAP (Fiscal Operations Report and Application to Participate). Sum of Parents' Total Income and Student/Spouse Total Income. Numeric Integer, up to 15 characters including a negative sign, can be negative or blank. Values | |
Filler (Access Field: AccessISIR) | A value of 1 will be present in the first position of this filler space and is able to be used to identify the ISIR is an Access ISIR, if Regent Access is enabled. | |
Filler (Access Field: snapApplicationID) | The snapApplicationId on the Access ISIR provides a link between the ISIR ↔︎ and SNAP Application data for REM to use in the display as needed. Allows up to 15 digits. |
Regent Access clients are responsible for determining the criteria and process in which an Access ISIR file is matched to students in their system if the student does not have a social security number or DACA number (e.g. name, date of birth, and address).
Special Circumstances
When a student indicates that there is a "special circumstance" and will be unable to provide parent information on this application, the EFC value is affected:
...
mainFederalSchoolCode) | A six-digit Federal School Code will be present beginning with the second position of this filler space and is able to be used to identify the school code to which the file is being routed, if Regent Access is enabled. |
Filler (Access Field: studentExternalId) | The Regent Award studentExternalId for the default Institution (e.g. state-level) will be present if Regent Access is enabled and right justified and allow up to 60 characters in length. |
Filler (Access Field: snapApplicationID) | The snapApplicationId on the Access ISIR provides a link between the ISIR ↔︎ and SNAP Application data for REM to use in the display as needed. Allows up to 15 digits. |
Regent Access clients are responsible for determining the criteria and process in which an Access ISIR file is matched to students in their system if the student does not have a social security number or DACA number (e.g. name, date of birth, and address).
Permission
The "Export eAccess ISIR Format" permission is required to generate the Access Export file in an ISIR Layout Format and is located under the Global Permissions → Process Permissions → Export Processes. By default, all user roles, except the Regent admin role, will NOT have access to this permission (i.e. the permission will be disabled). The permission is enabled by default for the Regent admin user role.to this permission (i.e. the permission will be disabled). The permission is enabled by default for the Regent admin user role.
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Change Log
|