On Boarding Overview

Introduction

On-boarding an LRM project involves:

• getting the necessary information about the project, its target locales, etc.
• creating an LRM project using the command line
• setting up Jenkins jobs
• verifying those jobs

A project can only be on-boarded within a group. That group must have been licensed. The Jenkins user must have read and write access to the code repository.

Groups

A group is similar to a folder. LRM projects are associated with one group. The installer requires at least one group and its license. The license for a group is obtained from support@lingoport.com based on the commercial agreement between the client and Lingoport.

A company may have many groups. Each project within a group must have a unique name.

To add groups after installing the system, use the --create-group command on lrm-cli.jar. For instance:

 java -jar $LRM_HOME/lrm-cli.jar --create-group --group-name group1 -led "2016-06-01" -nop 10 -lk <license-key>

To update the license of an existing group, used the --update-license command on lrm-cli.jar. For instance:

 java -jar $LRM_HOME/lrm-cli.jar --update-group --group-name group1 -led "2016-06-01" -nop 10 -lk <license-key>

Once a group has been created, the database and the file structure are updated.

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)

Projects

Projects can be on-boarded one per repository, after a group has been licensed. Many groups can be licensed: It is important to determine under which group a project must reside.

• The 1 - Automation tab contains on-boarded jobs which generate the status of the project and pushes it to the dashboard, and pseudo-localizes resource files if necessary. These jobs tend to run whenever files are pushed to the repository for the project. See $LRM_HOME/bin/job_automate.sh
• The 2 - Nightlies tab contains on-boarded jobs which run every day or every night and provide an update to the dashboard and an email to a set of recipients based on the configured frequency. See $LRM_HOME/bin/job_nightly.sh
  • It also contains the license check for a group (not a project). The name of the Jenkins job is <group_name>.License_Expiration.See $LRM_HOME/bin/job_checklicense.sh 30 (if 30 days threshold)
• The 3- PrepKit tab contains on-boarded jobs which are triggered by a human intervention to send the kits for translation based on the configured translation endpoint. See $LRM_HOME/bin/job_prepkit.sh

Each tab has a job setup during configuration. On-boarding a new job consists in copying an exiting job and configuring a set of xml files.

See On-Boarding New Projects