1. Installing the Connector

To install the connector, please install the FSM via FirstSpirit 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

The connector uses the crossApi and requires

  • an accessible cossApi URL

  • valid user credentials

  • an existing document template called TranslationStudio XML

Further information about document templates and their creation is available at https://www.across.net/en/online-help/als/project-management/documents/document-settings-templates

Sometimes, an XML file may be rejected by Across due to file size limitations. Please consult https://confext.across.net/display/ASCS/FileManager.SendFileToServer to find information on how to check on solve potential file size related issues.

You can reach the across interface page at https://www.across.net/en/interfaces/firstspirit-cms

3. Configuration

3.1. Account Configuration

You have to provide valid credentials here.

Account Configuration
Figure 1. Account Configuration

Now, please click on Update Projects Workflows to fetch required across settings.

Thereafter, you can continue with language and project settings configuration.

3.2. Languages

Across uses its own language code identifiers (LCI) whereas FirstSpirit uses language abbreviations.

Consequently, you have to tell across which LCI to use for a given FirstSpirit language.

Languages and LCIs
Figure 2. Languages and LCIs

Conveniently, you may click on the button Load Language Codes to automatically fetch all FirstSpirit languages actually in use and try to match it against the known LCIs.

If no LCI can be found, the language abbreviation is added to the list and you have to add a LCI manually. A full list can be obtained here:

3.3. Project Settings

In order to make an across project available to TranslationStudio, you have to create a new project by clicking on the button add. The project created here will be made available to TranslationStudio’s language mappings.

Project Settings
Figure 3. Project Settings

If your across project requires custom attributes to be set, you may those in the respective text field. Each attribute requires a value in order to work. If the case sensitive attribute does not exist or is not available to your project, it will be ignored.

Each line may contain exactly 1 attribute and its value. The name is case sensitive.

An example may look like this

attribute name1=actual value
attribute2=some other value
Please do not forget to save your changes.

4. How the Connector Works

The connector allows you to submit files for translations to across, monitor the translation progress as well as download translated documents and importing them into FirstSpirit automatically.

4.1. Project Management

The across connector provides 2 ways of storing translatable XML files.

  1. Store files in an existing project
    If you want to store translation requests by language, you may want to use a project already available in across and use it to centralise the translation into a distinct target language.

  2. Create new projects for each translation request
    You may also create new projects which contain only those files being made available at a given moment. Thus, several translation requests may be stored in different projects.

Either of these two approaches can be chosen when configuring your project settings using the across connector’s configuration panel.

4.2. How Monitoring Works

The across connector monitors the translation progress and downloads files marked as completed automatically.

When a translatable file is stored in an across project, a unique identifier (GUID) is created by across which allows the connector to specifically find this particular file at a later stage.

This GUID is stored by TranslationStudio and used to monitor the translation progress of the respective file. After a translated file has been downloaded from across, its GUID is removed from TranslationStudio’s monitoring database.

Importantly, the connector does not change any states, neither of individual files not of the respective across project.

If you upload a file into across manually TranslationStudio will not be able to monitor the file’s progress sine its GUID is not known. For example, you might have downloaded a translatable XML file from across to check its content (and have it removed from the across project). Thereafter, you may wish to upload the file to across again and have it translated. However, since the GUID has changed, TranslationStudio will not be able to monitor this file. Fortunately, this is a rather rare scenario but it is sufficient to provide an insight into how the across connector works.

4.3. Best Practices

Since there are a few things to configure, it is recommended to create a working configuration in a stage or development environment which allows you to test your across and TranslationStudio settings extensively.

It is recommended to submit only a single file first instead of bulk files.

Once you find that all settings are correct, you then transfer those settings to your production environment.

4.4. Troubleshooting

The following list of potential issues might be helpful to avoid problems:

The connector cannot access across
Assuming that the credentials provided are correct, please make sure that the across api URL is accessible by the server hosting TranslationStudio. You may find further error notifications in TranslationStudio’s log file.

Although some files are uploaded, some translatable files do not appear in across
This is a common issue but solved just as easily. Usually, it is related to missing language configurations. Please make sure that both, the source and target language, have a correct language code assignment.

Translated files are not being imported
There are a few potential causes for such a situation. First, make sure that the respective file marked as completed. A mere 100% completion indicator does not suffice. TranslationStudio will only download files that are marked as completed specifically. Second, you may want to check whether the file has been downloaded and is still waiting to be processed (see TranslationStudio’s working/translated folder). Finally, you may always consult the log files to see if there is any other problem, such as rules not met by page or section templates (these may have been introduced only after the translatable file has been stored in across). Please note that you can always download a translated file manually and store it in TranslationStudio’s working/translated folder.

Across does not show a 100% match although all terms should be known
This is an issue with across and is not related to TranslationStudio.

Please do not hesitate to contact your helpdesk if you experience other issues not mentioned above.

TranslationStudio cannot upload files
It is possible that XML files cannot be uploaded to the TMS. The reason given might be this:

Invalid Content-Type:text/html. Is this an error message instead of a SOAP response

This misleading error message points to the XML exceeding file size limitations. You can find further information at https://confext.across.net/display/ASCS/FileManager.SendFileToServer

In the meantime, you may split the page to be translated into several parts (using the "translate this page" workflow) to temporarily reduce the file size.