The Star Connector
Overview
The Star Connector provides an out-of-the-box integration with Star Translation Services. For more information about Star Translation Services, visit www.star-ts.com.
When to Use
Use the Star Connector to enable automated translation workflows between Bloomreach Content and Star Translation Services.
Prerequisites
- Access to a Star Translation Services account.
- Bloomreach Content with the Translations Add-on installed.
Installation
-
Add the
translations-addon-connector-stardependency to your project. For detailed instructions, see the installation guide. -
Configure the connector class in the repository:
/hippo:configuration/hippo:modules/translation-services-daemon/hippo:moduleconfig/translationsaddon:connector/className= com.bloomreach.cms.translations.connector.star.StarTranslationConnector
- Obtain the required configuration settings from your Star Translation Services account. If you do not have an account, request one from Star.
Configuration
You can configure the Star Connector using environment variables, system properties, or directly in the JCR. Environment variables are recommended for managing sensitive information.
Environment Variable Mapping
Set the following environment variables to configure the connector without storing values in the JCR:
| Property | Environment Variable |
|---|---|
| star.externalServiceUrl | STAR_EXTERNALSERVICEURL |
| star.username | STAR_USERNAME |
| star.password | STAR_PASSWORD |
| star.localesMap | STAR_LOCALESMAP |
If these environment variables are not set, the connector will use system properties. If neither is set, it will fall back to the values stored in the JCR.
JCR Configuration Properties
Configure the following properties at the translationsaddon:connector node:
| String property | Default value | Description |
|---|---|---|
| star.externalServiceUrl | URL of the STAR API | |
| star.username | Username for STAR API (BASIC AUTH) | |
| star.password | Password for STAR API (BASIC AUTH) | |
| star.localesMap | {"en":"ENU", "de":"DEU", "nl":"NLD", "fr":"FRA"} | Required. JSON string mapping ISO locales to Microsoft LCID locales used by STAR. Since 5.1.0. |
| star.serviceTypeName | STAR workflow to invoke | |
| star.jobNamePrefix | J | Prefix for all STAR job names |
| star.jobNameDigits | 7 | Length of job numbers |
| star.themeName | STAR | Name of the translation memory to use at STAR |
| star.jobGroupName | STAR | Name for the group of jobs (e.g., website, marketing) |
| star.jobGroups | STAR | Comma-separated list of job group names to accept when polling for ready jobs. Since 5.2.0. |
| star.pjtTemplate | STAR.pjt | PJT file to use |
| star.deadlineDays | 10 | Number of days for each request deadline |
| star.customerShortName | STAR | Customer name as recognized by STAR |
| star.pmUserName | StarPM | STAR project manager |
Enable Translation Results Processing
To ensure translation results are imported into the repository, enable the translation results processing scheduler job as described below.
- Locate the following node in the repository:
/hippo:configuration/hippo:modules/scheduler/hippo:moduleconfig/translationsaddon/TranslationResultsProcessor/hipposched:triggers/every-minute
-
Set the
hipposched:enabledproperty totrueand save the changes. -
(Optional) Adjust the
hipposched:cronExpressionproperty to change how frequently the job checks for translation results from the remote server.
Verification
- Confirm that translation jobs are sent to Star Translation Services.
- Verify that completed translation results are imported into the repository according to the configured schedule.