Administration Manual

This settings category allows you to configure the connection settings necessary for FirstSpirit to communicate with translationstudio and vice versa.

Please provide the address and port FirstSpirit will use to access the translationstudio Application.

You can test the connections by clicking on the respective Test Connection button.

The translationstudio Application uses the given FirstSpirit user to access the respective projects. Make sure that this user has project access to all projects using translationstudio.

If your FirstSpirit requires a proxy configuration when connecting to it via FS API, you need to edit translationstudio’s configuration file ./conf/fs-proxy.properties and change the properties accordingly. A restart of the translationstudio application is required.

translationstudio has two processes which can be scheduled independently from one another:

Depending on your workload and translation timings it might be a good idea to configure the scheduling. By default, each process will be executed after a one minute break.

Usually, translations take longer and it might be enough wait for 1h between two translation checks.

These settings can be used to control the workload. Since exporting and importing data from and into FirstSpirit might impose significant workload on the server, you may want to avoid intense workload during your office hours. These settings allow you to consider such necessities.

Sometimes, you may need to analyse the exact data being exported from or imported into FirstSpirit. This is particularly important when you feel your translations are not inserted into the correct fields.

You will find a new directory in translationstudio’s application directory ./working/temp/export_* which contains all raw data including the translatable XML.

You will find a new directory in translationstudio’s application directory ./working/temp/import_* which contains all raw data.

translationstudio distinguishes between three kinds of mails:

You can test the connection and send a test e-mail to the administrator by clicking Test Settings.

The Receive Notifications section allows you to fine tune which kind of emails you would like to receive. By default, a notification will be sent to each user who requested a page or dataset to be translated. Whenever a status change occurs to this page, an email will be sent to the user if provided in the FirstSpirit user configuration. However, you may also only send all email notifications to the administrator’s email. Finally, you may also deactivate any user notification by sending notifications to nobody.

Quota configurations allow controlling when and how pages and datasets registered for translation are processed and when a translation job is actually being initiated.

There are 2 types of configuration available

Importantly, both types do not differ in terms of available options.

The default quota configuration can be used at any time and will also be used in case a previously defined custom quota configuration is removed from this list although there are elements already registered for translation.

You may add unlimited custom quota configurations under the respective tab’s panel.

The available settings will be described in the following:

A zero value in Number of pages required or Start if oldest element is X day(s) old deactivates the respective criterion.

A negative value for Start if deadline is reached in X day(s) deactivates the respective criterion.

Connectors are used to connect to various Translation Memory System (TMS). The following types of connectors are available.

The Filesystem Connector can only be configured but not removed. It will be used if no particular connector is required.

The AWS, DeepL and Google Translate connectors can only be used if you provide valid credentials and access keys in its respective configuration panel.

Custom connectors require additional configuration and can be added as needed.

The custom connector panel consists of 2 areas:

New connectors can be added or removed using the respective icons next to the list and 3 pieces of information are required for each available system in order to work properly:

You can (optionally) load the required data from a connector’s xml file which makes this installation easier. The xml file must follow the xml structure shown below (using data from the above screenshot to provide sample data). You can load the file using the load from file button in the upper right.

To configure the respective connector, click on the Configure button. Importantly: All changes made to the connector configuration will have to be confirmed using the Apply Changes button.

Please note: each connector provides a list of available projects. For example, a given TMS might provide specific projects for certain language pairs, e.g. from English to German or from English to French.

Other connectors, such as the filesystem connector only provide one single project. Importantly, each project has a unique id which is used to identify the respective project in the TMS. The list of available projects per connector is forwarded to FirstSpirit and available to projects and language mappings.

Depending on the connector and the underlying Translation Memory System (TMS), some TMS projects might be deleted or removed and, consequently, wont be available to translationstudio anymore.

Yet, existing language mappings might still have stored the id of the removed TMS project. Thus, it might be necessary to change these mappings and choose other target TMS projects or to remove the respective language mappings from the FirstSpirit project.

However, if a translation is requested using a language mapping with an invalid TMS project, the element might not be processed. Consequently, make sure that language mappings always use existing TMS projects.

This section contains several features which may be made available to translationstudio or not.

Translation Status Information
allows you to specify which kind of translation status updates you want to track and if an imported element is to be marked as "translated" in the CMS.

translationstudio keeps track of all the translation requests and you may choose to remove stored information which is older than a given number of days.

Validation Settings
provide features to validate the existence of elemnts about to be translated before actually adding them to a translation job.

translationstudio requires alphanumeric uid names as given by the SiteArchitect. Unfortunately, it is possible to add spaces characters and others. This causes problems when exporting the data to the filesystem (because they are mapped to the standard uid convention). Thus, translationstudio will not find it, but it may try and translate those non-standard uids. We strongly urge you to use standard uids, because this may cause data confusion and data loss!

Sometimes, translated XML files contain structural formatting (indentation, new lines, etc.) which may cause problems for the CMS during the import. Importantly, you may choose to remove such elements. This usually is unnecessary if you use a connector/TMS.

Translatable XML Format
translationstudio supports various XML formats and you may chose either of them as needed.

