Installation Manual

Please consult the TranslationStudio

for a detailed list of requirements.

TranslationStudio consists of the following components:

While the FirstSpirit Module (FSM) has to be installed and configured using the FirstSpirit ServerManager, the TranslationStudio Application can be installed on any server, unless a sharing of resources is possible.

Both modules, or “programmes”, communicate with each other using a specific port the TranslationStudio Application binds to. The TranslationStudio Application will connect to FirstSpirit using the FS_ACCESS API.

The way you install the TranslationStudio Application depends on the operation system of the server you are installing on and whether the FirstSpirit system is located on the same server or on a different server (same server installation vs. different server installation). If you are installing on different servers, the installation guide will give you special information for handling that scenario whenever necessary.

<property name="use-embedded-database" internal="use-embedded-database" value="false"/>

<property internal="use-embedded-in-memory" name="use-embedded-in-memory" value="true"/>

<property name="use-embedded-database" internal="use-embedded-database" value="false"/>

<application>
  ...
  <property internal="MinaPort" name="application-port"
  value="1235"/>
</application>

<application>
  ...
  <property internal="MinaPort" name="application-port"
  value="1235"/>
</application>

<application>
  ...
  <property name="tls-keystore-file" internal="tls-keystore-file" value="" />
  <property name="tls-keystore-type" internal="tls-keystore-type" value="JKS" />
  <property name="tls-keystore-password" internal="tls-keystore-password" value="" />
  <property name="tls-certificate-password" internal="tls-certificate-password" value="" />
  <property name="tls-algorithm" internal="tls-algorithm" value="ssl.KeyManagerFactory.algorithm" />
  <property name="tls-protocol" internal="tls-protocol" value="TLS" />
</application>

The TranslationStudio FSM Module has to be installed on the FirstSpirit Server. To do so, open the FirstSpirit ServerManager, access the server properties and select Modules. Click on the Install button as shown below and follow the steps below.

Figure 1. ServerManager Modules list.

A new dialog opens and you have to navigate to the C:\translationstudio\install\temp\module folder (Microsoft Windows) or /home/fs5/translationstudio/install/temp/module folder (Linux) and the FSM file by selecting it and clicking on the button Open as depicted below.

Figure 2. Install the FSM file.

Once the module is installed successfully, you will find the list entry TranslationStudio with several items once expanded.

Select TranslationStudio Service and Configuration from the list and start the service if it has not already been started.

Once the service has started you can configure the module by selecting the module TranslationStudio and clicking on the Configure button. Please select the checkbox to grant all permissions as shown below.

Figure 3. Granting module permissions.

To enable the Translation Status Icon (ContentCreator, Preview) and the Dashboard, you have to add a new global web app component.

To install this web application, access the server properties in ServerManager and select Web applications, click on the add button, choose FirstSpiritJetty and enter the following information:

Figure 4. Installing the global web application

Now, you can add the TranslationStudio Dashboard and Status Icon component via the Add button.

Thereafter, you have to configure the newly added component by selecting it and clicking on the configure button.

Figure 5. Configuration

The only available option to select is Load from TranslationStudio button. Clicking on this will load TranslationStudio’s server and port information as set in the module’s current configuration.

Once loaded, you can close the dialog by clicking on OK. Finally, you can install the new web application by clicking on the Install button as depicted below.

TranslationStudio requires a database which can be added by editing the FirstSpirit ServerManager server properties and by making it available to the target project.

A detailed instruction may be found in the official FirstSpirit Manual for Administrators. You may use a Derby database, although this is not recommended due to performance considerations.

Edit the target project using ServerManager, select Project components from the settings list and click on the add button. A window will open allowing you to choose from a list of various installed components. Select TranslationStudio Project Preparations and click on the OK button.

By adding this project component, a setup script will be created in this project (see below for further information)

Installing a project component. 

You may now store the changes by closing the window using the OK button.

Once the project component is installed, you may wish to create a distinct user which is used by the TranslationStudio Application for accessing FirstSpirit.

Please create this user using FirstSpirit ServerManager if required.

Open the SiteArchitect and access the target project to grant the following permissions to all, Page Content/PageStore, Site Structure/SiteStore and Global Settings/Global Content Area:

