Configuring & Updating the Reports
  • 08 Aug 2025
  • 2 Minutes to read
  • Dark
    Light

Configuring & Updating the Reports

  • Dark
    Light

Article summary

The Standard Report files can be configured or modified within CX Builder by any user with Client Admin or Client User with Integration permissions in the system.  This feature is available in both the Staging and Production environments.

Enabling/Editing Reports

Step #

Description

CX Builder

1

Once you are signed in, click on the Report Configuration tab in the left menu column. This Report Configuration page allows you to view and make edits to the 7 Standard reports offered by Relay. This includes activating/deactivating reports, adjusting report frequency, fields included and more. Custom Reports are 'view only' and all reports will be available through standard SFTP file share.

Note: If you do not see the Report Configuration module on the left menu, please check that you have either Client Admin or Client User with Integration Permissions in the system.

2

Setting up a New Report

To setup a new report, locate the type of report you want to enable and click on Set Up to the right.

3

On this screen, you will be able to choose from a variety of configuration settings that best fits your needs for each report:

  • Frequency of Delivery: Drop down with options to choose how often you would like to receive the report: 4x Daily, Daily, Weekly, Monthly.

  • Fields included: These are the fields that will be included in the reports.  Fields that are mandatory are pre-selected, while additional fields can be selected/deselected depending on preference

  • EXT Fields: If your program utilizes EXT fields, you can choose to have all of these added into your report in single column in json format by selecting “Yes”. If they are not needed, you can leave it as “No”.

  • File type: .csv, .txt. Default value will be .csv

  • Delimiter: Options include comma, tab, pipe and text. Default value will be comma.

  • Column Headers Included in the File: Yes/No.  You can choose to remove the header from the reports by choosing “No”. Default value will be Yes.

  • Delimiter selected for the file: tab, comma, pipe. Default value will be comma.

  • Encapsulated fields in “ “: . Default value will be Yes.  This is a recommended setting.

  • Compression (Default is no): If you would like your files compressed (.gzip) check this box.

4

Activating the Report

Once you have chosen the desired settings for your report and you are ready to turn them on, click on Active at the bottom of the screen and Choose Save.

Depending on the frequency you chose for the report, it should post to the pickup/report folder at the next schedule cadence.

5

Editing an Existing Report

Relay can support multiple connections to the SFTP site.  To add an additional SSH2 key, click on Add SFTP Key above the current key.  This will take you back to Step 2 where you can copy the contents of the key into UI.

Custom Reports

Step #

Description

CX Builder

1

View Custom Reports

If your program has custom reports setup, you will be able to view these on the Custom Reports section of the  

2

Setting up a New Report

To setup a new report, locate the type of report you want to enable and click on Set Up to the right.


Was this article helpful?