LRM commands FAQ - Revision history

Olibouban: /* Adding a User */

2012-09-10T15:20:44Z

Adding a User

← Older revision		Revision as of 15:20, 10 September 2012
Line 49:		Line 49:
	=== Adding a User ===		=== Adding a User ===
	Adding a user in the server database is one step. The other step is to update the <b>lrmUserConfig.xml</b> file so running LRM uses that file to connect with user known to the server database. To add a user to the database, type:		Adding a user in the server database is one step. The other step is to update the <b>lrmUserConfig.xml</b> file so running LRM uses that file to connect with user known to the server database. To add a user to the database, type:
	<code>%LRM_CMD% -eadduser ~~username~~, ~~password~~</code>		<code>%LRM_CMD% -eadduser Username, Password</code>

	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:		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:
	<code>%LRM_CMD% -ekitnames -~~u{username}~~ -~~p{password}~~</code>		<code>%LRM_CMD% -ekitnames -uUsername -pPassword</code>

	== Kit Root Configuration ==		== Kit Root Configuration ==

Olibouban: /* Resource Manager Client Configuration */

2012-09-10T15:19:17Z

Resource Manager Client Configuration

← Older revision		Revision as of 15:19, 10 September 2012
Line 34:		Line 34:
	Two files are used to configure the Resource Manager client:		Two files are used to configure the Resource Manager client:
	<UL>		<UL>
	<LI>application.properties: it is set up during installation and should not be need to be modified. It indicates how to connect to the Resource Manager database and in what locale the log file should be written.</LI>		<LI><B>application.properties</B>: it is set up during installation and should not be need to be modified. It indicates how to connect to the Resource Manager database and in what locale the log file should be written.</LI>
	<LI>lrmUserConfig.xml: this file is specific to a usage model of the Resource Manager client and should be modified to conform to the system on which the Resource Manager client is installed. It contains the Resource Manager user name and password, which directory contains the source code, where to generate the reports, etc.</LI>		<LI><B>lrmUserConfig.xml</B>: this file is specific to a usage model of the Resource Manager client and should be modified to conform to the system on which the Resource Manager client is installed. It contains the Resource Manager user name and password, which directory contains the source code, where to generate the reports, etc.</LI>
	</UL>		</UL>

Line 53:		Line 53:
	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:		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:
	<code>%LRM_CMD% -ekitnames -u{username} -p{password}</code>		<code>%LRM_CMD% -ekitnames -u{username} -p{password}</code>


	== Kit Root Configuration ==		== Kit Root Configuration ==

Olibouban at 22:06, 6 September 2012

2012-09-06T22:06:20Z

@@ Line 21: / Line 21: @@
 To see what commands are available at the command line, type:
    <code>%LRM_CMD% -help</code>
 == Resource Manager Client Configuration ==
@@ Line 130: / Line 139: @@
 When there are no more errors detected by the Resource Manager, this command will distribute the files in their corresponding locations on the original source code. For instance, if the resources.properties file comes from the directory module1, the resources_fr_FR.properties will be copied to module1, based on the kit root configuration.

Olibouban at 21:55, 6 September 2012

2012-09-06T21:55:34Z

@@ Line 85: / Line 85: @@
 Once a kit root is configured, kits can be handled by the Resource Manager commands. Most of the daily work with resource files can start now.
-== Resource Manager Commands to send Kits for Translation ==
+== Commands to send Kits for Translation ==
 The major steps in this section deal with enumerating and checking files to be sent for translation and creating a kit based on valid files.
@@ Line 110: / Line 110: @@
 <b>Important Note:</b> if there are still errors in the files to be sent for translation, the PREP_KIT_<x> file will contain a <b>BaseFileSearchErrors_<default-locale>.xml</b> and the kit will not be created.

Olibouban: /* Prepare a Kit */

2012-09-06T21:12:54Z

Prepare a Kit

← Older revision		Revision as of 21:12, 6 September 2012
Line 104:		Line 104:
	<code>%LRM_CMD% -eprep <kit-project-name></code>		<code>%LRM_CMD% -eprep <kit-project-name></code>

	The result of that command is put in <b>prep_kit\<kit-project-name>\PREP_KIT_<x></b> under the Resource Manager client install directory. It contains:		The result of that command is put in <b>prep_kit\<kit-project-name>\PREP_KIT_<x></b> under the Resource Manager client install directory. The first kit created will be under PREP_KIT_1, the second under PREP_KIT_2, etc. The PREP_KIT_<x> directory contains:
	<ul> <li>an XML file for each locale describing the base files for that kit</li>		<ul> <li>an XML file for each locale describing the base files for that kit</li>
	<li>a directory for each locale with the files copied from source.</li>		<li>a directory for each locale with the files copied from source.</li>

