Pseudo Localization

config_pseudo_loc.xml.xml

File config_pseudo_loc.xml is the configuration file for setting up pseudo localization instructions for LRM resource files. It is located in the global <HOME>/Lingoport_Data/L10nStreamlining/config folder. If you need different criteria for a group or project then the file can be copied and moved to <HOME>/Lingoport_Data/L10nStreamlining/<group>/config or <HOME>/Lingoport_Data/L10nStreamlining/<group>/projects/<project>config respectively.

The config_pseudo_loc.xml file is used when running the --pseudo-loc command. A pseudo-localized file will be created for each base resource file if the project has a designated pseudo-locale.

There are 2 categories of information contained in the config_pseudo_loc.xml file.

• pseudo localization instructions
• regex pattern for each parser type defining the parameters as well as special characters that should not be pseudo-localized.

Pseudo Localization Instructions

The configuration consists of the following xml elements:

• expansion lengths - defines the expansion percentage based on a strings length. This is useful to test language expansions.
• expansion character - the character that will be used to pad the string in order to simulate string expansion
• expansion end character - characters at the end of expansion. Typically, these are symbols across a range of codepoints in order to ensure that content from the various code pages are supported
• start and end characters - characters at the start and end of the resource string. This is useful to catch resource strings that are concatenated within the code.
• accents - a flag indicating whether the resource string should be accented. This is needed to ensure that all visible user strings are localized.

The first step in configuring the global email file is to verify, with your IT department, the mail server credentials. Send email command may be used to test the configuration values.

Example No Authorization Email Configuration

Test your email configuration using the -se command for no authorization.

   <smtp-host>smtp.gmail.com/<smtp-host>
   <smtp-auth>none</smtp-auth>
   <email-sender>joe@mycompany.com</email-sender>  
   <sender-password encrypted="false">mypassword</sender-password>

Example SMTP Authorization Email Configuration

Test your email configuration using the -se command for SMTP authorization.

   <smtp-host>smtp.gmail.com/<smtp-host>
   <smtp-auth>mail.smtp.auth</smtp-auth>
   <email-sender>joe@mycompany.com</email-sender>  
   <sender-password encrypted="false"></sender-password>

Example SMTPS Authorization Email Configuration

Test your email configuration using the -se command for SMTPS authorization.

   <smtp-host>smtp.gmail.com/<smtp-host>
   <smtp-auth>mail.smtps.auth</smtp-auth>
   <email-sender>joe@mycompany.com</email-sender>  
   <sender-password encrypted="false">mypassword</sender-password>

Additional Email Configuration

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.

• dashboard-url - Dashboard URL used as the link destination for the email Log In button
• notify-changes-email-interval - By default, the Notification email may be sent every day. Since the project's Jenkins Notification job is only run once a week, this email will only be set out once a week.
• late-kits-email-interval - By default, the Late Prep Kits email may be sent every day depending on the number of days late. Since the project's Jenkins Notification job is only run once a week, this email will be sent out once a week.
• number-days-late - By default, a prep kit is deemed late if it is 7 days late.
• send-no-files-to-prep-email - By default, the 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 to 0 so that the email is not sent. Otherwise, the email recipient's inbox may be inundated with 'No Files to Prep' emails.

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.

Java Options for sending emails

It may be necessary to explicitly set the email port and/or STARTTLS flag rather than rely on the default mail server values. In addition, the email session debug mode can be enabled.

There are 3 email settings that may be set through java options:

• Email Server Port
• SMTP STARTTLS enabled
• Email Session Debug mode enabled

Email Protocol Port Number

The expected java option for explicitly setting the protocol port number is:

• mail.smtp.port

Linux example if setting java options within a shell session.

export _JAVA_OPTIONS='-Dmail.smtp.port=25'

Enable/Disable STARTTLS

The expected java option for explicitly enabling/disabling STARTTLS is:

• mail.smtp.starttls.enable

Linux example if setting java options within a shell session.

export _JAVA_OPTIONS='-Dmail.smtp.starttls.enable=true'

STARTTLS is automatically enabled for the SMTPS protocol.

Enable Email Session Debug mode

The expected java option for explicitly enabling/disabling the email session debug mode is:

• mail.debug.mode

Linux example if setting java options within a shell session.

export _JAVA_OPTIONS='-Dmail.debug.mode=true'

Send Email Command

The send email command is used to test sending an email using your mail server credentials. Before starting, verify with your IT department the mail server credentials otherwise errors will occur.

The send email command is accessed through the lpcommon.jar file and is located in the lib folder (i.e. ../lrm-server-x.x/lib). This command is used to test the configured mail server. Before running this command, you may want to enable the email session debug mode.

In order to run the send email -sse or --send-smtp-email command, you must specify an existing location for the error log.

In addition to the log file, there are 5 other required fields.

• SMTP Host denoted by option -sh or --smtp-host
• Senders email address denoted by option -es or --email-sender
• Email Subject denoted by option -subj or --subject
• Email Message denoted by option -msg or --message
• Email Recipients denoted by option -r or --recipients

Sending Email with SMTP protocol and no authorization

To test sending an email using the SMTP protocol with no authorization run the following command:

java -jar lpcommon.jar -sse -lf /var/lib/jenkins/test/error.log -sh smtp.gmail.com -es myemail@mycompany.com -subj test -msg "This is a test" -r anotheremail@email.com

In looking at the console log you should see the following:

• Email protocol is `smtp` (which is the default)
• Authorization `mail.smtp.auth` is set to `false`

If errors occurs then you'll need to change your email send options. For error examples see Email Error Messages.

Sending Email with SMTP authorization

To test sending an email using the SMTP protocol with SMTP authorization run the following command:

java -jar lpcommon.jar -sse -lf /var/lib/jenkins/test/error.log -sh smtp.gmail.com -sa mail.smtp.auth -es myemail@mycompany.com -subj test -msg "This is a test" -r anotheremail@email.com

In looking at the console log you should see the following:

• Email protocol is `smtp`
• Authorization `mail.smtp.auth` is set to `true`

If errors occurs then you'll need to change your email send options. For error examples see Email Error Messages.

Sending Email with SMTPS protocol

To test sending an email using the SMTP protocol with SMTP authorization run the following command:

java -jar lpcommon.jar -sse -lf /var/lib/jenkins/test/error.log -sh smtp.gmail.com -sa mail.smtps.auth -es myemail@mycompany.com -subj test -msg "This is a test" -r anotheremail@email.com -ep mypassword

In looking at the console log you should see the following:

• Email protocol is `smtp` (which is the default)
• Authorization `mail.smtp.auth` is set to `false`

If errors occurs then you'll need to change your email send options. For error examples see Email Error Messages.

Error Messages

The first step in trouble shooting any email messages is to verify, with your IT department, the mail server credentials.

If you're unable to send an email successfully then you may want to enable the debug mode for the email session. This will provide additional information regarding the progress of the session. Set the debug mode through java options. After enabling the debug mode, the error messages should provide explicit information regarding the reason for the failure. There are a few error messages that may not be so obvious. These are:

• Connection is not successful due to invalid port number:

The default port number will be used when setting up the connection. If you're unable to change the default port number then you'll need to explicitly set it via java options.

• Must issue a STARTTLS command first. This error indicates that STARTTLS must be enabled. This error occurs when the protocol is SMTP. You can attempt to fix this error by:

Setting the authorization to SMTPS (connection may require a password)

or

Explicitly setting STARTTLS through the java option mail.smtp.starttls.enable and adding the password to the command line (-ep)