Difference between revisions of "LRM Process Commands Reference"

From Lingoport Wiki
Jump to: navigation, search
(Introduction)
(Send out prep kits)
Line 68: Line 68:
  
 
===Send out prep kits===
 
===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.  
+
LRM Process calls the LRM engine's prep kit job, uploads the files to the appropriate L10n vendor and sends out notifications emails. This command is called during the Jenkins Prep Kit jobs.
  
   java -jar lrmprocess-cli.jar  
+
   java -jar lrmprocess-cli.jar -pk -pn <project> -gn <group>
  
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>
+
During the prep kit command, the files are prepped and moved to staging area in order to uploaded to the appropriate L10n vendor. The notification emails are then sent out.
 
 
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>.
 
 
 
The PREP_KIT_<version> contains:
 
 
 
* 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.
 
 
 
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 94: Line 80:
 
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

Revision as of 12:46, 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`
  -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
                                    


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. This command is called during the Jenkins 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 staging area in order to 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