1. Installing the Connector

Please install connector’s FirstSpirit Module via ServerManager.

Thereafter, you can open TranslationStudio’s configuration panel, navigate to custom connectors, click on the add button and choose the connector from the given list. Its configuration panel will open automatically.

2. Requirements

An existing SFTP server is required in order to upload translatable XML files and to download translated files automatically.

TranslationStudio requires a target folder to access via SFTP. Inside this folders, the following two folders are required:

  • translatable (for uploading translatable XMLs or ZIPs)

  • translated (for downloading translated XMLs)

The translated folder must not be used for other purposes and the user connecting via SFTP requires write access.

3. Configuration

3.1. Connection

The connector requires valid connection settings to be able to connection to the SFTP Server.

Connection
Server and Port

Provide the name or the IP address of the target SFTP server, as well as its port (default is 22).

Both, the address and port must be reachable by TranslationStudio’s application server.
Remote Directory

The remote directory is used to determine where to store files on the SFTP server. As noted above, the connecting user has to have write access to this directory as well as its two required subfolders

  • translatable

  • translated

These directories will not be created by the connector.
User

The user provided here will be used to connect to the SFTP server. The same user will be used for both, uploading and downloading files.

3.1.4. Method for Authentication

It is possible to connect to the SFTP server by using two methods:

  • Password

  • Public Key

3.1.5. Password

If you want to connect via password, it can be entered here.

3.1.6. Show Public Key

If you want to connect via Public Key, the password field will be disabled.

In this case, you have to deploy a public key to the remote server. The public and the private key are generated automatically by the SFTP Connector.

To access the public key, you press the button "Show Public Key".

Public Key

The button "Copy to Clipboard" copies the key to your system clipboard. From here, it can be inserted in the appropriate files on the remote server.

Test Connection

You can test the connection settings including a permission check of the remote directory.

3.2. Settings

The connector can be configured to fit your needs. The available settings are located in this area.

Setting
Quota Configuration

You have to decide which quote configuration you want to use for this connector.

3.2.2. Copy Translatable Files

This checkbox determines if uploaded files should be kept in the ./working/translatable directory after having been uploaded successfully.

3.2.3. Create Zip Archive

The connector allows you to compress translatable XML files and their related files into a single ZIP file. This can reduce the amount of files sent to the server.

3.2.4. Email Notification Settings

If desired, the connector informs one or more persons if new files are uploaded and available on the SFTP server.

4. Security Considerations

TranslationStudio will only download XML files and ignore all other files in the remote ./translated directory. Importantly, TranslationStudio will not parse custom entities in the XML’s DTD or process external entities to avoid XML external entity (XXE) injection. Yet, TranslationStudio will not verify the XML file’s mime type but assume that the XML file really is an XML file. TranslationStudio will also not evaluate the translated XML’s file size (e.g. really large files).