Difference between revisions of "LRM How do I"

From Lingoport Wiki
Jump to: navigation, search
(→‎How do I configure a LRM project?)
 
(35 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  +
= Custom Tasks =
−
= I have clicked on Prep Kit but I don't want this kit to be translated any more. How do I deactivate the kit? =
  
  +
== How do I setup AtTask (WorkFront) in order to create an AtTask project for each prep kit? ==
  +
AtTask is set-up using 'CustomTasks'. See [[Custom Tasks]] for details.
  +
  +
= Emails =
  +
== How do I setup the email configuration in order to send status emails? ==
  +
The email configuration file, ''config_email_global.xml'' is located in the ../L10nStreamlining/config folder. See [[Sending_Emails| Sending Emails]] for details.
  +
  +
= L10n Vendors =
  +
== How do I setup my project's translation vendor? ==
  +
The translation vendor is defined through the ''config_l10n_vendor.properties'' configuration file and is located in a '''L10nStreamlining''' config folder.
  +
This file can be located at the project, group or global level. For example, if all of your projects will be sent to the same vendor then the configuration file can be located at the group or global level.
  +
  +
See [[L10n_Vendors| Translation Vendors]] for more information.
  +
  +
=== How do I setup an InContext Server for my project's translation vendor? ===
  +
See [[L10n_Vendors#InContext_Server_Configuration|InContext Server Configuration]] for more information.
  +
  +
== FTP ==
  +
  +
=== How do I setup a proxy for a project's FTP server with SSH protocol? ===
  +
A proxy is set up through java options. See [[L10n_Vendors#SSH.2FSFTP_proxy_server| L10n Vendor Proxy Server]] for details.
  +
  +
=== How do I create the SSH keys? ===
  +
  +
See http://www.linuxproblem.org/art_9.html.
  +
  +
=== How do I hide the password ===
  +
Use a '''.netrc''' file, The .netrc file is located in the $HOME directory.
  +
  +
Example of a .netrc:
  +
  +
<pre>
  +
machine ftp.company.net
  +
login username
  +
password myPassword
  +
</pre>
  +
  +
Then <code>ftp ftp.company.net</code> will use the login and username in the .netrc file to connect and the username password are not visible.
  +
  +
= Prep Kit =
  +
== I have clicked on Prep Kit but I don't want this kit to be translated any more. How do I deactivate the kit? ==
 
When you have pressed the Prep Kit button, a number of steps were taken. In particular, a prep kit was created, the database was updated, and the files were sent to the configured translation end point.
 
When you have pressed the Prep Kit button, a number of steps were taken. In particular, a prep kit was created, the database was updated, and the files were sent to the configured translation end point.
 
* Open a command prompt
  
* Open a command prompt
Line 7: Line 48:
 
* Check the Dashboard to make sure you do not see the prep kit version you deactivated in the outstanding kits
  
* Check the Dashboard to make sure you do not see the prep kit version you deactivated in the outstanding kits
 
* Notify (email, phone, etc.) the responsible party in charge of translation this job is not needed any longer and has been deactivated in the Lingoport system.
  
* Notify (email, phone, etc.) the responsible party in charge of translation this job is not needed any longer and has been deactivated in the Lingoport system.
  +
−
= How do I setup AtTask (WorkFront) in order to create an AtTask project for each prep kit? =
  
  +
== I always want to send full files rather than deltas to my vendor. How do I set this up? ==
−
AtTask is set-up using 'CustomTasks'. See [[Custom Tasks]] for details.
  
  +
By default, LRM sends out deltas in a prep kit unless there is a missing file.
  +
This setting, <code>prep.kit.changes.only</code>, is located in configuration file <code>config_lrm_info.properties</code> which resides in the ''../L10nStreamlining/&lt;groupname&gt;/config'' folder.
  +
  +
The possible values are:
  +
* 0 - prep files are for full-file
  +
* 1 - prep files can be for changes-only
  +
  +
= Project Definition =
  +
=== How do I configure a LRM project? ===
  +
See [[Supported_Resource_Bundles#Lingoport_Resource_Manager_Configuration|Project Definition]] for information about configuring a LRM project.
  +
  +
= Reports =
  +
=== How do I send reports to a different location? ===
  +
Use option ''-f &lt;report path&gt;'' to send the report to a different report location. See [[LRM_Commands_Reference#Create_reports|Create Reports]] for additional information.
  +
  +
= How do I call an LRM job remotely? =
  +
=== Calling from Remote / cURL ===
  +
One possible way to call a Jenkins job remotely is to use cURL. For instance,
  +
  +
curl "<JENKINS_URL>/view/Infrastructure/job/LRMCriticalErrors/buildWithParameters?token=LGCRITICAL&SRC_PROJECT=CET.Smoke&BRANCH_NAME=MysterO"
  +
  +
will invoke the 'LRMCriticalErrors', a job that checks for critical errors on resource files handled by an LRM project, here 'CET.Smoke', for a given branch, here 'MysterO'.
  +
  +
If you want to get the console output, use the following command after the previous one:
  +
  +
curl -X POST "<JENKINS_URL>/view/Infrastructure/job/LRMCriticalErrors/lastBuild/consoleText"
  +
  +
  +
To be called remotely, a Jenkins job must be configured with a token for the 'Build Trigger Remotely' build trigger, like LGCRITICAL for LRMCriticalErrors.
  +
  +
=== Calling from Remote / LingoBot CLI ===
  +
LingoBot can be set up to be invoked either from a collaborative environment, such as Slack, or from a command line using lingobot-cli.jar.
  +
  +
Some infrastructure Jenkins jobs can be invoked that way. (See java -jar lingobot-cli.jar). For instance, to check for LRM resource files critical errors, the same job as for the cURL invocation above, use this command
  +
  +
java -jar lingobot-cli.jar "show errors" "CET.Smoke:MysterO"

Latest revision as of 18:50, 3 June 2019

Custom Tasks

How do I setup AtTask (WorkFront) in order to create an AtTask project for each prep kit?

AtTask is set-up using 'CustomTasks'. See Custom Tasks for details.

Emails

How do I setup the email configuration in order to send status emails?

The email configuration file, config_email_global.xml is located in the ../L10nStreamlining/config folder. See Sending Emails for details.

L10n Vendors

How do I setup my project's translation vendor?

The translation vendor is defined through the config_l10n_vendor.properties configuration file and is located in a L10nStreamlining config folder. This file can be located at the project, group or global level. For example, if all of your projects will be sent to the same vendor then the configuration file can be located at the group or global level.

See Translation Vendors for more information.

How do I setup an InContext Server for my project's translation vendor?

See InContext Server Configuration for more information.

FTP

How do I setup a proxy for a project's FTP server with SSH protocol?

A proxy is set up through java options. See L10n Vendor Proxy Server for details.

How do I create the SSH keys?

See http://www.linuxproblem.org/art_9.html.

How do I hide the password

Use a .netrc file, The .netrc file is located in the $HOME directory.

Example of a .netrc: 

machine ftp.company.net
login username
password myPassword

Then ftp ftp.company.net will use the login and username in the .netrc file to connect and the username password are not visible.

Prep Kit

I have clicked on Prep Kit but I don't want this kit to be translated any more. How do I deactivate the kit?

When you have pressed the Prep Kit button, a number of steps were taken. In particular, a prep kit was created, the database was updated, and the files were sent to the configured translation end point.

  • Open a command prompt
  • Use the 'deactivate' command for this project and this version of the kit
  • Go to the staging/sendkits/<group_name>/<project_name> and if the prep kit you want to deactivate is still there, remove those files.
  • Run the Automation job
  • Check the Dashboard to make sure you do not see the prep kit version you deactivated in the outstanding kits
  • Notify (email, phone, etc.) the responsible party in charge of translation this job is not needed any longer and has been deactivated in the Lingoport system.

I always want to send full files rather than deltas to my vendor. How do I set this up?

By default, LRM sends out deltas in a prep kit unless there is a missing file. This setting, prep.kit.changes.only, is located in configuration file config_lrm_info.properties which resides in the ../L10nStreamlining/<groupname>/config folder.

The possible values are:

  • 0 - prep files are for full-file
  • 1 - prep files can be for changes-only

Project Definition

How do I configure a LRM project?

See Project Definition for information about configuring a LRM project.

Reports

How do I send reports to a different location?

Use option -f <report path> to send the report to a different report location. See Create Reports for additional information.

How do I call an LRM job remotely?

Calling from Remote / cURL

One possible way to call a Jenkins job remotely is to use cURL. For instance, 

 curl "<JENKINS_URL>/view/Infrastructure/job/LRMCriticalErrors/buildWithParameters?token=LGCRITICAL&SRC_PROJECT=CET.Smoke&BRANCH_NAME=MysterO"

will invoke the 'LRMCriticalErrors', a job that checks for critical errors on resource files handled by an LRM project, here 'CET.Smoke', for a given branch, here 'MysterO'.

If you want to get the console output, use the following command after the previous one: 

 curl -X POST  "<JENKINS_URL>/view/Infrastructure/job/LRMCriticalErrors/lastBuild/consoleText"


To be called remotely, a Jenkins job must be configured with a token for the 'Build Trigger Remotely' build trigger, like LGCRITICAL for LRMCriticalErrors.

Calling from Remote / LingoBot CLI

LingoBot can be set up to be invoked either from a collaborative environment, such as Slack, or from a command line using lingobot-cli.jar.

Some infrastructure Jenkins jobs can be invoked that way. (See java -jar lingobot-cli.jar). For instance, to check for LRM resource files critical errors, the same job as for the cURL invocation above, use this command 

 java -jar lingobot-cli.jar "show errors" "CET.Smoke:MysterO"
Retrieved from "http://wiki.lingoport.com/index.php?title=LRM_How_do_I&oldid=93054"