Difference between revisions of "LRM Process Commands Reference"

From Lingoport Wiki
Jump to: navigation, search
(Created page with "== Introduction == Each command has an abbreviation. The long version of each command starts with two dashes, <code>--</code>. The short version of each command starts with o...")
 
(--prep-kit (Send out prep kits))
 
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
  +
LRM Process interacts with the LRM engine (lrm-cli.jar) and L10n Vendors. It is also responsible for sending out notification emails. The LRM Process commands are called in the Lingoport Jenkins Jobs.
   
 
Each command has an abbreviation. The long version of each command starts with two dashes, <code>--</code>. The short version of each command starts with one dash, <code>-</code>.
 
Each command has an abbreviation. The long version of each command starts with two dashes, <code>--</code>. The short version of each command starts with one dash, <code>-</code>.
 
The <b>help</b> provides a list of all available commands.
 
<pre>
 
-h,--help Displays Help.
 
 
</pre>
 
   
 
== Reference ==
 
== Reference ==
Line 24: Line 19:
 
 
 
-ik,--import-kit Import the translated kit.
 
-ik,--import-kit Import the translated kit.
Example: `lrmprocess-cli.jar -ik`
+
Example: `lrmprocess-cli.jar -ik`
  +
with option for specifying the location
  +
of the translated files
 
-ju,--jenkins-user <jenkinsuser> Specifies the Jenkin's User that
 
-ju,--jenkins-user <jenkinsuser> Specifies the Jenkin's User that
 
started the job. Default is
 
started the job. Default is
Line 72: Line 69:
   
   
  +
===--check-send (Upload pending prep kits)===
===Kit Preparation===
 
  +
The --check-send command is used to upload any prep kits that may not have been uploaded. This can occur if the connection to the L10n Vendor cannot be established. Once it is fixed, the --check-send command is called to upload the prep kits.
  +
  +
