Difference between revisions of "LRM Instrumentation"

From Lingoport Wiki
Jump to: navigation, search
(LRM Instrumentation)
(LRM Instrumentation)
Line 73: Line 73:
  
 
= LRM Instrumentation =
 
= LRM Instrumentation =
If there is a valid InContext license for the group, then files can be ''instrumented''.
+
If there is a valid InContext license for the group, then files can be ''instrumented''. LRM instrumentation is the process of inserting non-printable characters into each resource string. These non-printable characters are used to access information about the key/value/file using either [[About_InContext_QA|InContext QA]] or [[About_InContext_Translation|InContext Translation]].
 +
The instrumented files all have a suffix of ''LRM_LQA''. For example, the instrumented file that corresponds to the resource file ''file1-fr-fr.properties'' will have the name ''file1-fr-fr_LRMLQA.properties''. The instrumented files are located in the same location as their corresponding resource file.
 +
 
 +
Instrumented files are automatically created during the prep kit process if the project's L10n Vendor configuration file has a valid [[L10n_Vendors#InContext_Server_Configuration.| InContext Server defined.]]
 +
If using [[About_InContext_QA|InContext QA]] then instrumentation can occur during the Jenkins Automation job by adding the [[Quick_On-Boarding_Reference#IQA_Instrument_Build_Step_.28Optional.29|IQA Instrument Build Step]].

Revision as of 13:45, 23 April 2019

Introduction

To begin working with InContext Translation and InContext QA, the LRM version and license must be correct.

LRM version

The easiest way to check your LRM implementation is to run the Jenkins <group>.LicenseExpiration job and check the console output.

You should see something that looks like:

================================================================= 
 GENERAL INFORMATION
 
--- System
Linux ip-172-31-54-161.ec2.internal 3.10.0-957.1.3.el7.x86_64 #1 SMP Thu Nov 29 14:49:43 UTC 2018 x86_64 x86_64 x86_64 GNU/Linux
openjdk version "1.8.0_201"
OpenJDK Runtime Environment (build 1.8.0_201-b09)
OpenJDK 64-Bit Server VM (build 25.201-b09, mixed mode)
mysql  Ver 14.14 Distrib 5.7.24, for Linux (x86_64) using  EditLine wrapper
 
--- LRM 
LRM Version 4.2.28

LRM Process Main Version 4.2.04

Lingoport-FTP Connection Version 4.2.00

Lingoport-GlobalLink Connection Version 4.2.03

Lingoport-Lingotek Connection Version 4.2.00

Lingoport-Local Connection Version 4.2.01

Lingoport-Worldserver Connection Version 4.2.01

Lingoport Common Version 4.2.07
 
LRM Common Version 4.2.00


================================================================= 
 CHECK_LICENSE for GROUP Acme
Proj Path
  Email Renewal Threshold:         30 days
  License Expiration Date:         2020-01-15
  Number of days left on license:  291 days
  InContext Expiration Date:       2020-01-15
  Number of InContext QA days:     291 days

  Number of projects licensed:     1000
  Number of projects remaining:    996
  Number of projects on-boarded:   4
-------------------------------------------------------
Detail of projects in the LRM database: 

  Maximum number of projects allowed is `1,000`.
  Project1
  Project2
  Project3
  Project4
Process completed successfully.

 END CHECK_LICENSE
 ========================================================== 

In order to do instrumentation, the InContext Expiration Date must be populated and the date in the future. If not, please contact Lingoport support: support@lingoport.com.

LRM InContext License

  • If the LRM Common Version is not 4.2 or higher, LRM on the system needs to be updated and new license installed.
  • If the LRM InContext Expiration Date and Number of InContext QA days are blank or non-existent, then the Jenkins ManageLicenses job needs to be run with a license that includes InContext QA. Running the Jenkins <group>.LicenseExpiration job afterward will verify that the license exists.

Contact support@lingoport.com for assistance or with questions or concerns.

LRM Instrumentation

If there is a valid InContext license for the group, then files can be instrumented. LRM instrumentation is the process of inserting non-printable characters into each resource string. These non-printable characters are used to access information about the key/value/file using either InContext QA or InContext Translation. The instrumented files all have a suffix of LRM_LQA. For example, the instrumented file that corresponds to the resource file file1-fr-fr.properties will have the name file1-fr-fr_LRMLQA.properties. The instrumented files are located in the same location as their corresponding resource file.

Instrumented files are automatically created during the prep kit process if the project's L10n Vendor configuration file has a valid InContext Server defined. If using InContext QA then instrumentation can occur during the Jenkins Automation job by adding the IQA Instrument Build Step.