Global Configuration Files

Global File Structure

The global configuration files are located in config directory under the L10n Streamlining directory (typically ~jenkins/Lingoport_Data/L10nStreamlining)

<L10nStreamlining>
├── config
│   ├── config_attask.properties
│   ├── config_custom_tasks.xml
│   ├── config_email_global.xml
│   ├── config_file_cherry_picker.xml
│   ├── config_lingotek_api.properties
│   ├── config_lingotek_file_format.properties
│   ├── sonar-project-template.properties
│   
├── <group_name>
│   ├── config
│       ...
│   
└── projects
    └── <project 1>
        ├── config
        ...

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.

config_attask.properties

The config_attask.properties 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		  
attask.groupid=
attask.ownerid=
attask.url=
attask.login.user=
attask.login.password=
#available tokens ${groupname}, ${projectname}, ${kitversion}, ${sendkitname} ${sendkitid}
attask.project.name.format=${groupname}-${projectname}-${kitversion}

#Non-required attributes
attask.templateid=
#available tokens ${groupname}, ${projectname}, ${kitversion}, ${sendkitname} ${sendkitid}
attask.task.linkto.url=

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.

config_custom_tasks.xml

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.

config_email_global.xml

Configuration file for setting up the sender's email credentials for all emails that are sent by the LRM process. In addition, there are configuration settings for when to send out notification emails and whether or not to send out the 'No Files to Prep' email. The default settings are:

• Notification Email will be sent every week. The notification email lists the locales that need to be prep, the files that will be in the next prep kit as well as all the outstanding prep kits.
• Late Prep Kit Email:
  • Email is sent every week if there are late prep kits
  • A prep kit is deemed 'late' if it is more than 7 days late
• 'No Files to Prep' email will be sent out when there is a request to prep a kit but there are no files to prep. If a Jenkins job is created that automatically attempts to prep a kit, then this value should be set so that the email is not sent. Otherwise, the email recipient's inbox may be inundated with 'No Files to Prep' emails.

This file resides only at the global level.

config_file_cherry_picker.xml

This is a template file 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.

config_lingotek_api.properties

This 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 (config_l10n_vendor.properties). Any edits made to this file may cause prep kits to fail when uploading to Lingotek.

This file resides only at the global level.

config_lingotek_file_format.properties

This configuration files 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 (config_l10n_vendor.properties).

This file resides only at the global level.

sonar-project-template.properties

This file is the default sonar configuration used to push data to the Dashboard. This file resides only at the global level.