Configuring Q2 Gro-Image Exporter Integration – Q2 Documentation

Note

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

After the Image 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 Image Exporter, set the “enable” key to true. Conversely, to disable the Image Exporter, set the “enable” key to false.

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

[
   {
        "name": "ApplicantReport",
        "description": "Upload Image Exporter",
        "cronExpr": "0 0 18 1/1 * ? *",
        "typeOfJob": "UploadApplicantImagesJob",
        "enable": true,
        "brandId": "999999"   }
]

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

Property	Description
`name`	This value can be changed to nearly any value, but the Gro standard is to name the file “ApplicantReport”. 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 Image Exporter”. 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`).

In addition to configuring the Image Exported job to run, you also need to add connection details to provide a destination location for the files. Edit the server.database.export.images Type ID to include the following properties, then customize the values for your FI.

SFTP template

{
    "columns": [
        "uv:brand" or "uv:customerId",
        "SSN",
        "FIRST_NAME",
        "LAST_NAME"    ],
    "ftp": {
        "type": "SFTP",
        "url": "",
        "username": "gro-uat",
        "password": "superpassword123",
        "path": "/Gro/UAT/Images",
        "port": 22,
        "sftpStrict": true
    }
}

FTPS template

{
    "columns": [
        "uv:brand"or "uv:customerId",
        "SSN",
        "FIRST_NAME",
        "LAST_NAME"    ],

    "ftp": {
        "type": "FTPS",
        "url": "",
        "username": "gro-uat",
        "password": "superpassword123",
        "path": "/Gro/UAT/Images",
        "port": 990,
        "protocol": "TLS",
        "isImplicit": true
    }
}

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

Property	Description
`type`	This value can be `SFTP` or `FTPS`, depending on the type of protocol your financial institution chooses.
`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.
`path`	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 `IMAGE_EXPORTER`, then the `path` would be `/IMAGE_EXPORTER`.
`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 port) but there isn't a restriction to these ports as long as they are accessible.
`sftpStrict`	This value is a Boolean value based on the File Transfer Protocol. If the FTP is defined as an 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.
`protocol`	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 `FTPS`, this configuration can be deleted.
`isImplicit`	This value is a Boolean value 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 `FTPS`, then this configuration must be set to `false` or can be deleted from the configuration.

To test this functionality, complete a transaction after Image 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, IMAGE_UPLOAD_TEST, and enable the file transfer and your financial institution will receive the image files and index file in your file repository if the file transfer for the image export files is successful.

Note

Related articles

IN THIS ARTICLE