Through the Yext platform, you can choose to send a single invite to generate a review from a specific customer, multiple invites to generate them from a larger audience, or use an SFTP (Secure File Transfer Protocol) Server Connection. This article explains how to add and manage an SFTP Server Connection to generate reviews.

To add a new SFTP Server Connection:

1. Click Reviews in the navigation bar and click Generation.
2. Click Send Invites.
3. Click on the Add New Connection button under SFTP Server Connection.
4. Enter a name for your connection in the text box.
5. Select your desired schedule.
   
   • Note: If you select None, your SFTP Server Connection will need to be run manually, which is explained in the next section of this article.
6. Enter the host address of your server without the protocol (sftp://) in the text box.
7. Enter the port to connect to in the text box. The default port for SFTP is 22.
8. Select your desired authentication method.
   
   • Username & Password
     1. Select Basic Authentication from the drop-down menu.
     2. Enter your Username in the text box.
     3. Enter your Password in the text box.
   • SSH Private Key
     1. Select SSH Private Key from the drop-down menu.
     2. Enter your Username in the text box.
     3. Enter your SSH Private Key in the text box.
        1. Note: The platform only supports RSA keys and not OpenSSH keys. Also, in order to use SSH Private Key authentication with AWS, the security policy of the SFTP server must be set to “TransferSecurityPolicy-2018-11” or "TransferSecurityPolicy-Restricted-2018-11”.
9. Select your desired lookup strategy and fill out the fields accordingly.
   
   • For more information about these file settings, see the SFTP Server Connection for Review Generation reference documentation.
10. Click Save.

 

To manage an SFTP Server Connection:

1. Click Reviews in the navigation bar and click Generation.
2. Click Send Invites.
3. Click on the drop-down button next to Add New Connection button under SFTP Server Connection and click Manage Connections.
4. The steps to manage your existing SFTP Server Connections differ depending on what you would like to do. Follow the steps below accordingly:
   
   • View Connection Configuration & Connection Logs
     1. Click on the View button next to the desired connection.
        • View Logs
          1. Click on the Logs tab.
          2. (Optional) Click Download Details for more information.
   • Edit a Connection Configuration
     1. Click on the View button next to the desired connection.
     2. Click on the field you would like to edit.
     3. Make your desired changes.
     4. Click Save.
   • Manually Run a Connection
     1. Click on the drop-down button next to the desired connection and click Run Now in the drop-down menu.
   • Enable or Disable a Connection
     1. Click on the drop-down button next to the desired connection and select the option to Enable or Disable the connection in the drop-down menu.
        • Note: If Maximum Contact Frequency is disabled, you will not be able to enable connections. You can read more about this setting in the next section.
   • Delete a Connection
     1. Click on the drop-down button next to the desired connection and click Delete in the drop-down menu. A dialog box appears.
     2. If applicable, enter the name of the connection in the text box.
     3. Click Delete.

 

Maximum Contact Frequency

Maximum Contact Frequency is a required setting for using SFTP Server Connections for Review Generation. This prevents duplicate invites from being sent during each scheduled SFTP file pickup.

If the Maximum Contact Frequency setting is Disabled, you must enable it in order to automatically or manually run any existing SFTP Server Connections.

If the Maximum Contact Frequency setting is Enabled, you must disable or delete any existing SFTP Server Connections before you can disable it.

To update the Maximum Contact Frequency setting:

1. Click Reviews in the navigation bar and click Generation.
2. Click Settings.
3. Click on the Maximum Contact Frequency field and select your desired options.
   • Select whether the changes Applies to All Entities or Applies Per Entity.
   • Select the max frequency at which invites can be sent.
     • Note: If you select Once, you will never send more than one review invitation to each customer. 
4. Click Save.