A detailed instruction how to create users may be found in the official FirstSpirit Manual for Administrators. To change or assign user permissions in a project please consult the official FirstSpirit SiteArchitect (Manual for Editors and Project developers).

To create a new database schema, select the template store, right-click on Database Schemata and select Create new schema. In this example, a new schema called translationstudio will be assumed. You may also use an already existing schema.

To create all required structures and scripts, right click on the newly created (or already existing) database schema and execute the script Install or Update TranslationStudio from Execute Script - TranslationStudio in the context menu.

The script will add a database table to the schema, install all required scripts and folders (Site structure, Page content, Data sources, Templates, Global Settings). What is more, the script will also create all neccessaryy scheduled tasks (preview and queue mode).

Importantly, TranslationStudio requires an assigned meta data template to work properly. If the project does not have a meta data template, the setup process will create a new one. However, it has to be assigned using the FirstSpirit ServerManager.

If a meta data template has been set, the script will add the required section automatically and no further action is required by the administrator. To assign this meta template, open the FirstSpirit ServerManager and navigate to the configuration of your project and select Option from the list. Select the target meta template in the select field Metadata template and click OK.

Figure 6. Selecting a Meta Template

Now you can go back to the SiteArchitect and make the necessary changes to the form of the Metadata template as described in the section above.

Language mappings are global content pages which allow you to define legitimate source and target language combinations as well as assign a target connector.

A language mapping page uses the page template fts_gca_mapping as shown below:

Figure 7. Creating a new Language Mappings page

To add activate the Report and Immediate Translation Helper Plugin, you simply have to add a web component TranslationStudio ContentCreator Extensions to a ContentCreator web application.

You can add this either to the specific project’s ContentCreator app or to the global ContentCreator app.

In the following, the extensions will be added to the project specific ContentCreator app.

Open the FirstSpirit ServerManager, edit the respective project’s properties and select Web components from the list on the left, click on the tab ContentCreator, click on the button Add and select the TranslationStudio plugin entry from the list and click on OK.

Figure 8. Adding a web component

Thereafter, select the active web server, e.g. FirstSpiritJetty. Finally, click on the button Install.

A dialog box will pop up asking you if you really want to proceed. After having confirmed this, you have to click on the button Execute now to start the process. After the installation process has finished, you have to active the web server.

The report component will now be available to your project in the ContentCreator. To use the TranslationHelper plugin, you have to configure the default AWS and/or DeepL connector first.

Further information on how to install and deploy web components may be found in the respective FirstSpirit manuals.

TranslationStudio can be installed automatically whenever you its project component to a FirstSpirit project. In addition, TranslationStudio can also update its component in your projects automatically whenever you install a new version (via update uses).

To enable this feature, open the TranslationStudio configuration dialog and open the Distribute section.

If you do not have a special preview template set / output channel, a special hook allows you to create HTML preview files from translatable XML files.

To add this hook, add the following tmsimport hook class to the TranslationStudio Application’s conf/hooks.xml file:

<class name="com.idmedia.fts.fs.hooks.basics.CreateHtmlPreview" />

This hook uses the XSLT file cont/translationstudio.xsl to transform a translatable XML file. You can customise this file at any time.

It is possible to add new custom features to TranslationStudio using the API to implement

Please consult the manual on how to extend TranslationStudio and the respective tutorials for further information.

It is possible to add a cronjob to the TranslationStudio Application. This cronjob will allow you to execute a shell/terminal command regularly. To implement this, create the file

./conf/modules-custom.xml

(if necessary) and add the following XML node to the root services node:

<service class="com.idmedia.translationstudio.module.system.CronjobModule">
    <property name="execute-command" value="./cronscript" />
    <property name="sleep-minutes" value="5" />
</service>

In this example, the cronjob will execute the bash script cronscript every 5 minutes. Adding this to the modules XML may result in the following:

<?xml version="1.0" encoding="UTF-8"?>
<services>
  <service class="com.idmedia.translationstudio.module.system.CronjobModule">
	<property name="execute-command" value="./cronscript" />
    <property name="sleep-minutes" value="5" />
  </service>