Olibouban: /* Kit Root Configuration */

2012-09-06T21:01:24Z

Kit Root Configuration

← Older revision		Revision as of 21:01, 6 September 2012
Line 73:		Line 73:
	To get a starting <kitdefinition>.xml file for an existing project in the server database, type:		To get a starting <kitdefinition>.xml file for an existing project in the server database, type:
	<code>%LRM_CMD% -edownload <kit-project-name></code>		<code>%LRM_CMD% -edownload <kit-project-name></code>
	This may come in handy when you want to modify an existing configuration. The resulting xml file is named <b>~~SetupConfigRoot~~.xml</b> and is located under <b>reports\<kit-project-name></b>		This may come in handy when you want to modify an existing configuration. The resulting xml file is named <b>SetupKitRootConfig.xml</b> and is located under <b>reports\<kit-project-name></b>

	To update a configuration, download and modify the corresponding xml file and type:		To update a configuration, download and modify the corresponding xml file and type:

Olibouban: /* Kit Root Configuration */

2012-09-06T21:00:23Z

Kit Root Configuration

← Older revision		Revision as of 21:00, 6 September 2012
Line 71:		Line 71:
	It will create one file per locale under the <code>reports\kit-project-name</code> directory.		It will create one file per locale under the <code>reports\kit-project-name</code> directory.

	To update a configuration, modify the corresponding xml file and type:		To get a starting <kitdefinition>.xml file for an existing project in the server database, type:
			<code>%LRM_CMD% -edownload <kit-project-name></code>
			This may come in handy when you want to modify an existing configuration. The resulting xml file is named <b>SetupConfigRoot.xml</b> and is located under <b>reports\<kit-project-name></b>

			To update a configuration, download and modify the corresponding xml file and type:
	<code> %LRM_CMD% -eupdateconfig <kitdefinition>.xml</code>		<code> %LRM_CMD% -eupdateconfig <kitdefinition>.xml</code>

Olibouban: /* Prepare a Kit */

2012-09-06T20:42:16Z

Prepare a Kit

← Older revision		Revision as of 20:42, 6 September 2012
Line 104:		Line 104:
	<li>a directory for each locale with the files copied from source.</li>		<li>a directory for each locale with the files copied from source.</li>
	</ul>		</ul>

			<b>Important Note:</b> if there are still errors in the files to be sent for translation, the PREP_KIT_<x> file will contain a <b>BaseFileSearchErrors_<default-locale>.xml</b> and the kit will not be created.

Olibouban: /* Check What Files Will Be Included In The Next Kit */

2012-09-06T20:36:49Z

Check What Files Will Be Included In The Next Kit

← Older revision		Revision as of 20:36, 6 September 2012
Line 94:		Line 94:
	Before creating a kit, you may want to enumerate exactly what files will be sent for translation. To do so, use the following command:		Before creating a kit, you may want to enumerate exactly what files will be sent for translation. To do so, use the following command:
	<code>%LRM_CMD% -eprepreport <kit-project-name></code>		<code>%LRM_CMD% -eprepreport <kit-project-name></code>
			Make sure to check the results, located in the <b>BaseFileSearch<locale\|error>.xml</b> file under reports\<kit-project-name>. The <b>BaseFileSearchErrors_en_US.xml</b> is of particular interest. You probably want to make sure there are no errors before sending a kit.

	=== Prepare a Kit ===		=== Prepare a Kit ===

Olibouban: /* Check Source Files */

2012-09-06T20:35:07Z

Check Source Files

← Older revision		Revision as of 20:35, 6 September 2012
Line 87:		Line 87:
	Before creating a kit, you may want to first check for issues in the configuration or in the resource files to be sent for translation in the next kit. To do so, use the following command:		Before creating a kit, you may want to first check for issues in the configuration or in the resource files to be sent for translation in the next kit. To do so, use the following command:
	<code>%LRM_CMD% -eresourceissues <kit-project-name></code>		<code>%LRM_CMD% -eresourceissues <kit-project-name></code>
	~~The~~ result is located in the ResourceIssue.xml file under reports\<kit-project-name>		Make sure to check the result, located in the ResourceIssue.xml file under reports\<kit-project-name>

	You may want to correct the issues before creating a kit to be sent for translation.		You may want to correct the issues before creating a kit to be sent for translation.