Notification emails are sent to the appropriate recipients (see [[Project_Configuration_Files#config_email_recipients.xml|Email Recipients]])
  +
  +
This command is called during the Jenkins Check Send job (see [[LRM_Jenkins_Jobs#Infrastructure|Jenkin's CheckSend Job]])
  +
  +
java -jar lrmprocess-cli.jar --check-send
  +
  +
=== --import-kit (Import Kits returned by L10n Vendor)===
  +
The import kit command searches for any kits that have been returned by the L10nVendor and imports them into LRM (see [[Importing_Translated_Kits|Importing TranslatedKits]]).
  +
  +
Notification emails are sent to the appropriate recipients (see [[Project_Configuration_Files#config_email_recipients.xml|Email Recipients]])
  +
  +
This command is called for each vendor's Jenkins Import Kit job (see [[LRM_Jenkins_Jobs#Infrastructure_Tab_Jobs|Jenkin's Import Kit jobs]])
  +
  +
If there is no option for the location of the translated files (--file option), then each L10n Vendor staging area is searched for pending translated kits.
   
  +
java -jar lrmprocess-cli.jar --import-kit
With the '''--dry-run''' option running successfully, you're ready to prepare a Kit for translation. You do this by running the '''--prep-kit''' command with only the LRM project name.
 
   
lrm --prep-kit --project-name <project name>
+
===--prep-kit (Send out prep kits)===
  +
LRM Process calls the LRM engine's prep kit job, uploads the files to the appropriate L10n vendor and sends out notifications emails.
   
  +
Notification emails are sent to the appropriate recipients (see [[Project_Configuration_Files#config_email_recipients.xml|Email Recipients]])
By default, the Kit is created under your 'prep_kit' folder,. Each time you prepare a Kit for your LRM project, LRM will create a folder named PREP_KIT_<version>,(<code><HOME>/Lingoport_Data/LRM/<group-name>/prep_kit/MyProject</code>), with all the latest settings associated with your LRM Project where <version> is the kit version number. For example, if you ran --prep-kit on your LRM Project named MyProject, the first Kit would be created in the folder (<code><HOME>/Lingoport_Data/LRM/<group-name>/prep_kit/MyProject/PREP_KIT_1</code>.
 
   
  +
This command is called during the Jenkins Prep Kit jobs (see [[LRM_Jenkins_Jobs#PrepKit|Jenkin's Prep Kit Jobs]]).
The PREP_KIT_<version> contains:
 
   
  +
java -jar lrmprocess-cli.jar -pk -pn <project> -gn <group>
* A folder for each locale with a copy of each base resource file that has changed since the last time the kit was prepped. If the '''prep.kit.changes.only''' option is set in the '''config_lrm_info.properties''' file then the resource files will contain only the key/value pairs that have changed since the last time the kit was prepped;
 
* A '''BaseFileSearch<target locale>.xml''' file for each locale describing the base files for the kit;
 
* If LRM detected only warnings in your base resource files, then there will also be a '''BaseFileSearchWarnings<default locale>.xml''' file describing the warnings.
 
* However, if there are errors in the base resource files (rather than just warnings), the PREP_KIT_<version> folder will contain a '''BaseFileSearchErrors<default locale>.xml''' file and the kit will ''not be created''. You must correct all errors prior to preparing a kit.
 
   
The PREP_KIT_<version> folder is what you send out for translation. The localization vendor will translate the resource files in each of the target locale folders.
 
   
  +
During the prep kit command, the files are prepped and moved to the prep kit staging area in order to be uploaded to the appropriate L10n vendor. The notification emails are then sent out.
Important Note: It is required that the resource files in the target locale folders are translated and returned, maintaining all the other text in the resource files. This is because LRM places a comment tag at the top of each resource file that indicates the LRM Project, Kit version and target locale, which LRM needs during the Kit Import process. An example LRM tag is: MyProjectName_1_5
 
   
 
==== Override Prep Kit ====
 
==== Override Prep Kit ====
Line 96: Line 106:
 
Examples:
 
Examples:
 
* Create a prep kit for all base resource files
 
* Create a prep kit for all base resource files
java -jar lrm-cli.jar -pk --override -pn <project> -gn <group>
+
java -jar lrmprocess-cli.jar -pk --override -pn <project> -gn <group>
 
* Create a prep kit for specific locales
 
* Create a prep kit for specific locales
java -jar lrm-cli.jar -pk --override -pn <project> -gn <group> --locale fr,de,es_mx
+
java -jar lrmprocess-cli.jar -pk --override -pn <project> -gn <group> --locale fr,de,es_mx
 
* Create a prep kit for specific resource files
 
* Create a prep kit for specific resource files
java -jar lrm-cli.jar -pk -or -pn <project> -gn <group> --resource-file /var/lib/jenkins/myproject/resources/file1.properties,/var/lib/jenkins/myproject/resources/file2.properties
+
java -jar lrmprocess-cli.jar -pk -or -pn <project> -gn <group> --resource-file /var/lib/jenkins/myproject/resources/file1.properties,/var/lib/jenkins/myproject/resources/file2.properties
 
* Create a prep kit for a specific locale file
 
* Create a prep kit for a specific locale file
java -jar lrm-cli.jar -pk -or -pn <project> -gn <group> -lc fr -rf /var/lib/jenkins/myproject/resources/file3.properties
+
java -jar lrmprocess-cli.jar -pk -or -pn <project> -gn <group> -lc fr -rf /var/lib/jenkins/myproject/resources/file3.properties

Latest revision as of 21:42, 10 December 2018

Introduction

LRM Process interacts with the LRM engine (lrm-cli.jar) and L10n Vendors. It is also responsible for sending out notification emails. The LRM Process commands are called in the Lingoport Jenkins Jobs.

Each command has an abbreviation. The long version of each command starts with two dashes, --. The short version of each command starts with one dash, -.

Reference

This reference gives the short and the long version of each Resource Manager command and a usage example.


  -cs,--check-send                         Command to send any pending prep
                                           kits to the active L10n vendor.
  -d,--debug                               Log4j Debug mode
 
  -f <path>                                Location of file (-f C:/MyLocation)
                                           or file name with path (-f C:/myfolder/myfile.xml)
  -gn,--group-name <group>                 Specifies the group name.
                                     
  -h,--help                                Displays Help.
                                    
  -ik,--import-kit                         Import the translated kit.
                                           Example: `lrmprocess-cli.jar -ik` 
                                           with option for specifying the location
                                           of the translated files
  -ju,--jenkins-user <jenkinsuser>         Specifies the Jenkin's User that
                                           started the job. Default is
                                           `Jenkins`.
  -kv,--kit-version <version#>             Specifies the kit version id when
                                           importing a kit or when
                                           activating/deactivating a kit.
  -lc,--locale <locale(s)>                 List of locales for the prep kit
                                           --override option.                                  
  -lk,--late-kits                          Email type option to indicate
                                           that an email should be sent
                                           listing all late prep kits.
  -nc,--notify-changes                     Email type option to notify
                                           project managers of resource
                                           file changes.
  -or,--override                           Create a prep kit regardless of
                                           whether there are changes to the
                                           base files.
  -pk,--prep-kit                           Prep a kit. Example:
                                          `lrmprocess-cli.jar -pk -pn
                                           <projectname> -gn <groupname>`
  -plr,--process-lqa-requests              Process all pending LQA
                                           requests. Example:
                                           `lrmprocess-cli.jar -plr`
  -pn,--project-name <project>             Specifies the LRM project name.

  -rf,--resource-file <resource-file(s)>   List of resource files for the
                                           prep kit --override option.
  -se,--send-email                         Command to send an email. The
                                           type of email is indicated by
                                           additional options. Example:
                                           `lrmprocess-cli.jar -se <email
                                           type> -pn <projectname> -gn
                                           <groupname>`
  -slr,--save-lqa-requests                 Save all outstanding LQA
                                           requests. Example:
                                           `lrmprocess-cli.jar -slr`
  -vcg,--version-control-get               Email type option to notify of
                                           version control issues when
                                           retrieving source.
  -vci,--version-control-import            Email type option to notify of
                                           version control issues when
                                           committing changes.
  -vn,--version                            LRM Process Main Version
                                    


--check-send (Upload pending prep kits)

The --check-send command is used to upload any prep kits that may not have been uploaded. This can occur if the connection to the L10n Vendor cannot be established. Once it is fixed, the --check-send command is called to upload the prep kits.

Notification emails are sent to the appropriate recipients (see Email Recipients)

This command is called during the Jenkins Check Send job (see Jenkin's CheckSend Job)

 java -jar lrmprocess-cli.jar --check-send

--import-kit (Import Kits returned by L10n Vendor)

The import kit command searches for any kits that have been returned by the L10nVendor and imports them into LRM (see Importing TranslatedKits).

Notification emails are sent to the appropriate recipients (see Email Recipients)

This command is called for each vendor's Jenkins Import Kit job (see Jenkin's Import Kit jobs)

If there is no option for the location of the translated files (--file option), then each L10n Vendor staging area is searched for pending translated kits.

  java -jar lrmprocess-cli.jar --import-kit

--prep-kit (Send out prep kits)

LRM Process calls the LRM engine's prep kit job, uploads the files to the appropriate L10n vendor and sends out notifications emails.

Notification emails are sent to the appropriate recipients (see Email Recipients)

This command is called during the Jenkins Prep Kit jobs (see Jenkin's Prep Kit Jobs).

 java -jar lrmprocess-cli.jar -pk -pn <project> -gn <group>


During the prep kit command, the files are prepped and moved to the prep kit staging area in order to be uploaded to the appropriate L10n vendor. The notification emails are then sent out.

Override Prep Kit

The override option of the prep kit command will prep a kit regardless of whether there are changes to the base resource files. The prep kit can be filtered by base resource files (--resource-file options) as well as locales (--locale option). If there are no additional options then all base resource file will be sent out for translation.

Examples:

  • Create a prep kit for all base resource files
   java -jar lrmprocess-cli.jar -pk --override -pn <project> -gn <group>
  • Create a prep kit for specific locales
   java -jar lrmprocess-cli.jar -pk --override -pn <project> -gn <group> --locale fr,de,es_mx
  • Create a prep kit for specific resource files
   java -jar lrmprocess-cli.jar -pk -or -pn <project> -gn <group> --resource-file /var/lib/jenkins/myproject/resources/file1.properties,/var/lib/jenkins/myproject/resources/file2.properties
  • Create a prep kit for a specific locale file
   java -jar lrmprocess-cli.jar -pk -or -pn <project> -gn <group> -lc fr -rf /var/lib/jenkins/myproject/resources/file3.properties