Localyzer Projects - Revision history

Rdaly: /* How can I tell if my Localyzer project is setup correctly? */

2022-08-26T19:23:26Z

How can I tell if my Localyzer project is setup correctly?

← Older revision		Revision as of 19:23, 26 August 2022
Line 23:		Line 23:
	If the Localyzer Jenkins job fails when creating an Localyzer project, fix those failures before moving forward. If there are ERRORs in the Jenkins job output, but the job passes, debug those errors before moving forward.		If the Localyzer Jenkins job fails when creating an Localyzer project, fix those failures before moving forward. If there are ERRORs in the Jenkins job output, but the job passes, debug those errors before moving forward.

	Once an Localyzer project is set up, check that it looks correct on the Lingoport Dashboard. Select the project name from the main menu. This takes you to the overview		Once a Localyzer project is set up, check that it looks correct on the Lingoport Dashboard. Select the project name from the main menu. This takes you to the overview

	[[File:DashboardLiteLRM.png\|700px]]		[[File:DashboardLiteLRM.png\|700px]]

Olibouban: Olibouban moved page LRM Projects to Localyzer Projects

2021-07-12T14:13:57Z

Olibouban moved page LRM Projects to Localyzer Projects

← Older revision	Revision as of 14:13, 12 July 2021
(No difference)

Rdaly: /* How can I tell if my Localyzer project is setup correctly? */

2021-07-09T22:22:05Z

How can I tell if my Localyzer project is setup correctly?

← Older revision		Revision as of 22:22, 9 July 2021
Line 27:		Line 27:
	[[File:DashboardLiteLRM.png\|700px]]		[[File:DashboardLiteLRM.png\|700px]]

	Select the '''Lingoport''' pulldown and '''~~Resource Manager~~''' or click on '''~~Resource Manager~~ Summary Report'''		Select the '''Lingoport''' pulldown and '''Localyzer''' or click on '''Localyzer Summary Report'''
	on the Dashboard,		on the Dashboard,

Rdaly at 22:19, 9 July 2021

2021-07-09T22:19:18Z

Rdaly: /* How to change a project that has prep kits assigned */

2020-06-13T23:04:38Z

How to change a project that has prep kits assigned

← Older revision		Revision as of 23:04, 13 June 2020
Line 186:		Line 186:

	lrm --deleteProject -gn Acme -pn myproject		lrm --deleteProject -gn Acme -pn myproject

	3) Return to Jenkins and make the changes to the project and 'Build' it.		3) Return to Jenkins and make the changes to the project and 'Build' it.

Rdaly at 23:03, 13 June 2020

2020-06-13T23:03:45Z

← Older revision		Revision as of 23:03, 13 June 2020
Line 172:		Line 172:

	Once a group has been created, the database and the file structure are updated. The Jenkins LicenseExpiration job should be created and it should show the change to the license.		Once a group has been created, the database and the file structure are updated. The Jenkins LicenseExpiration job should be created and it should show the change to the license.

			== How to change a project that has prep kits assigned ==

			Sometimes, changes and updates need to be made to projects and when changed, there is a error about "Prep kits have been assigned" and the change cannot be made. It can be done, but it takes a few steps.

			1) Note the last prep kit number sent so you can tell the projects to make sure they delete those. Otherwise, there may be a collision in the naming of the projects in the translation management system.

			2) Go to the TTY console as user 'jenkins' and delete the LRM project, something like:

			lrm --deleteProject -gn <group name> -pn <project name>

			and type 'yes' when prompted. For a Jenkins project called Acme.myproject, this would look like:

			lrm --deleteProject -gn Acme -pn myproject

			3) Return to Jenkins and make the changes to the project and 'Build' it.

			4) From the TTY console, check which files are being handled with:

			lrm -gn <group name> -pn <project name> -r -pi
			for example:
			lrm -gn Acme -pn myproject -r -pi

			and look at the report files that are generated.

			5) Adjust your Jenkins on-boarding accordingly and redo 4 & 5 until satisfied :)

Rdaly: /* How to on board an Android project with strings.xml file */

2019-12-26T23:23:57Z

How to on board an Android project with strings.xml file

← Older revision		Revision as of 23:23, 26 December 2019
Line 135:		Line 135:

	Select the xml '''Resource Extension Configuration''', removing the other extensions. Configure as shown in the picture. Files will be returned like: <code>.../values_de_DE/strings.xml</code>.		Select the xml '''Resource Extension Configuration''', removing the other extensions. Configure as shown in the picture. Files will be returned like: <code>.../values_de_DE/strings.xml</code>.

			[[File:IncludeDirXml.png\|700px]]

	In the '''Directories''' section, '''Include Directory/File''', enter '''**/strings.xml'''. This way, only 'strings.xml' files will be analyzed and not other xml-type files which may not be resource files.		In the '''Directories''' section, '''Include Directory/File''', enter '''**/strings.xml'''. This way, only 'strings.xml' files will be analyzed and not other xml-type files which may not be resource files.

