Add an SFTP integration method

Use this method to securely automate the transfer of a translation job as a ZIP file to and from an ftp site.

  • After you create a translation job that uses the SFTP integration method, Inspire securely uploads the job as a ZIP file to a specified site by encrypting all data and commands.

    Inspire uses a job number in all SFTP requests.

    • This ensures that if there are multiple ZIP files they are grouped together.

    • The ZIP files are saved to a folder on the FTP server where the folder's name is the job number.

    • No sensitive information is included in the requests.
  • After all the ZIP files are uploaded, Inspire changes the job's Status to In Progress.
  • When the vendor completes the job, Inspire downloads and imports the updated ZIP file for you.
  • Inspire also updates the status of the translation job to Complete.

The SFTP integration method includes the following built-in features to make sure a translation job completes successfully:

  • If a translation job is In Progress and an administrator changes the KeyVault Name in the SFTP Integration Method, then the SFTP Transfer Service receives a notification to update this information in its database. This allows the SFTP integration to continue to work as expected.
  • If a submission or retrieval attempt fails, Inspire will try again after a set number of seconds. Only after the maximum number of retries is attempted does Inspire set the translation job to a failed state.
  • If a retrieval only contains a partial completion of work, the job's retrieval requests are tracked so that Inspire can perform multiple attempts to retrieve the entire job.
  • The SFTP Transfer Service sends log messages to Inspire so that an administrator can troubleshoot.

Before you begin

  • Your FTP site must be integrated with a secrets manager. For example: Azure Key Vault, AWS Secrets Manager, or a custom enterprise credential vault. This is a system used to store the FTP credentials with a unique name (or key) to identify the secret.
  • Inspire only supports sending and receiving translation files as a ZIP with the SFTP integration method.
  • Your vendor must return the translated files in a ZIP archive back to the same folder if you want Inspire to download and import the files using the SFTP method.

To add an SFTP integration method:

  1. Create the SFTP integration method.
    • Give the integration method a name.
    • Select the SFTP method.
  2. Update the SFTP integration method with server details.
    • You now see the empty JSON file:
      {"Host":"","Port":0,"Username":"","Password":"","SubmissionSubfolder":"","RetrievalSubFolder":"","WebHookSecurity":{"SecurityMethod":0,"ApiKeyHeaderName":"","ApiKeyValue":"","UserName":"","Password":""}}
    • Edit the configuration to add your FTP site details.