Index Files – Q2 Documentation

The index file is created for each file transfer request. The file contains a summary of all images included for each batch transfer in a CSV/TXT/XML format.

This file contains rows of information about each applicant, with each row containing the information for one applicant. Each row contains the SSN, first name, last name, date of the application, and the name of the PDF file that contains their application. Your FI can use the data in the index file to match image files within the batch transfer to the correct applicant.

You can use the following template to customize the data included in the index file for each transfer. Add this configuration block to theserver.workflow.service.custom.indexFileSettings Type ID and update it to match your FI's needs, using the property and description information below.

{
 "exportFormat": "<XML/CSV/TXT>",
    "isAllData": "false",
    "exportImageAppStatus": "<Incomplete/Approved/Referred..>",
    "isNotificationOn": "false",
    "notificationFailureemail": "<any_valid_email@q2ebanking.com>",
   "additionalIndexFields": {
      "jointApplicant": "true/false",
      "memberId": "true/false ",
      "appRefId": "true/false ",
      "applicationStatus": "true"/false,
      "accountNumber": "true/false ",
     "isauthenticated": "true/false ",
        "productType": "true/false”,
   },
   "includeHeaders": "true/false",
   "emptyValueRepresentation": "",
   "multiValueSeperator": "|",
   "documentTypeValue": "3"},

Property	Description
`exportFormat`	This value can be set to XML, CSV, or TXT, but only one format can be set.
`isAllData`	This value can be set to `true` or `false`. The default is `false`. Changing this to `true` will export all existing applications, including new applications.
`exportImageAppStatus`	This value can be changed to configure the statuses to export. The default is `Approved`.
`isNotificationOn`	This value can be set to `true` or `false`. The default is `false`. Changing this to `true` will send an email notification to the email address provided for `notificationFailureemail` when the export fails.
`notificationFailureemail`	The email defined here is sent a notification if the export fails when the `isNotificationOn` configuration is set to `true`.
`additionalIndexFields`	These values can be added into your index file in addition to the default.
`jointApplicant`	When set to `true`, this displays whether the application was a joint application.
`memberId`	When set to `true`, this displays the member ID.
`appRefId`	When set to `true`, this displays the application reference ID.
`applicationStatus`	When set to `true`, this displays the application status.
`accountNumber`	When set to `true`, this displays the account number.
`Isauthenticated`	When set to `true`, this displays whether or not the applicant came in through the authenticated workflow.
`productType`	When set to `true`, this displays the product(s) selected in the application.
`includeHeaders`	When set to `true`, this displays the headers within the Index File.
`multiValueSeperator`	This is the separator defined for CSV format.
`documentTypeValue`	This value can be changed to any value.

IN THIS ARTICLE