Rdaly: /* How to on board an IOS project with .strings resource files */

2019-12-26T21:22:01Z

How to on board an IOS project with .strings resource files

← Older revision		Revision as of 21:22, 26 December 2019
Line 156:		Line 156:
	'''Save''' and '''Build Now''' the new project.		'''Save''' and '''Build Now''' the new project.

	The Dashboard will be created for the new project and the Resource Manager page should reflect the project and show the files that will be sent for translation. If the Dashboard does not look correct or shows the wrong files, return to the Jenkins job and check the configuration.		The Dashboard will be created for the new project and the Resource Manager page should reflect the project and show the files that will be sent for translation. If the Dashboard does not look correct or shows the wrong files, return to the Jenkins job and check the console output and the configuration.

	== How to add or update an LRM license from the command line ==		== How to add or update an LRM license from the command line ==

Rdaly: /* How to on board an IOS project with .strings resource files */

2019-12-26T21:21:39Z

How to on board an IOS project with .strings resource files

← Older revision		Revision as of 21:21, 26 December 2019
Line 155:		Line 155:

	'''Save''' and '''Build Now''' the new project.		'''Save''' and '''Build Now''' the new project.

			The Dashboard will be created for the new project and the Resource Manager page should reflect the project and show the files that will be sent for translation. If the Dashboard does not look correct or shows the wrong files, return to the Jenkins job and check the configuration.

	== How to add or update an LRM license from the command line ==		== How to add or update an LRM license from the command line ==

Rdaly: /* How to on board an IOS project with .strings resource files */

2019-12-26T21:09:23Z

How to on board an IOS project with .strings resource files

← Older revision		Revision as of 21:09, 26 December 2019
Line 152:		Line 152:
	[[File:ResourceFileExtensionStrings.png\|700px]]		[[File:ResourceFileExtensionStrings.png\|700px]]

	Select the strings '''Resource Extension Configuration''', removing the other extensions. Configure as shown in the picture. Note the example shown, it should match the form of the translated files.		Select the strings '''Resource Extension Configuration''', removing the other extensions. Configure as shown in the picture. Note the example shown, it should match the form of the translated files.



			'''Save''' and '''Build Now''' the new project.

	== How to add or update an LRM license from the command line ==		== How to add or update an LRM license from the command line ==

← Older revision		Revision as of 22:19, 9 July 2021
Line 1:		Line 1:
	==Creating a project in Jenkins==		==Creating a project in Jenkins==

	To create a new ~~LRM~~ project, follow [[On Boarding an LRM Project]] or [[On Boarding a project with both LRM and Globalyzer]] depending on the circumstances.		To create a new Localyzer project, follow [[On Boarding an LRM Project]] or [[On Boarding a project with both LRM and Globalyzer]] depending on the circumstances.

	== What is 'Missed Translation Error' and 'Parameter Mismatch Error'?==		== What is 'Missed Translation Error' and 'Parameter Mismatch Error'?==

	When configuring an ~~LRM~~ project, there is an '''Advanced...''' button in the '''General Settings''' section. Clicking that will open a new section called '''Detect Errors'''.		When configuring an Localyzer project, there is an '''Advanced...''' button in the '''General Settings''' section. Clicking that will open a new section called '''Detect Errors'''.

	[[File:DetectErrors.jpg\|700px]]		[[File:DetectErrors.jpg\|700px]]
Line 19:		Line 19:
	If the translated string is returned without 2 parameters, then the error will be triggered.		If the translated string is returned without 2 parameters, then the error will be triggered.

	==How can I tell if my ~~LRM~~ project is setup correctly?==		==How can I tell if my Localyzer project is setup correctly?==

	If the ~~LRM~~ Jenkins job fails when creating an ~~LRM~~ project, fix those failures before moving forward. If there are ERRORs in the Jenkins job output, but the job passes, debug those errors before moving forward.		If the Localyzer Jenkins job fails when creating an Localyzer project, fix those failures before moving forward. If there are ERRORs in the Jenkins job output, but the job passes, debug those errors before moving forward.

	Once an ~~LRM~~ project is set up, check that it looks correct on the Lingoport Dashboard. Select the project name from the main menu. This takes you to the overview		Once an Localyzer project is set up, check that it looks correct on the Lingoport Dashboard. Select the project name from the main menu. This takes you to the overview

	[[File:DashboardLiteLRM.png\|700px]]		[[File:DashboardLiteLRM.png\|700px]]
