Difference between revisions of "Global Configuration Files"

From Lingoport Wiki
Jump to: navigation, search
(config_email_global.xml)
(config_email_global.xml)
Line 80: Line 80:
 
== config_email_global.xml ==
 
== config_email_global.xml ==
   
The '''config_email_global.xml''' file is the configuration file for setting up the sender's email credentials for all emails that are sent by the LRM process.
+
File '''<code>config_email_global.xml</code>''' 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 '''<code><HOME>/Lingoport_Data/L10nStreamlining/config</code>''' 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.
  +
  +
There are 3 types of information contained in the ''config_email_global.xml'' file.
  +
* email configuration
  +
* interval between the sending of status emails
  +
* flag indicating whether to send out the 'No Files to Prep' email
  +
  +
=== Email Configurations ===
  +
The specification need in particular to be set for the smtp-host, the smtp-auth, the email-sender, the sender-password, and the jenkins-url for your system.
  +
<pre>
  +
<smtp-host>smtp.gmail.com</smtp-host>
  +
<smtp-auth>mail.smtps.auth</smtp-auth>
  +
<email-sender>mailuser@company.com</email-sender>
  +
<sender-password>mailuserpwd</sender-password>
  +
<dashboard-url>http://dashboard.company.com:9000/</dashboard-url>
  +
</pre>
  +
  +
 
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.
 
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.
  +
There is a ''Notifications'' Jenkins job that is sent up to run once a week.
 
 
The default settings are:
 
The default settings are:
 
* Notification Email. This 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.
 
* Notification Email. This 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.

Revision as of 17:17, 5 September 2017

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)

<L10nStreamlining>
├── config
│   ├── config_attask.properties
│   ├── config_custom_tasks.xml
│   ├── config_email_global.xml
│   ├── config_file_cherry_picker.xml
│   ├── config_gl_file_format.properties
│   ├── config_gl_locale_mapping.properties
│   ├── config_lingotek_api.properties
│   ├── config_lingotek_file_format.properties
│   
├── <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.

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

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.

There are 3 types of information contained in the config_email_global.xml file.

  • email configuration
  • interval between the sending of status emails
  • flag indicating whether to send out the 'No Files to Prep' email

Email Configurations

The specification need in particular to be set for the smtp-host, the smtp-auth, the email-sender, the sender-password, and the jenkins-url for your system.

         <smtp-host>smtp.gmail.com</smtp-host>
         <smtp-auth>mail.smtps.auth</smtp-auth>
         <email-sender>mailuser@company.com</email-sender>
         <sender-password>mailuserpwd</sender-password>
         <dashboard-url>http://dashboard.company.com:9000/</dashboard-url>


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. This 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.
    • Interval for sending out this email is every day.
  • Late Prep Kit Email. This email denotes the prep kits that are deemed 'late':
    • Interval for sending out late prep kit emails is every day.
    • 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.

Basic Configuration

To send notifications to email recipients, the config_email_global.xml needs to be configured under <HOME>/Lingoport_Data/L10nStreamlining/config The specification need in particular to be set for the smtp-host, the smtp-auth, the email-sender, the sender-password, and the jenkins-url for your system.

         <smtp-host>smtp.gmail.com</smtp-host>
         <smtp-auth>mail.smtps.auth</smtp-auth>
         <email-sender>mailuser@company.com</email-sender>
         <sender-password>mailuserpwd</sender-password>
         <dashboard-url>http://dashboard.company.com:9000/</dashboard-url>

Encrypted Password

The <sender-password> can be configured with the encrypted attribute set to true, as in

         ...
         <email-sender>mailuser@company.com</email-sender>
         <sender-password encrypted="true">UUIasd455</sender-password>
         ...

To encrypt the password, use the encrypt command line on lrm-common.jar file. For instance:

> java -jar <LRM_INSTALLATION_PATH>/lib/lpcommon.jar --encrypt

which will prompt you for the text (here the password) to encrypt and will provide the result on the console.

Nothing to Prep Email

To notify that when executing the command to send translation, no translations were found, the send-no-files-to-prep-email defaults to be set to 1. This may become annoying if you are prepping every night for instance and no changes happen. The notification system would then send a "Nothing to Prep" email. If you would rather no mails were sent in this case, set send-no-files-to-prep-email to 0.

<send-no-files-to-prep-email>0</send-no-files-to-prep-email>

This file resides only at the global level.

config_file_cherry_picker.xml

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.

config_lingotek_api.properties

The config_lingotek_api.properties 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 (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

The config_lingotek_file_format.properties 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 (config_l10n_vendor.properties).

This file resides only at the global level.