Configuring Q2 Gro-PDF Exporter Integration – Q2 Documentation

Note

Before you can begin changing you configuration to enable this feature, you must contact Q2 to enable PDF Exporter for your FI.

After the PDF Exporter function has been enabled for your FI, a user with configuration specialist access must add a configuration value to the server.quartz.settings.jobs Type ID. To enable the PDF Exporter, set the “enable” key to true. Conversely, to disable the PDF Exporter, set the “enable” key to false.

Next, copy and paste this configuration subset into the server.quartz.settings.jobs:

    {
        "name": "ApplicantReportPDF",
        "description": "Upload Applicant PDF Report",
        "cronExpr": "0 30 7 1/1 * ? *",
        "typeOfJob": "UploadApplicantJob",
        "enable": true,
        "brandId": "999999"    }
]

These properties are different for each FI and PDF Exporter integration.

Property	Description
`name`	This value can be changed to nearly any value, but the Gro standard is to name the file “ApplicantReportPDF”. This value can be different between UAT and Production.
`description`	This value can be changed to nearly any value, but the Gro standard is to name the file “Upload Applicant PDF Report”. This value can be different between UAT and Production.
`cronExpr`	This value is a “cron expression” generation tool that sets what time of day to send out the batch transfer of image files, how frequently, and what days. For example, “0 30 16 1/1 * ? *” would generate and send a batch file every day at 4:30 PM. For more information on generating chron expressions, refer to http://www.cronmaker.com/.
`brandId`	This value is specific to the tenant that your financial institution is utilizing. If you are an enterprise customer with only one tenant, your `brandId`will be `999999`. If you are a Gro Community customer or have multiple tenants as an enterprise customer, your `brandId`will match the brand ID number that is presented in your financial institution’s URL (e.g., https://s3.amazonaws.com/supersonicbank-prod/index.html?brand=333333 has a `brandId`of `333333`).

Note: If you are running both the PDF Exporter and the Image Exporter, it is recommended to set export times at least 10 minutes apart (cronExpr) so performance issues do not occur.

In addition to configuring the PDF Exporter job to run, you also need to add connection details to provide a destination location for the files. Edit the server.workflow.service.pdfftp.connectionDetails Type ID to include the following properties, then customize the values for your FI.

SFTP template

{
    "ftpUrl": "",
    "ftpUsername": "gro-uat",
    "ftpPassword": "superpassword123",
    "ftpPort": 22,
    "ftpsIsImplicit": false, 
    "includeCsvIndexFile": true,
    "filterStatus": "approved",
    "intervalDaysDate": 14,
    "ftpType": "SFTP",
    "ftpDirectory": "/Gro/UAT/Applications",
    "memberNumberKey": "none",
    "sftpStrict": true,
    "includeTodaysApplications": true
}

FTPS template

{
    "ftpUrl": "",
    "ftpUsername": "gro-uat",
    "ftpPassword": "superpassword123",
    "ftpPort": 990,
    "ftpsIsImplicit": true,
    "includeCsvIndexFile": true,
    "filterStatus": "approved",
    "intervalDaysDate": 14,
    "ftpsProtocol": "TLS",
    "ftpType": "FTPS",
    "ftpDirectory": "/Gro/UAT/Applications",
    "memberNumberKey": "none",
    "isTlsExtendedMasterSecret": false,
    "includeTodaysApplications": true
}

The properties and values are different for each FI and PDF Exporter integration.

Property	Description
`url`	This value is the IP Address or URL of the FTP location that your financial institution will be utilizing to receive the image and index files. If your financial institution chooses to leverage an IP Address, a VPN connection will likely be necessary.
`username`	This value is the username to access your FTPS or SFTP.
`password`	This value is the password to access your FTPS or SFTP.
`port`	This value is the port of the FTP that your files will route through. FTP typically defaults to port 21 and SFTP typically defaults to 22 (standard SSH ports) but there isn't a restriction to these ports as long as they are accessible.
`ftpsIsImplicit`	This value is based on the file transfer protocol set in the `type` value. If the FTP type is defined as `FTPS`, then this configuration must be set to `true`. If the FTP is defined as `SFTP`, then this configuration must be set to `false` or can be deleted from the configuration.
`includeCsvIndexFile`	When set to `true`, this includes the Index File with the PDF applications.
`filterStatus`	This value can be changed to configure the statuses to export. The default is `approved`.
`intervalDaysDate`	This value is by default set to 14, which means that all applications from the past 14 days will export to the SFTP or FTPS (the PDF batch file will not send an applicant more than once). This can be changed to be any number (in terms of days).
`ftpsProtocol`	This value is only needed when the FTP `type` is set to `FTPS`, and can be set `SSL` (Secure Socket Layer) or `TLS` (Transport Layer Security), though this is usually TLS.This value is only necessary for FTPS, and if the FTP is defined as `SFTP`, this configuration can be deleted.
`ftpType`	This value can be `SFTP` or `FTPS`, depending on the type of protocol your financial institution chooses.
`ftpDirectory`	This value is the file directory where your image and index files will be exported to. For example, if a primary folder is set up with the name `PDF_EXPORTER`, then the `path` would be `/PDF_EXPORTER`.
`memberNumberKey`
`isTlsExtendedMasterSecret`	This value is `true` or `false` value based on the File Type Protocol; if the FTP is defined as `FTPS`, then this configuration must be set to `true`. If the FTP is defined as `SFTP`, then this configuration can be deleted or set to `false`.
`sftpStrict`	This value is based on the File Transfer Protocol. If the FTP is defined as `SFTP`, then this configuration must be set to `true`. If the FTP is defined as an FTPS, then this configuration must be set to `false` or can be deleted from the configuration.
`includeTodaysApplications`	When set to `true`, you will receive PDF reports for currently created applications. The default value is `true`.
`zipFile`	When set to `true`, all files, including the index file, will be exported in .zip file format.
`zipFileExtension`	This value represents the file extension of the file name. For example, when this value is set to "csvzip", the file name will display as "[file name].csvzip".
`zipFilePrefix`	This value represents the file name's prefix. For example, when this value is set to "applicants", the file name will display as "applicants_$[formatted_date].zip", where zipFileExtension is set to "zip". Note When a date is included in the file name, it must be formatted as yyyyMMdd'T'HHmmss.

Copy, paste, and customize the following configuration subset into the server.report.pdf.settings, using the property and description information below.

{
    "includeImages": true,
    "UVExcludes": "",
    "includeUV": true,
    "IncludeLogo": true,
    "daysRangeMax": 31,
    "appCountMax": 1000
}

The properties and values are different for each FI and PDF Exporter integration.

Property	Description
`includeImages`	This value is `true` or `false,` based on whether your FI would like to have the driver's license and signature images included on the PDF report; if your financial institution would like this, then this configuration must be set to true. If your financial institution does not want this logo, then this configuration must be set to false.
`UVExcludes`	This value can can be changed if there are specific "Unstructured Variables" that you would like to exclude from the list.
`includeUV`	This value is a true or false value based on whether the financial institution would like to have the “Unstructured Variables” of each applicant in the PDF batch file; if your financial institution would like this information, then this configuration must be set to true. If your financial institution does not want this information, then this configuration must be set to false.
`IncludeLogo`	This value is a true or false value based on whether the financial institution would like to have the logo in the upper left-hand corner of the PDF batch file; if your financial institution would like this logo, then this configuration must be set to true. If your financial institution does not want this logo, then this configuration must be set to false.
`daysRangeMax`	This value contains the number of days' applications to export. For example, if you set this value to 31, then the PDF report will contain the past 31 days of applications. Note: It is not recommended to exceed 31 days, as it could cause performance issues.
`appCountMax`	This value contains the maximum amount of applications to export. For example, if you set this value to 1000, then the PDF report will contain no more than 1000 applications.

To test this functionality, complete a transaction after the PDF Exporter integration has been enabled (by both your FI and Q2) and configured to specify your FI's file transfer protocol information. For example, your financial institution could create a file directory, PDF_UPLOAD_TEST, and enable the file transfer, and, if the file transfer for the PDF export files is successful, your financial institution will receive the PDF applications and index file in your file repository.

Note

Note

IN THIS ARTICLE