Line 36:		Line 36:
	* If you hover the mouse over '''Next Send Translation Content''', a list of resource files will come up (as long as there are resource files to prep).		* If you hover the mouse over '''Next Send Translation Content''', a list of resource files will come up (as long as there are resource files to prep).

	The '''project inspect''' reports are created upon creation of [[Terms_and_Definitions#LRMProject\|~~LRM~~ project]]. Otherwise, they can be run again from a command line:		The '''project inspect''' reports are created upon creation of [[Terms_and_Definitions#LRMProject\|Localyzer project]]. Otherwise, they can be run again from a command line:

	<pre>		<pre>
Line 83:		Line 83:
	</pre>		</pre>

	You may need to edit your project definition. See [[Supported_Resource_Bundles#Lingoport_Resource_Manager_Configuration\|Project Definition]] for information about configuring a ~~LRM~~ project.		You may need to edit your project definition. See [[Supported_Resource_Bundles#Lingoport_Resource_Manager_Configuration\|Project Definition]] for information about configuring a Localyzer project.

	==Why, when I create a project, do I get an error stating that no resource files were found (Error 500)?==		==Why, when I create a project, do I get an error stating that no resource files were found (Error 500)?==
Line 94:		Line 94:
	[[File:Build2.png\|700px]]		[[File:Build2.png\|700px]]

	The example in the extension shows what format of file that ~~LRM~~ is looking for. If the resource files do no look like this, then modify this section and see if the error goes away.		The example in the extension shows what format of file that Localyzer is looking for. If the resource files do no look like this, then modify this section and see if the error goes away.

	On the command line to check the Project Definition File:		On the command line to check the Project Definition File:
Line 100:		Line 100:

	The items to check (with the project definition file xml and the Jenkins configuration name) are:		The items to check (with the project definition file xml and the Jenkins configuration name) are:
	* '''<top-level-dir>''' or '''Top Level Directory'''- this is the path to the source code (resource files) for the ~~LRM~~ Project. For example if you have <code>$WORKSPACE/resources</code> or <code><top-level-dir>/var/lib/jenkins/jobs/CET.Smoke/workspace/resources</top-level-dir></code> but the resource files are in <code>/var/lib/jenkins/jobs/CET.Smoke/workspace'''/locales'''</code>, then ~~LRM~~ will not find the resource files.		* '''<top-level-dir>''' or '''Top Level Directory'''- this is the path to the source code (resource files) for the Localyzer Project. For example if you have <code>$WORKSPACE/resources</code> or <code><top-level-dir>/var/lib/jenkins/jobs/CET.Smoke/workspace/resources</top-level-dir></code> but the resource files are in <code>/var/lib/jenkins/jobs/CET.Smoke/workspace'''/locales'''</code>, then Localyzer will not find the resource files.
	<pre>		<pre>
	<top-level-dir>/var/lib/jenkins/path/to/my/resource_files</top-level-dir>		<top-level-dir>/var/lib/jenkins/path/to/my/resource_files</top-level-dir>
Line 106:		Line 106:
	* Patterns for your resource file names:		* Patterns for your resource file names:
	** '''<file-name-pattern>...</file-name-pattern>''' or '''Filename Pattern''' - verify that the separator characters are correct for your localized resource file names. For example, if your French Canadian localized resource file names are of the form <code>myResources_fr_CA.properties</code> then set the following: <pre><file-name-pattern>*_l_c_v</file-name-pattern></pre>		** '''<file-name-pattern>...</file-name-pattern>''' or '''Filename Pattern''' - verify that the separator characters are correct for your localized resource file names. For example, if your French Canadian localized resource file names are of the form <code>myResources_fr_CA.properties</code> then set the following: <pre><file-name-pattern>*_l_c_v</file-name-pattern></pre>
	** '''<use-pattern-on-dflt-locale>...</use-pattern-on-dflt-locale>''' or '''Use Pattern on Default Locale''' - Set to "1" (or checked) (true), it indicates you will use base resource files that include the default locale in their filenames. For example, if the default locale is set to "en_US" and the file-name-pattern for "properties" resource files is set to "*_l_c_v", then ~~LRM~~ will look for '''<code>myResources_en_US.properties</code>''' when creating a kit of files to be sent out for translation. If set to "0" (or unchecked) (false), then ~~LRM~~ will look for base resource files that do not have the default locale as part of their filenames. Using our "properties" file example, ~~LRM~~ will look for '''<code>myResources.properties</code>''' when creating files for translation.<pre><use-location-pattern-on-dflt-locale>0</use-location-pattern-on-dflt-locale></pre>		** '''<use-pattern-on-dflt-locale>...</use-pattern-on-dflt-locale>''' or '''Use Pattern on Default Locale''' - Set to "1" (or checked) (true), it indicates you will use base resource files that include the default locale in their filenames. For example, if the default locale is set to "en_US" and the file-name-pattern for "properties" resource files is set to "*_l_c_v", then Localyzer will look for '''<code>myResources_en_US.properties</code>''' when creating a kit of files to be sent out for translation. If set to "0" (or unchecked) (false), then Localyzer will look for base resource files that do not have the default locale as part of their filenames. Using our "properties" file example, Localyzer will look for '''<code>myResources.properties</code>''' when creating files for translation.<pre><use-location-pattern-on-dflt-locale>0</use-location-pattern-on-dflt-locale></pre>
	** '''<file-location-pattern>...</file-location-pattern>''' or '''File Location Pattern''' - verify that the separator characters are correct. For example, if it is set to *-l-c-v and the base resource files are in a '''<code>files</code>''' directory then the translated files will go into '''<code>files-fr-FR</code>''' for a french locale. If <code><use-location-on-dflt-locale>1</use-location-on-dflt-locale></code> or Use Location Pattern on Default Locale is checked (true), then the base resource files need to be in a folder that looks like '''<code>files-en-US</code>'''.		** '''<file-location-pattern>...</file-location-pattern>''' or '''File Location Pattern''' - verify that the separator characters are correct. For example, if it is set to *-l-c-v and the base resource files are in a '''<code>files</code>''' directory then the translated files will go into '''<code>files-fr-FR</code>''' for a french locale. If <code><use-location-on-dflt-locale>1</use-location-on-dflt-locale></code> or Use Location Pattern on Default Locale is checked (true), then the base resource files need to be in a folder that looks like '''<code>files-en-US</code>'''.
	* '''<include-dir>...</include-dir>''' or '''Include Directories''' - verify that the value is a valid Ant formatting directive. If there is no value then only those files directly under the ''base-src-dir'' + ''top-level-dir'' will be searched; no recursive search will occur. To include all folders under the full path, enter a value of '''/'''. You can then exclude other folders by adding additional exclude Ant directives. Format for ''<include-dir>'' is: <pre><include-dir>/</include-dir></pre>		* '''<include-dir>...</include-dir>''' or '''Include Directories''' - verify that the value is a valid Ant formatting directive. If there is no value then only those files directly under the ''base-src-dir'' + ''top-level-dir'' will be searched; no recursive search will occur. To include all folders under the full path, enter a value of '''/'''. You can then exclude other folders by adding additional exclude Ant directives. Format for ''<include-dir>'' is: <pre><include-dir>/</include-dir></pre>
Line 113:		Line 113:
	== Why do I get an error "All active prep kits must be completed before changes can be made" when updating the Jenkins job?==		== Why do I get an error "All active prep kits must be completed before changes can be made" when updating the Jenkins job?==

	~~LRM~~ will error if Prep Kit jobs have been sent, but not returned and the Jenkins job is changed. For example, if the target locales are modified before all prep kits are returned, the Jenkins job will fail with the error:		Localyzer will error if Prep Kit jobs have been sent, but not returned and the Jenkins job is changed. For example, if the target locales are modified before all prep kits are returned, the Jenkins job will fail with the error:

	<pre>		<pre>
Line 160:		Line 160:
	The Dashboard will be created for the new project and the Resource Manager page should reflect the project and show the files that will be sent for translation. If the Dashboard does not look correct or shows the wrong files, return to the Jenkins job and check the console output and the configuration.		The Dashboard will be created for the new project and the Resource Manager page should reflect the project and show the files that will be sent for translation. If the Dashboard does not look correct or shows the wrong files, return to the Jenkins job and check the console output and the configuration.

	== How to add or update an ~~LRM~~ license from the command line ==		== How to add or update an Localyzer license from the command line ==
	'''Using the command line is not recommended. Work with Jenkins and its jobs, whenever possible.''' The '''ManageLicenses''' job will add or update a license.		'''Using the command line is not recommended. Work with Jenkins and its jobs, whenever possible.''' The '''ManageLicenses''' job will add or update a license.

Line 179:		Line 179:
	1) Note the last prep kit number sent so you can tell the projects to make sure they delete those. Otherwise, there may be a collision in the naming of the projects in the translation management system.		1) Note the last prep kit number sent so you can tell the projects to make sure they delete those. Otherwise, there may be a collision in the naming of the projects in the translation management system.

	2) Go to the TTY console as user 'jenkins' and delete the ~~LRM~~ project, something like:		2) Go to the TTY console as user 'jenkins' and delete the Localyzer project, something like:

	lrm --deleteProject -gn <group name> -pn <project name>		lrm --deleteProject -gn <group name> -pn <project name>