Difference between revisions of "Localyzer Projects"

From Lingoport Wiki
Jump to: navigation, search
(→‎Check the Results)
(→‎How can I tell if my Localyzer project is setup correctly?)
 
(58 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
==Creating a project in Jenkins==
  
==Creating a project in Jenkins==
−
===New project===
  
−
LRM creates projects using a [[Terms_and_Definitions#projectdefn|Project Definition XML]] file that contains information about the resources and types for translation and then calling the [[LRM_Commands_Reference#Project_Commands| Create Project Command]].
 
   
  +
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.
−
This is automated in Jenkins with the Lingoport plugin.
 
   
  +
== What is 'Missed Translation Error' and 'Parameter Mismatch Error'?==
−
[[File: JenkinsNewProject.jpg |600px]]
  
   
  +
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'''.
−
To create a new project:
  
−
# Select '''New Item''' from the menu on the left
  
−
# In the dialog box, enter the name of the new project. The name must be of the form '''<group>.<project>''', where the group is the name associated with the LRM license. If you are unsure about the group name, a Jenkins job called '''<group>.LicenseExpiration''' should have been created at installation. Use that <group> name.
 
−
# In the ''Copy from'' box, enter '''Lingoport.SampleLRM''' or '''LingoportSampleLiteLRM'''.
  
   
  +
[[File:DetectErrors.jpg|700px]]
−
Note-a project can be created using '''either''' the project definition file directly on the command line or through the Jenkins LRM Plugin.
  
   
  +
This image shows the default values of '''Missed Translation Error''' and '''Parameter Mismatch Error'''.
−
===Configure the project===
  
−
'''Set the git directory'''
  
   
  +
'''Missed Translation Error''' is defaulted to be unset. This will trigger an error if the text in a translated file is the same as the text in the base file indicating that a translation may not have been done. Sometimes, however, a word or phrase is the same in more than one language.
−
[[File:GithubProject.jpg|600px]]
  
   
  +
'''Parameter Mismatch Error''' is defaulted to be set. Parameters can be defined in a values like:
−
Set the '''Project url''' to the URL for the GitHub repository with the code.
  
   
  +
<code>This is an {0} example of a string {1} with 2 parameters</code>
   
  +
If the translated string is returned without 2 parameters, then the error will be triggered.
−
Set the repository info and the branch name for the code.
  
   
  +
==How can I tell if my Localyzer project is setup correctly?==
−
'''Set up the Git Repository and the branch'''
  
   
  +
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.
−
[[File:JenkinsGitRepo.jpg |600px]]
  
  +
  +
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]]
−
Make sure that the '''Repository URL''' and the '''Branch Specifier''' are correct.
  
   
  +
Select the '''Lingoport''' pulldown and '''Localyzer''' or click on '''Localyzer Summary Report'''
−
'''Set the General Settings and Locales'''
  
  +
on the Dashboard,
   
  +
* There should not be any critical errors (they will be in red)
−
[[File:JenkinsLRMSettings.jpg |600px]]
  
  +
* The '''Default Locale''' should be set to the locale that was set up.
  +
* The '''Locale''' list should be the same set up in Jenkins.
  +
* The number of '''Base Resource Files''' should be resonable.
  +
* 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|Localyzer project]]. Otherwise, they can be run again from a command line:
−
The '''Top Level Directory''' is defaulted to $WORKSPACE. That means that LRM looks at the whole repository to find the resource files. This can be changed to look at only specific directories if you know where the resource files are kept.
 
  +
  +
<pre>
  +
> java -jar lrm-cli.jar -r -pi -pn <ProjectName> -gn <GroupName>
  +
> java -jar lrm-cli.jar --report --project-inspect --project-name <ProjectName> --group-name <GroupName>
  +
The following reports were generated:
  +
/var/lib/jenkins/Lingoport_Data/LRM/<GroupName>/reports/<ProjectName>/ProjectInspect_en_us.xml
  +
/var/lib/jenkins/Lingoport_Data/LRM/<GroupName>/reports/<ProjectName>/ProjectInspect_de_de.xml
  +
/var/lib/jenkins/Lingoport_Data/LRM/<GroupName>/reports/<ProjectName>e/ProjectInspect_fr_fr.xml
  +
/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<GroupName>/projects/<ProjectName>/reports/project_inspect_files.txt
  +
Process completed successfully.
  +
</pre>
   
  +
This command generates reports in your reports folder for ''each locale'' specified in the project. Each report shows the location of the [[Terms_and_Definitions#resourcefile|resource files]], the number of files to be translated, and the file names.
−
The Send Unique Filenames checkbox is unchecked. Check this if the resource files are in the form:
  
   
  +
<pre>
−
folder1:
  
  +
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
−
en_US.properties
  
  +
<LRMProjectInspectResults projectID="217" projectName="YourProjectName" topLevelDirector
−
folder2:
  
  +
y="/location/of/files/resources">
−
en_US.properties
  
  +
<locale>en_US</locale>
  +
<isBaseLocale>true</isBaseLocale>
  +
<nbFiles>3</nbFiles>
  +
<results>
  +
<result file="/file1.json"/>
  +
<result file="/file2.properties"/>
  +
<result file="/file3.rjs"/>
  +
</results>
  +
</LRMProjectInspectResults>
  +
</pre>
   
  +
In addition, file ''project_inspect_files.txt'' is created listing all of the absolute paths of the corresponding target files for each base resource file. The following is an example where:
−
There are two resource files called <code>en_US.properties</code>. These will be given unique filenames in the prep kit when sent to the translation system and then imported back to the correct location.
 
  +
* The group name is ''GroupName''
  +
* The project name is ''YourProjectName''
  +
* The top level source directory defined in the project definition is ''location/of/files/resources''
  +
* In the project definition, extension ''json'' has a name of pattern of ''*.l_c_v''. The default locale files for this extension does not use the name pattern. There is no location pattern.
  +
* In the project definition, extension ''properties'' has a name of pattern of ''*_l_c_v''. The default locale files for this extension does not use the name pattern. There is no location pattern.
  +
* In the project definition, extension ''rjs'' has a name of pattern of ''*-l-c-v''. The default locale files for this extension does not use the name pattern. There is no location pattern.
   
  +
<pre>
−
Any number of locales in various formats including LCID can be entered.
 
  +
/var/lib/jenkins/jobs/GroupName.YourProjectName/workspace/location/of/files/resources/file1.fr_fr.json
  +
/var/lib/jenkins/jobs/GroupName.YourProjectName/workspace/location/of/files/resources/file1.es_mx.json
  +
/var/lib/jenkins/jobs/GroupName.YourProjectName/workspace/location/of/files/resources/file2_fr_fr.properties
  +
/var/lib/jenkins/jobs/GroupName.YourProjectName/workspace/location/of/files/resources/file2_es_mx.properties
  +
/var/lib/jenkins/jobs/GroupName.YourProjectName/workspace/location/of/files/resources/file3-fr-fr.rjs
  +
/var/lib/jenkins/jobs/GroupName.YourProjectName/workspace/location/of/files/resources/file3-es-mx.rjs
  +
</pre>
   
  +
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.
−
'''Set up the Resource File Extensions '''
  
   
  +
==Why, when I create a project, do I get an error stating that no resource files were found (Error 500)?==
−
[[File:JenkinsLRMResourceFileExtensions.jpg|600px]]
  
   
  +
This is a pretty common error and generally easy to fix.
−
* In this example, the resource file type '''extension''' and '''parser type''' is 'properties' and 'rc'.
 
  +
Your project may not setup correctly. Check the Project Definition File used to create the project or open the Jenkins job Configuration. This error may also occur if you are using transforms. If that is the case, this may not be a problem and check if transforms ran successfully and the Dashboard looks correct.
−
* We are using the default '''Parameter Regex Pattern'''.
  
−
* The '''Filename pattern''' is *_l_c_v which means that it expects filenames to be in the form 'something_xx_yy.properties'.
  
−
* Since '''Use Pattern on Default Locale''' is checked, LRM will look for the Filename pattern on the resource file for the default locale.
 
−
* '''File Location Pattern''' is empty, so all the resource files will be located in the same directory.
 
−
* '''Use Location Pattern on Default Locale''' is unchecked. It can't be checked if File Location Pattern is empty, but it tells what the directories will look like for the base and translated resources.
 
−
* Using these variables, the Jenkins job gives and example of the Base Resource File. It should be of the form <code>file1_en_us.properties</code> and the target resources will be of the form <code>file1_zh_hans_tw.properties</code>. If the resource files do not conform to these settings, errors and missed files might occur.
  
   
  +
In Jenkins, open the job configuration and scroll down to '''Resource File Extensions'''.
−
'''Set the directories and emails'''
  
   
−
[[File:JenkinsDirEmails.jpg|600px]]
 +
[[File:Build2.png|700px]]
   
  +
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.
−
* The '''Include Directory/File''' defaults to <code>**/**</code>. All the code in the repository is included. More directories or files can be included.
 
−
* The '''Exclude Directory Files''' have pre-filled entries for <code>**\*_eo.properties</code> (any pseudo-localized files), <code>**/LRMScans/**,**/GlobalyzerScans/**</code> and <code>**/sonar-project.properties</code> (all Lingoport files that don't have repos). More files can be excluded as needed.
 
−
* The email addresses need to be set up to indicate who should receive the various notifications. More than one address can be set for each notification.
  
   
  +
On the command line to check the Project Definition File:
−
'''Save''' the values and return to the Jenkins menu. '''Enable''' the project, if it is disabled and select '''Build Now''' from the menu to create the new project.
  
  +
> vi /var/lib/jenkins/Lingoport_Data/LRM/<group-name>/reports/<project-name>/ProjectDefinition.xml
   
  +
The items to check (with the project definition file xml and the Jenkins configuration name) are:
−
=== Check the Results ===
  
  +
* '''<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>
  +
<top-level-dir>/var/lib/jenkins/path/to/my/resource_files</top-level-dir>
  +
</pre>
  +
* 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>
  +
** '''<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>'''.
  +
* '''<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>
  +
* '''<exclude-dir-file>...</exclude-dir-file>''' or Exclude Directory Files - verify that the value is a valid Ant formatting directive and that you're not excluding valid files/folders. Format for ''<exclude-dir>'' is: <pre><exclude-dir-file>...</exclude-dir-file></pre>
   
  +
== Why do I get an error "All active prep kits must be completed before changes can be made" when updating the Jenkins job?==
−
After the project builds, there is a red or blue indicator under the job's Build History. Select the indicator to see the Console Output for the newly created job.
  
   
  +
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:
−
[[File:BuildHistory.jpg|600px]]
  
   
  +
<pre>
−
The Console Output can be daunting, but there are a few things to verify.
  
  +
ERROR 2019-06-20 20:55:07,128 com.lingoport.lrm.controller.kitrootconfig.pipeline.stage.CompareExistingLocalesWithXMLStage.addError: Error 230: Cannot delete locales for project `NewLRMProject`. All active prep kits must be completed before changes can be made.
  +
Process failed. See error log in `/var/lib/jenkins/Lingoport_Data/LRM/<group-name>/logs/lrmerror.log` for details.
  +
</pre>
   
  +
Once all outstanding prep kits have returned, then things can be modified in the job.
−
[[File:FirstTimeBuild.jpg|600px]]
  
   
  +
== How to on board an Android project with strings.xml file==
−
* Since this is the first time running, the '''Project Definition File''' and several other configuration files will be created.
 
−
* Verify that '''ERROR''' does not occur anywhere in the output.
 
−
* At the bottom of the the output, it should say '''ANALYSIS SUCCESSFUL''' and '''END UPDATE DASHBOARD'''.
  
   
  +
Android resource files are often called 'strings.xml' and exist in many 'values' directories. On boarding this type of project can be slightly different than other resource file types. Your resource files may look like:
−
At this point, the Lingoport Dashboard should have been updated with the project information.
 
   
  +
.../memories/src/main/res/values/strings.xml
−
If any of these criteria are not met, troubleshoot the project before moving forward.
  
  +
.../shared/src/main/res/values/strings.xml
  +
.../family/src/main/res/values/strings.xml
  +
  +
Since we have the same filename in several directories, '''Send Unique Filenames''' should be selected so that all the resource files are sent in one kit and not several of them.
  +
  +
[[File:ResourceFileExtensionXml.png|700px]]
  +
  +
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.
  +
  +
'''Save''' and '''Build Now''' the new project.
  +
  +
[[File:AndroidStringsDashboard.png|700px]]
  +
  +
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 on board an IOS project with .strings resource files ==
  +
  +
Resource files for IOS projects often look like <code>.../en.lproj/<filename>.strings</code> or <code>.../en_US.lproj/<filename>.strings</code>.
  +
  +
To on board a .strings project, create a new project. Set up the repository, branch, and the locales to be translated.
  +
  +
[[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.
  +
  +
'''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 console output and the configuration.
  +
  +
== 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.
  +
  +
If you'd rather use the command line instead of the Jenkins ManageLicenses job, for instance in a script, use the <code>--create-group</code> command on lrm-cli.jar command line. Using the command line is not recommende. The ManageLicenses Jenkins job is more reliable. You need to have requested a license key for the new group from Lingoport before creating the group. For instance:
  +
  +
> java -jar $LRM_HOME/lrm-cli.jar --create-group --group-name group1 --date "2016-06-01" --number-of-licenses 10 --license-key <license-key>
  +
  +
To update the license of an existing group, used the <code>--update-license</code> command on lrm-cli.jar command line. You need to have requested a license key for the new group from Lingoport before updating the group.For instance:
  +
  +
> java -jar $LRM_HOME/lrm-cli.jar --update-license --group-name group1 --date "2016-06-01" -number-of-licenses 10 --license-key <license-key>
  +
  +
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 Localyzer 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 :)

Latest revision as of 19:23, 26 August 2022

Creating a project in Jenkins

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'?

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.

DetectErrors.jpg

This image shows the default values of Missed Translation Error and Parameter Mismatch Error.

Missed Translation Error is defaulted to be unset. This will trigger an error if the text in a translated file is the same as the text in the base file indicating that a translation may not have been done. Sometimes, however, a word or phrase is the same in more than one language.

Parameter Mismatch Error is defaulted to be set. Parameters can be defined in a values like:

This is an {0} example of a string {1} with 2 parameters

If the translated string is returned without 2 parameters, then the error will be triggered.

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

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 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

DashboardLiteLRM.png

Select the Lingoport pulldown and Localyzer or click on Localyzer Summary Report on the Dashboard,

  • There should not be any critical errors (they will be in red)
  • The Default Locale should be set to the locale that was set up.
  • The Locale list should be the same set up in Jenkins.
  • The number of Base Resource Files should be resonable.
  • 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 Localyzer project. Otherwise, they can be run again from a command line: 

> java -jar lrm-cli.jar -r -pi -pn <ProjectName> -gn <GroupName>
> java -jar lrm-cli.jar --report --project-inspect --project-name <ProjectName> --group-name <GroupName>
The following reports were generated:
/var/lib/jenkins/Lingoport_Data/LRM/<GroupName>/reports/<ProjectName>/ProjectInspect_en_us.xml
/var/lib/jenkins/Lingoport_Data/LRM/<GroupName>/reports/<ProjectName>/ProjectInspect_de_de.xml
/var/lib/jenkins/Lingoport_Data/LRM/<GroupName>/reports/<ProjectName>e/ProjectInspect_fr_fr.xml
/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<GroupName>/projects/<ProjectName>/reports/project_inspect_files.txt
Process completed successfully.

This command generates reports in your reports folder for each locale specified in the project. Each report shows the location of the resource files, the number of files to be translated, and the file names. 

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<LRMProjectInspectResults projectID="217" projectName="YourProjectName" topLevelDirector
y="/location/of/files/resources">
  <locale>en_US</locale>
  <isBaseLocale>true</isBaseLocale>
  <nbFiles>3</nbFiles>
  <results>
    <result file="/file1.json"/>
    <result file="/file2.properties"/>
    <result file="/file3.rjs"/>
  </results>
</LRMProjectInspectResults>

In addition, file project_inspect_files.txt is created listing all of the absolute paths of the corresponding target files for each base resource file. The following is an example where:

  • The group name is GroupName
  • The project name is YourProjectName
  • The top level source directory defined in the project definition is location/of/files/resources
  • In the project definition, extension json has a name of pattern of *.l_c_v. The default locale files for this extension does not use the name pattern. There is no location pattern.
  • In the project definition, extension properties has a name of pattern of *_l_c_v. The default locale files for this extension does not use the name pattern. There is no location pattern.
  • In the project definition, extension rjs has a name of pattern of *-l-c-v. The default locale files for this extension does not use the name pattern. There is no location pattern.
/var/lib/jenkins/jobs/GroupName.YourProjectName/workspace/location/of/files/resources/file1.fr_fr.json
/var/lib/jenkins/jobs/GroupName.YourProjectName/workspace/location/of/files/resources/file1.es_mx.json
/var/lib/jenkins/jobs/GroupName.YourProjectName/workspace/location/of/files/resources/file2_fr_fr.properties
/var/lib/jenkins/jobs/GroupName.YourProjectName/workspace/location/of/files/resources/file2_es_mx.properties
/var/lib/jenkins/jobs/GroupName.YourProjectName/workspace/location/of/files/resources/file3-fr-fr.rjs
/var/lib/jenkins/jobs/GroupName.YourProjectName/workspace/location/of/files/resources/file3-es-mx.rjs

You may need to edit your project definition. See 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)?

This is a pretty common error and generally easy to fix. Your project may not setup correctly. Check the Project Definition File used to create the project or open the Jenkins job Configuration. This error may also occur if you are using transforms. If that is the case, this may not be a problem and check if transforms ran successfully and the Dashboard looks correct.

In Jenkins, open the job configuration and scroll down to Resource File Extensions.

Build2.png

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: 

> vi /var/lib/jenkins/Lingoport_Data/LRM/<group-name>/reports/<project-name>/ProjectDefinition.xml

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 Localyzer Project. For example if you have $WORKSPACE/resources or <top-level-dir>/var/lib/jenkins/jobs/CET.Smoke/workspace/resources</top-level-dir> but the resource files are in /var/lib/jenkins/jobs/CET.Smoke/workspace/locales, then Localyzer will not find the resource files.
<top-level-dir>/var/lib/jenkins/path/to/my/resource_files</top-level-dir>
  • 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 myResources_fr_CA.properties then set the following: 
      <file-name-pattern>*_l_c_v</file-name-pattern>
    • <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 myResources_en_US.properties 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 myResources.properties when creating files for translation.
      <use-location-pattern-on-dflt-locale>0</use-location-pattern-on-dflt-locale>
    • <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 files directory then the translated files will go into files-fr-FR for a french locale. If <use-location-on-dflt-locale>1</use-location-on-dflt-locale> or Use Location Pattern on Default Locale is checked (true), then the base resource files need to be in a folder that looks like files-en-US.
  • <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: 
    <include-dir>**/**</include-dir>
  • <exclude-dir-file>...</exclude-dir-file> or Exclude Directory Files - verify that the value is a valid Ant formatting directive and that you're not excluding valid files/folders. Format for <exclude-dir> is: 
    <exclude-dir-file>...</exclude-dir-file>

Why do I get an error "All active prep kits must be completed before changes can be made" when updating the Jenkins job?

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: 

ERROR 2019-06-20 20:55:07,128 com.lingoport.lrm.controller.kitrootconfig.pipeline.stage.CompareExistingLocalesWithXMLStage.addError: Error 230: Cannot delete locales for project `NewLRMProject`. All active prep kits must be completed before changes can be made.
Process failed. See error log in `/var/lib/jenkins/Lingoport_Data/LRM/<group-name>/logs/lrmerror.log` for details.

Once all outstanding prep kits have returned, then things can be modified in the job.

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

Android resource files are often called 'strings.xml' and exist in many 'values' directories. On boarding this type of project can be slightly different than other resource file types. Your resource files may look like: 

.../memories/src/main/res/values/strings.xml
.../shared/src/main/res/values/strings.xml 
.../family/src/main/res/values/strings.xml

Since we have the same filename in several directories, Send Unique Filenames should be selected so that all the resource files are sent in one kit and not several of them.

ResourceFileExtensionXml.png

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

IncludeDirXml.png

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.

Save and Build Now the new project.

AndroidStringsDashboard.png

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 on board an IOS project with .strings resource files

Resource files for IOS projects often look like .../en.lproj/<filename>.strings or .../en_US.lproj/<filename>.strings.

To on board a .strings project, create a new project. Set up the repository, branch, and the locales to be translated.

ResourceFileExtensionStrings.png

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.

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 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.

If you'd rather use the command line instead of the Jenkins ManageLicenses job, for instance in a script, use the --create-group command on lrm-cli.jar command line. Using the command line is not recommende. The ManageLicenses Jenkins job is more reliable. You need to have requested a license key for the new group from Lingoport before creating the group. For instance: 

 > java -jar $LRM_HOME/lrm-cli.jar --create-group --group-name group1 --date "2016-06-01" --number-of-licenses 10 --license-key <license-key>

To update the license of an existing group, used the --update-license command on lrm-cli.jar command line. You need to have requested a license key for the new group from Lingoport before updating the group.For instance: 

 > java -jar $LRM_HOME/lrm-cli.jar --update-license --group-name group1 --date "2016-06-01" -number-of-licenses 10 --license-key <license-key>

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 Localyzer 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 :)

Retrieved from "http://wiki.lingoport.com/index.php?title=Localyzer_Projects&oldid=96577"