Group Configuration Files

From Lingoport Wiki
Revision as of 22:49, 27 November 2018 by Llawson (talk | contribs) (config_pseudo_loc.xml)
Jump to: navigation, search


Group Configuration Files are copied over to the L10nStreamlining/<group name>/config folder during the create group process. The original configuration files are located in the ../lingoport/lrm-server-xx/deploy/templates/dir_structure/group folder. These files can be moved to the project level if more granularity is needed. The files can also be moved to the global level if less granularity is needed.

Configuration files can be at the global, group or project level.

Global: <HOME>/Lingoport_Data/L10nStreamlining/config

Group: <HOME>/Lingoport_Data/L10nStreamlining/<group name>/config

Project: <HOME>/Lingoport_Data/L10nStreamlining/<group name>/projects/<project name>/config

If there are duplicate files, the project level takes precedence, followed by the group level, and finally the global level.

Group Name

A group name must conform to the following specification: A set of alphanumeric characters without the following special characters:

  • < (less than)
  • > (greater than)
  •  : (colon)
  • " (double quote)
  • / (forward slash)
  • \ (backslash)
  • | (vertical bar or pipe)
  •  ? (question mark)
  • * (asterisk)
  • (space)
  •  % (percentage)
  • -- (more than 1 consecutive dash)

Group File Structure

Under the L10n Streamlining directory (typically <HOME>/Lingoport_Data/L10nStreamlining), each group file structure follows this pattern:

├── config
│   ├── config_due_dates.xml
│   ├──
│   ├──
│   ├──
│   ├── config_pseudo_loc.xml
│   ├──
│   └──
└── projects
    └── <project 1>
        ├── config
        │   ├── config_email_recipients.xml
        │   └──

Each of the group configuration files can be copied to the project 'config' directory if a project has a configuration different from other projects in that group.

For more information on the global configuration files, visit the Global Configuration Files page.

For more information on the project configuration files, visit the Project Configuration Files page.

This section describes the configuration at the group level


This file specifies how many working days a prep kit is expected to be translated based on the number of words. A typical file looks like this:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
                <threshold max="50"   nb-work-days="2" />
                <threshold max="200"  nb-work-days="3" />
                <threshold max="500"  nb-work-days="5" />
                <threshold max="1000" nb-work-days="10" />
                <threshold max="5000" nb-work-days="15" />
                <threshold max=""     nb-work-days="20" />

For example: if you are translating 453 words, you expect it to complete in 5 days. You can add, modify or remove thresholds.


This file specifies for all the group's project how files will be sent to translation. The details of this configuration must be worked out with the translation group, for instance, what ID's Lingotek will provide this company or this group within the company.

This file is configured at installation time by Lingoport and should not be modified thereafter.

For more information see L10n_Vendors

This file maps the locales used in the application to the locales used by Lingotek. For instance, if 'fr' is a locale in the application, it may map to fr_fr or fr_ca depending on the situation.

A typical file is formatted this way:


This file contains information about:

  • type of prep kits to create; full-file or changes-only.
Defaults to changes-only. This means that only the deltas will be sent to translation. Of course, if the target file doesn't exist then the entire base resource file will be sent to translation.
  • starting characters of a json comment
Defaults to an underscore, _. LRM reads/writes comments to the translated file.
  • track back pattern
The track back pattern is used when creating trackback resource files. Track Back are special resource files that are used to help developers and/or technical linguists identify the file or the key for that text.

A typical file looks like this:

#Default to changes only prep kits

#The information that can be captured in a track resource file is:
# base file Name denoted with parameter ${filename}
# base file Path denoted with parameter ${filepath}
# key denoted with parameter ${key}
# group name denoted with parameter ${group}
# project name denoted with parameter ${project}
#Example for base file "" with resource file key 'test.key', the with pattern ${key}|${filename} would be:
# test.key|
#Default pattern is ${key}|${filename} but can be change using any of the above parameters


This file determines how the base file (typically U.S. English) will be pseudo localized.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
                        <length max="10" expand-percentage="200"/>
                        <length max="20" expand-percentage="100"/>
                        <length max="30" expand-percentage="80"/>
                        <length max="50" expand-percentage="60"/>
                        <length max="70" expand-percentage="40"/>
                        <length max=""   expand-percentage="30"/>
                <!-- End characters are ‘ П國カ내’ (with a leading space) -->
                <!-- П: A Cyrillic character - (for Russian or ‘R’) -->
                <!-- 國: A common Chinese character (Hanzi, Kanji or Hanja) defined in Unicode BMP or Plane 0 – (for Chinese or ‘C’) -->
                <!-- カ: A Katakana character (used for Japanese or ‘J’) -->
                <!-- 내: A Hangul character (for Korean or ‘K’) -->
                <expansion-end-chars> П國カ내</expansion-end-chars>
        <!-- Value for accented characters is '1' if the text should be accented -->
        <!-- Flag indicating whether to add instrumented (non-printable unicode characters) to the start and end of the string
             The instrumented characters will be before any start character and after any end character 
             0 - do not add instrumented characters 
             1 - add instrumented characters     -->

This file maps the LRM supported locales with the unique Worldserver Locale where the LRM locale is the key and the Worldserver Locale is the value. If a target locale is missing from this file then prep kit files will not be uploaded to Worldserver. This file can exist at the project and group levels.

A typical file is formatted this way where fr_fr is one of the target locales:


Lingoport copies this file over at group creation.

This file maps a LRM supported locale with its corresponding Worldserver project type where the LRM locale is the key and the Worldserver project type is the value. If a target locale is missing from this file then prep kit files will not be uploaded to Worldserver. This file can exist at the project level and group levels

A typical file is formatted this way where fr_fr is one of the target locales:


Lingoport copies this file over at group creation.