Difference between revisions of "LRM commands FAQ"

From Lingoport Wiki
Jump to: navigation, search
(Created page with "== LRM Command Line Client == The Command Line Client allows you to interact with the resource files and to generate reports. The user can add users, create new kit definiti...")
(No difference)

Revision as of 18:57, 6 September 2012

LRM Command Line Client

The Command Line Client allows you to interact with the resource files and to generate reports. The user can add users, create new kit definitions, validate source files, prepare kits to be sent to the translation vendors, validate translated files received from a translation vendor, and locate the validated received files into the source code.


To run LRM Command Line commands, enter:

java -jar <path-to-jarfile>/lrm-cli.jar command [<command option> [<option value>]]

For instance, if your client installation is located under C:\Lingoport\ResourceManagerClient-1.0, you could invoke commands this way:

 java -jar C:\Lingoport\ResourceManagerClient-1.0\lrm-cli.jar -help

You could also set an environment variable, either in Unix or in Windows, to shorten the typing. For instance:

 set LRM_CMD=java -jar c:\Lingoport\ResourceManagerClient-1.0\lrm-cli.jar
 %LRM_CMD% -help

The following example are based on setting the LRM_CMD environment variable in Windows. In Unix, it would be similar and the environment variable would look like $LRM_CMD

Help

To see what commands are available at the command line, type:

 %LRM_CMD% -help

LRM Configuration Commands

lrmUserConfig.xml

This file holds some basic settings used by this client resource manager installation. The following elements are:

  • user-name: the Resource Manager user name. Actions are associated with one user, as many users can interact with the system. (See Adding a User below)
  • user-password: the password for that user. (See Adding a User below)
  • error-log: the location of the log file.
  • base-src-dir: the location of top level directory under which all your sources are kept. It could be "/" or "C:" or something more precise, such as "/projects/src/" for instance.
  • base-report-path: the directory where all reports are generated.
  • prep-kit-path: the location where kits are created. These are the kits which will be sent to translation
    • Adding a User

      Adding a user in the server database is one step. The other step is to update the lrmUserConfig.xml file so running LRM uses that file to connect with user known to the server database. To add a user to the database, type:

       %LRM_CMD% -eadduser username, password
      

      Any other command using the -p and -u parameters will update the lrmUserConfig.xml and keep that information so you don't have to retype username and password for subsequent commands. The easiest way to do this is to run the -ekitnames command:

       %LRM_CMD% -ekitnames -u{username} -p{password}
      


      Kit Root Configuration

      Your software project may be divvied up into modules and sub-components. You may want to have files sent in for translation in one kit for the entire application, or organized into many kits, for instance one per module. In order to prepare a kit, you must first configure how the kits will be created. This is the step where we create a kit root. In the Samples directory, you will find examples of some configurations. Copy one such file from the Samples directory into the KitDefinitions directory and adjust the parameters in that file:

      • kit-project-name: this name will be used when creating a kit or reporting on issues or displaying results in the Dashboard.
      • kit-desc: this is a description of the kit configuration
      • top-level-dir: the lrmUserConfig.xml has an element related to this one, the base-src-dir, which indicates where on your system all the source files are located. base-src-dir+top-level-dir tells the ResourceManager where to look for resource files. If you keep all your source files under base-src-dir=C:\myWorkSpace and your top-level-dir is Acme\src, then files under C:\myWorkSpace\Acme\src will be examined by the Resource Manager.