- 08 Aug 2025
- 2 Minutes to read
- Print
- DarkLight
Configuring the SFTP
- Updated on 08 Aug 2025
- 2 Minutes to read
- Print
- DarkLight
The SFTP connection can be configured 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.
Adding a New Integration
Step # | Description | CX Builder |
---|---|---|
1 | Once you are signed in, click on the SFTP & GPG in the left menu column. Remain on the Relay Hosted SFTP tab. This is the “home page” of the connections to the Relay SFTP site. Note: If you do not see the SFTP & GPG module on the left menu, please check that you have either Client Admin or Client User with Integration Permissions in the system. | |
2 | Locate the Public SSH2 key you created for the connection, and copy and paste the contents of the key into the SSH key contents box, and then click Upload below it. Note: If your key does not start with “---- BEGIN SSH2 PUBLIC KEY ----” then you will need to convert it from standard SSH format to SSH2 format. This can be done by clicking on the carrot to the right for instructions on how to create a converted key before loading it into the SSH key contents box. | |
3 | Once the key is successfully loaded, it will be listed on the main screen as shown to the right. To test connectivity to the SFTP, you will authenticate with your username and the private SSH2 key you created. The username is listed next to “SFTP keys for:” within the UI. | |
4 | Automated File Processing - ON or OFF Once a file is loaded to the appropriate Relay SFTP folder, it will automatically be processed by the system. To turn this feature off and have the file stay in idle status for manual processing/scheduling, toggle the switch to OFF in the right hand corner. | |
5 | Adding Additional Connections 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. | |
6 | Deleting Old Connections To delete an old or expired SSH2 key, click on the trash can icon to the right. |
Adding a GPG Key for Encryption
Step # | Description | CX Builder |
---|---|---|
1 | Once you are signed in, click on the SFTP & GPG in the left menu column. Click on the File Encryption tab. This is the “home page” of the connections to the Relay SFTP site. Note: If you do not see the SFTP & GPG module on the left menu, please check that you have either Client Admin or Client User with Integration Permissions in the system. | |
2 | Locate the Public GPG key you created for encryption, and click on Select GPG Key File, choose the file from your computer. | |
3 | Once the key information has successfully populated on the screen as shown to the right, click on Submit. The reports you receive from Relay from the pickup/report folder will now be encrypted with this public key. To decrypt the file, please use the private GPG stored in your system. | |
4 | Deleting a GPG key To delete an old or expired GPG key, click on the Delete button at the bottom of the key information screen. |