</services>

If you want to log the command’s result, please add the following entry to the ./conf/logging.properties file:

com.idmedia.translationstudio.helper.ExecuteShellCommandOperation.level=FINE

To install a connector’s FSM, please follow the instructions below.

Now, you can configure the connector using TranslationStudio’s configuration gui.

Thereafter, the connector can be selected from the Connector list in the respective language mappings template.

To deploy the connector’s JAR file, please follow the instructions below. If you use a connector provided by TranslationStudio, you may skip this section.

Sometimes, the log fie does not contain all output from the application. Therefore, you may start it from command line/shell using the following command

On Linux:
java -cp .:./lib/*:translationstudio.jar -Xloggc:log/gc.log -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=log/crash.hprof -Djava.util.logging.config.file=conf/logging.properties -Dtranslationstudio_basedir== com.idmedia.translationstudio.ServiceMain console

or on Windows:
java -cp .;./lib/*;translationstudio.jar -Xloggc:log/gc.log -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=log/crash.hprof -Djava.util.logging.config.file=conf/logging.properties -Dtranslationstudio_basedir== com.idmedia.translationstudio.ServiceMain console

Please make sure to run this command from within the TranslationStudio Applicationfolder.

You may also execute

./translationstudio console

on Linux, or

console.bat

on Windows from the command line.

This situation occurs if either of the respective processes dies silently. The health monitor email will provide you with a list of affected processes in such as case.

Usually, such a situation is related to memory shortages of the JVM and can be solved by increasing the allocated memory.

In general, TranslationStudio works fine with CorporateContent.

If you use CorporateContent and publish versions of TranslationStudio from its own project, please read the following sections carefully.

6.3.1. Preparing Languages

Let’s say your TranslationStudio template project uses EN as a master language. Now, you want to setup a new project which needs TranslationStudio but which uses EN_GB as a master language.

Although it will not be a problem to transfer all necessary templates, the language mappings in TranslationStudio’s database templates will cause problems, because FirstSpirit will not update language mappings of language independent fields automatically, i.e. although the input components only use language independent fields, the language association will not be updated.

All you have to do is to add the new language to the TranslationStudio project (EN_GB in this example) and update the TranslationStudio database template’s language mappings manually.

Figure 9. Make sure all master languages are available and mapped to the table fields

6.3.2. Creating a Template Package

Create a subscription package which contains all of TranslationStudio’s templates, database and workflows. Relevant objects can easily be spotted as they are kept inside individual TranslationStudio folders.

Figure 10. Selected objects contain TranslationStudio folders

Subscribing projects might have their own master language. It is essential that this master language is also available in the project offering the subscription packages. FirstSpirit will not update any table template language mapping.

6.3.3. 6.3.3. Creating a Global Content and Site Structure Package

Each project using TranslationStudio requires the TranslationStudio workspace site structure folder and the TranslationStudio language mappings global content folder.

Figure 11. Global Content Area Folder

Figure 12. Structure

Therefore, create a package which allows to transfer these folders as well.

6.3.5. Post Installation/Update Verification

You may wish to verify that all settings have been updated correctly. To do so, navigate to the TranslationStudio scripts, open the "Form" tab and click on the "eye" icon left to the magnifying glass icon. The only field framed in red should be the mappings reference field. If this is the case, all is fine.

Figure 13. Reviewing the form defaults

Sometimes, a connector cannot establish a connection to a Translation Memory Server although the network settings are correct and the server should be reachable.

Usually, this happens when the server uses a self-signed certificate or a certificate which is not stored in the JDK’s keystore.

By default, the TranslationStudio Application will use the JDK’s default keystore, so you have to add the certificate and restart the TranslationStudio Application.

TranslationStudio contains the following software packages. Each software package is legally protected according to the given license information. This product includes software developed by the Apache Software Foundation.

Amazon Web Services, the “Powered by AWS” logo, are trademarks of Amazon.com, Inc. or its affiliates in the United States and/or other countries.

The Technical Support of the e-Spirit AG provides expert technical support to customers and partners covering any topic related to the FirstSpirit product. You can get and find more help concerning relevant topics in the FirstSpirit community.