Global Configuration Files

From Lingoport Wiki
Revision as of 21:11, 8 September 2017 by Llawson (talk | contribs) (config_email_global.xml)
Jump to: navigation, search

Some 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.

Global File Structure

The global configuration files are located in config directory under the L10n Streamlining directory (typically <HOME>/Lingoport_Data/L10nStreamlining)

├── config
│   ├──
│   ├── config_custom_tasks.xml
│   ├── config_email_global.xml
│   ├── config_file_cherry_picker.xml
│   ├──
│   ├──
│   ├──
│   ├──
├── <group_name>
│   ├── config
│       ...
│   │   
│   └── projects
│       └── <project 1>
│          ├── config
│           ...
├── logs

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

For more information on the group configuration files, visit the Group Configuration Files page.

Most of the global config files contain information that is consistent throughout all groups and projects.

The file is the configuration file for creating an AtTask (Workfront) project that corresponds with a prep kit.

Each task under the AtTask project will correspond to one locale in the prep kit. A document listing the changed keys will be uploaded for each task.

A template as well as a URL may be attached to each task if configured.

The attributes for setting up AtTask is as follows:

#Required attributes		  
#available tokens ${groupname}, ${projectname}, ${kitversion}, ${sendkitname} ${sendkitid}${groupname}-${projectname}-${kitversion}

#Non-required attributes
#available tokens ${groupname}, ${projectname}, ${kitversion}, ${sendkitname} ${sendkitid}

In addition to the configuration file, the config_custom_tasks.xml must be set up properly. (See Custom Tasks)

This file may reside at the project level, group level and global level.


The config_custom_tasks.xml configuration file contains the specific stages where a plugin can be called. Dynamic information is available to the plugin through the LRM Context object (com.lingoport.lrm.customtask.LRMContext). The lrm-customtasktest.jar, located in the samples/CustomTask/ folder of your install directory, contains methods for testing out these different stages.

This file may reside at the project level, group level and global level.


File config_email_global.xml is the configuration file for setting up the sender's email credentials for all emails that are sent by the LRM process. It is located in the global <HOME>/Lingoport_Data/L10nStreamlining/config folder.

The config_email_global.xml file is used by a project's Notifications Jenkins job in order to send out status emails. This Jenkins job is, by default, set to run once a week.

See Sending Emails for more information.


The config_file_cherry_picker.xml file is a template to be copied under the project config directory if needed.

It helps special situations where files to be sent for translation are far and few and possibly locale dependent. This should be used with care.

This file resides only at the project level but is moved into the project level when it is being used.

The file is a configuration file that contains the lingotek api calls and should not be edited. It is used if the L10n vendor for a group/project is set to Lingotek ( Any edits made to this file may cause prep kits to fail when uploading to Lingotek.

This file resides only at the global level.

The configuration file contains the file format mapping for uploading documents into Lingotek. It is used if the L10n vendor for a group/project is set to Lingotek (

This file resides only at the global level.