LRM Process Commands Reference - Revision history

Llawson: /* Custom Emails */

2022-04-29T18:24:18Z

Custom Emails

← Older revision		Revision as of 18:24, 29 April 2022
Line 159:		Line 159:
	The email will be sent to the import kit recipients for that project. (see [[Project_Configuration_Files#config_email_recipients.xml\|Email Recipients]])		The email will be sent to the import kit recipients for that project. (see [[Project_Configuration_Files#config_email_recipients.xml\|Email Recipients]])

	There is a more robust sample for a custom velocity template located in the ''~~deploy/~~samples'' folder of your Localyzer install directory.		There is a more robust sample for a custom velocity template located in the ''samples'' folder of your Localyzer install directory.

Llawson: /* Custom Emails */

2022-04-29T18:23:42Z

Custom Emails

← Older revision		Revision as of 18:23, 29 April 2022
Line 153:		Line 153:
	Command example for this template could be:		Command example for this template could be:

	java -jar lrmprocess-cli.jar -se -vt /var/lib/jenkins/velocity/example.vm -gn <group> -pn <project> -subj "My Custom Example" -kv 121 -an "I can put anything here" -lc "This can also be anything"		java -jar lrmprocess-cli.jar -se -vt /var/lib/jenkins/velocity/example.vm -gn <group> -pn <project> -subj "My Custom Example" -kv 121 -an "'I can put anything here'" -lc "'This can also be anything'"

	'''Required arguments''' are the project name, group name, velocity file and subject.		'''Required arguments''' are the project name, group name, velocity file and subject.

	The email will be sent to the import kit recipients for that project. (see [[Project_Configuration_Files#config_email_recipients.xml\|Email Recipients]])		The email will be sent to the import kit recipients for that project. (see [[Project_Configuration_Files#config_email_recipients.xml\|Email Recipients]])

			There is a more robust sample for a custom velocity template located in the ''deploy/samples'' folder of your Localyzer install directory.

Llawson: /* Custom Emails */

2022-04-29T17:52:37Z

Custom Emails

← Older revision		Revision as of 17:52, 29 April 2022
Line 130:		Line 130:
	==== Custom Emails ====		==== Custom Emails ====
	You can create your own custom email by creating a custom velocity template (https://velocity.apache.org/engine/1.7/user-guide.html). This custom velocity template may have any of the following tokens:		You can create your own custom email by creating a custom velocity template (https://velocity.apache.org/engine/1.7/user-guide.html). This custom velocity template may have any of the following tokens:
	*'''$groupname'''		*'''$groupname''' - is a valid Localyzer group name
	*'''$projectname'''		*'''$projectname''' - is a valid Localyzer project name for the group
	*'''$prepkitversion'''		*'''$prepkitversion''' - must be a number but doesn't need to be a valid prep kit version
	*'''$applicationname'''		*'''$applicationname''' - can be any text. Does not need to be a valid application name
	*'''$locale'''		*'''$locale''' - can be any text. Does not need to be a valid project locale

	Example template where the name of the file is ''example.vm'' and it contains all of the available tokens.		Example template where the name of the file is ''example.vm'' and it contains all of the available tokens.

Llawson: /* Custom Emails */

2022-04-29T17:37:55Z

Custom Emails

← Older revision		Revision as of 17:37, 29 April 2022
Line 129:		Line 129:

	==== Custom Emails ====		==== Custom Emails ====
	You can create your own custom email by creating a custom ~~[["~~https://velocity.apache.org/engine/1.7/user-guide.html~~"\|velocity template]]~~. This custom velocity template may have any of the following tokens:		You can create your own custom email by creating a custom velocity template (https://velocity.apache.org/engine/1.7/user-guide.html). This custom velocity template may have any of the following tokens:
	*'''$groupname'''		*'''$groupname'''
	*'''$projectname'''		*'''$projectname'''

Llawson: /* Version Control Error Emails */

2022-04-29T17:36:38Z

Version Control Error Emails

@@ Line 120: / Line 120: @@
 Errors may occur, outside of Localyzer,  when trying to pull or push to the remote repository. If an error is detected, then in your script you can call the send-email with one of the following email type options:
 *''--version-control-get'' - if the error occurred when pulling from the remote repository.
-**Sends email to the prep kit recipients (see [[Project_Configuration_Files#config_email_recipients.xml|Email Recipients]])
+**Sends email to the prep kit recipients for that project (see [[Project_Configuration_Files#config_email_recipients.xml|Email Recipients]])
    java -jar lrmprocess-cli.jar --send-email --version-control-get -pn <project> -gn <group>
 *''--version-control-import'' - if the error occurred when pushing the import files into the remote repository
-**Sends email to the import kit recipients (see [[Project_Configuration_Files#config_email_recipients.xml|Email Recipients]])
+**Sends email to the import kit recipients for that project (see [[Project_Configuration_Files#config_email_recipients.xml|Email Recipients]])
    java -jar lrmprocess-cli.jar --send-email --version-control-import -pn <project> -gn <group>

Llawson: /* Version Control Error Emails */

2022-04-29T17:20:08Z

Version Control Error Emails

← Older revision		Revision as of 17:20, 29 April 2022
Line 118:		Line 118:
	=== Send Emails ===		=== Send Emails ===
	==== Version Control Error Emails ====		==== Version Control Error Emails ====
	Errors may occur, outside of Localyzer, when trying to pull or push to the remote repository. If an error is detected in your script you can call the send-email with one of the following email ~~types~~		Errors may occur, outside of Localyzer, when trying to pull or push to the remote repository. If an error is detected, then in your script you can call the send-email with one of the following email type options:
	*''--version-control-get'' - if the error occurred when pulling from the remote repository		*''--version-control-get'' - if the error occurred when pulling from the remote repository.
			**Sends email to the prep kit recipients (see [[Project_Configuration_Files#config_email_recipients.xml\|Email Recipients]])

			java -jar lrmprocess-cli.jar --send-email --version-control-get -pn <project> -gn <group>
	*''--version-control-import'' - if the error occurred when pushing the import files into the remote repository		*''--version-control-import'' - if the error occurred when pushing the import files into the remote repository
			**Sends email to the import kit recipients (see [[Project_Configuration_Files#config_email_recipients.xml\|Email Recipients]])

			java -jar lrmprocess-cli.jar --send-email --version-control-import -pn <project> -gn <group>

Llawson: /* Send Emails */

2022-04-29T17:15:53Z

Send Emails

← Older revision		Revision as of 17:15, 29 April 2022
Line 116:		Line 116:
	java -jar lrmprocess-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

	==== Send Emails ====		=== Send Emails ===
	===== Version Control Error Emails =====		==== Version Control Error Emails ====
	Errors may occur, outside of Localyzer, when trying to pull or push to the remote repository. If an error is detected in your script you can call the send-email		Errors may occur, outside of Localyzer, when trying to pull or push to the remote repository. If an error is detected in your script you can call the send-email with one of the following email types
			*''--version-control-get'' - if the error occurred when pulling from the remote repository
	~~Errors may occur, outside of Localyzer,~~ when ~~trying to pull or push to~~ the remote repository~~. If an~~ error ~~is detected in your script you can call~~ the ~~send-email~~		*''--version-control-import'' - if the error occurred when pushing the import files into the remote repository

Llawson: /* Override Prep Kit */

2022-04-29T17:11:34Z

Override Prep Kit

← Older revision		Revision as of 17:11, 29 April 2022
Line 115:		Line 115:
	* Create a prep kit for a specific locale file		* 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		java -jar lrmprocess-cli.jar -pk -or -pn <project> -gn <group> -lc fr -rf /var/lib/jenkins/myproject/resources/file3.properties

			==== Send Emails ====
			===== Version Control Error Emails =====
			Errors may occur, outside of Localyzer, when trying to pull or push to the remote repository. If an error is detected in your script you can call the send-email

			Errors may occur, outside of Localyzer, when trying to pull or push to the remote repository. If an error is detected in your script you can call the send-email

Llawson: /* Reference */

2022-04-29T16:54:12Z

Reference

← Older revision		Revision as of 16:54, 29 April 2022
Line 8:		Line 8:
	<pre>		<pre>

	-cs,--check-send Command to send any pending prep kits to the active L10n vendor.		-cs,--check-send Command to send any pending prep kits to the active L10n vendor.

	-d,--debug Log4j Debug mode		-d,--debug Log4j Debug mode

Llawson: /* Reference */

2022-04-29T16:54:00Z

Reference

Show changes