Metrics
translationstudio can collect metrics (word count of imported XML files and the pages/sections/datasets affected, number of files) which may be relevant for your company. If you receive a monthly summary by providing an email address (list) here. you have to activate metrics in the Monitor section.

This section allows you to add hooks in a convenient way. Simply add the hook’s respective package and class name implementing the hook interfaces.

translationstudio provides tools to monitor the application and to react to specific situations.

You may decide how often a check is to be carried out.

translationstudio is able to identify if a core process has died unexpectedly (e.g. due to an out of memory error) and to respond to such an event according to the settings provided here.

translationstudio can be installed automatically whenever you its project component to a FirstSpirit project.

If you want to install translationstudio simply by adding its project component automatically, you will have to meet the following requirements:

Usually, you do not want your editors to decide which translation language combination and TMS is to be used. This may result in illegal language combinations.

Therefore, supported combinations have to be created. Thereby, you as administrator define which languages can be used as source languages and which languages will be translated into.

To create a mapping, navigate to the Mappings folder fts_configuration in the Global Content Area and create a new page template using the template fts_gca_mapping as shown below:

The new page contains a list of language mappings in which translation directions can be configured. The list will be processed in parallel.

Each language mapping entry has 3 boxes

On start-up, the TMS Project list will only include a Filesystem project.

Once all languages for a mapping have been defined, the page can be closed and saved.

Pre-assigning specific language mappings to certain folders
It is possible to assign default mappings to any folder, which, of course, can be changed by the user individually if necessary. For example, if the default translation mapping is German to English, this mapping can be assigned to a folder using the meta data form of the respective element. However, the assignment might be changed on the workflow form (see below) any time.

For example, if you want to set the above mapping as default for the entire page store, select the Page Content root element in the SiteArchitect, open the meta data form and follow the instructions as depicted below:

As a result, the form which is provided whenever a user starts a translation workflow has the above pre-selected language mapping. This default value can be changed any time by simply choosing another page reference.

translationstudio uses workflows and permissions have to be configured. This has to be done for the Page content, Data sources and Structure separately.

Use the respective context menus on the top level items. The actual configuration depends on your project configuration. In the example below, the permissions to use workflows will be granted to the group Everyone.

Each workflow contains a number of different transitions which may have specific permissions to be executed. By default, each transition requires the user to make changes to the element the workflow is being executed on. You can change this at anytime as shown below.

Scheduled tasks are required to submit translation requests and are created automatically.

translationstudio knows which task to execute and you do not need to worry about this.

A status indicator icon allows you to access available translation status information in a page preview.

To add this feature, please paste the following JavaScript into the respective page templates:

$CMS_RENDER(template:"translationstudio_statusicon")$

Importantly, this template requires the existence of a global web application.

It is possible to add custom fields to each of translationstudio’s workflow script forms. In generall, the following input components are supported:

You can edit the dedicated script template translationstudio_customfields to add those custom input components. TranlationStudio will automatically load this form XML and add it to its workflow form and even keep the defaults set here (if available).

Oncce created, this script template will never be overwritten by translationstudio again.

There are 2 options available to work with the custom input data from your custom input components:

translationstudio allows you to add 2 template fields which can be used as a template (these wil l also be described in the custom fields template). If custom input data is available, a separate file will be created alongside the translatable XML files.

You may add an immediate translation helper by installing the necessary content creator web components.

In addition, you will have to configure the Amazon Web Services, DeepL or Google Translate connector and activate the flag Allow this connector to perform direct translation attempts.

If activated, a new icon will be visible in the ContentCreator:

Clicking on this icon will cause a new dialog to appear which requires the user to configure the source and target language for the translation task ahead. Thereafter, the user can request an immediate translation using the Amazon Web Services connector (see above).

To limit access to the TranslationHelper, you can add the following CMS_INPUT_TEXTAREA fields to your project properties template.

When using ContentCreator, the current user will be checked against any potential restriction. If the given user matches at least one (name or group), the permission will be granted.

If you do not want to include Translation Memory System filter options to your list of report filter options, you can add a language independent CMS_INPUT_TOGGLE input component with the name pp_translationstudio_hide_report_tms to your project properties template.

To activate the setting in the ContentCreator, you will have to restart the web application after having made changes to this field.

By default, translationstudio will automatically send your translation requests to the TranlationStudio Application right away. Yet, if you do not wish this to happen, there are 2 options.

translationstudio requires lowercase alphanumeric reference names which may include an underscore - i.e. the pattern FirstSpirit uses by default. Since the API allows you to add any kind of reference name, you may include characters that may cause problems. The export operation will automatically convert such reference names to the default pattern. However, this may cause problems identifying which "invalid" reference name belongs to which converted name.

Importantly, translationstudio will check for such "problematic" reference names before showing the translation request form and, if necessary, include a warning. If you do not wish translationstudio to check for such reference names, you can add a language independent CMS_INPUT_TOGGLE input component with the name pp_translationstudio_skip_uid_analysis to your project properties template.

When translationstudio translates a page’s label and display name, it automatically detects all navigation references (i.e. PageRef) and their respective parent folder (i.e. PageFolderRef).

Sometimes, you might want to exclude this folder (or its page, i.e. PageRef) from translation. To do you, you can add a CMS_INPUT_TOGGLE form element to your meta data template: