For Symphony Super Administrators and MCO eComms implementation teams.
Before you begin
Confirm you have Super Administrator access to the Symphony Messaging Admin Portal.
Confirm the Symphony region used by your organization.
Confirm the export format is set to Symphony XML.
Confirm whether the export should run on a recurring schedule or as an ad hoc export.
Confirm the Pretty Good Privacy (PGP) public key and private key process for your organization.
Confirm the Secure Shell (SSH) key that MCO eComms should use to access the Symphony-hosted Secure File Transfer Protocol (SFTP) location.
Symphony SFTP export overview
Symphony Messaging supports content export through a Symphony-hosted SFTP location. The Symphony Messaging Admin Portal allows you to configure the export format and delivery schedule.
MCO eComms requires the Symphony XML export format for Symphony Messaging archiving.
Exports can run as a recurring daily batch or as an ad hoc export. After Symphony creates the export files, MCO eComms retrieves the files from the Symphony-hosted SFTP location for processing.
Configure payload encryption
Exported Symphony files are encrypted using the PGP standard. Before MCO eComms can process exported content, the export must use a PGP 4096-bit public RSA key.
Sign in to the Symphony Messaging Admin Portal as a Super Administrator.
Go to the content export key generation area.
Configure the PGP public RSA key using one of the following methods:
MethodDescriptionGenerate the key pair internallyYour organization generates the PGP key pair and adds the public key in the Symphony Messaging Admin Portal.Generate the key pair in SymphonySymphony generates the key pair in the Admin Portal. If this method is already configured, provide the private key to MCO eComms so exported files can be decrypted.
Confirm the PGP key is active for the Symphony content export.
WARNING! MCO eComms must have access to the matching PGP private key to decrypt exported Symphony files. Do not send private keys through unsecured channels.
Configure SFTP access
MCO eComms retrieves exported Symphony content from the Symphony-hosted SFTP location. The SFTP URL must match your Symphony region.
Region | SFTP URL |
US | sftp-us-east-1.symphony.com |
EU | sftp-eu-west-1.symphony.com |
APAC | sftp-ap-southeast-1.symphony.com |
SFTP access is authenticated using SSH.
In the Symphony Messaging Admin Portal, open the SFTP setup area.
Confirm the correct regional SFTP URL.
Create or replace the SSH key used for SFTP authentication.
Provide the SSH key required for SFTP access to MCO eComms.
Confirm with MCO eComms that the SFTP connection can be established.
NOTE: SFTP setup is usually a one-time configuration. You only need to update it if your organization changes the export schedule, security configuration, or export format.
Configure content export
In the Symphony Messaging Admin Portal, open the content export settings.
Set the export format to Symphony XML.
[!WARNING]
MCO eComms requires Symphony XML. Do not use Actiance XML or EML for this integration.Choose the export type:
Recurring export - Symphony creates a scheduled batch export, usually daily.
Ad hoc export - Symphony creates an export for a specific request or timeframe
Confirm the export uses the configured PGP public key.
Confirm the export is available from the Symphony-hosted SFTP location.
Save the export configuration.
Provide connection details to MCO eComms
After Symphony SFTP export is configured, provide the required access details to MCO eComms through your implementation contact or support ticket.
Include the following information:
Detail | Description |
Symphony region | The region that determines the SFTP URL: US, EU, or APAC. |
SFTP URL | The Symphony-hosted SFTP endpoint for your region. |
SSH key details | The SSH authentication information MCO eComms needs to connect to the SFTP location. |
PGP private key | The private key required to decrypt exported files, if MCO eComms does not already have it. |
Export format | Symphony XML. |
Export schedule | The recurring or ad hoc export schedule. |
How it works
Step | Description |
Configure encryption | A PGP 4096-bit public RSA key is configured in the Symphony Messaging Admin Portal. |
Configure SFTP access | Symphony-hosted SFTP access is configured using the correct regional SFTP URL and SSH authentication. |
Configure export settings | The export format is set to Symphony XML, and the recurring or ad hoc export schedule is configured in Symphony. |
Provide details to MCO | Your organization provides MCO eComms with the required SFTP, SSH, PGP, and export details. |
Retrieve content | MCO eComms connects to the Symphony-hosted SFTP location and downloads the exported content. |
Decrypt files | MCO eComms decrypts the exported files using the matching PGP private key. |
Import communications | MCO eComms processes the exported Symphony XML content for archival and review. |
Review communications | Compliance users can search, monitor, and review captured Symphony communications in MCO eComms. |
Result
Symphony Messaging exports supported communications in Symphony XML format to a Symphony-hosted SFTP location. MCO eComms retrieves the exported files, decrypts them, and imports the communications into the archive according to your organization’s configured policies and license limitations.