LingoBot CLI - Revision history

Rdaly at 20:19, 17 August 2018

2018-08-17T20:19:16Z

← Older revision		Revision as of 20:19, 17 August 2018
Line 1:		Line 1:
	=Overview=		=Overview=
	Lingobot CLI (Command Line Interface) is an extension of Lingobot that allows similar commands to be processed without the use of a collaboration utility like Slack or Flowdock. The commands can be run directly from a command line, or can be launched with user-friendly prompts from an IDE (integrated development environment) like Eclipse. In either case, they allow developers direct access to some of the many powerful Lingoport i18n features.		Lingobot CLI (Command Line Interface) is an extension of Lingobot that allows similar commands to be processed without the use of a collaboration utility like Slack or Flowdock. The commands can be run directly from a command line, or can be launched with user-friendly prompts from an IDE (integrated development environment) like Eclipse. In either case, they allow developers direct access to some of the many powerful Lingoport i18n features.

			Lingobot CLI is configured on the Continuous Globalyzer Server, but then it is deployed as a client to developers for use in various IDEs.

	=Getting Started=		=Getting Started=

	== Checking the Configuration ==		== Checking the Configuration at the Server ==
	Lingobot CLI is installed and configured when the Lingobot is installed. If the lingobot service is not running on the ~~globalization server~~, then the Lingobot CLI cannot be used. To check if the service is running, run the following as a user with root access:		Lingobot CLI is installed and configured when the Lingobot is installed. If the lingobot service is not running on the Continuous G11n Server, then the Lingobot CLI cannot be used. To check if the service is running, run the following as a user with root access:

	sudo systemctl status lingoport-lingobot.service		sudo systemctl status lingoport-lingobot.service
Line 22:		Line 24:
	* The <code>lingobot_api_token</code> is a token created during the installation. This will probably never change.		* The <code>lingobot_api_token</code> is a token created during the installation. This will probably never change.

	== Verifying the ~~functionality~~ ==		== Verifying the Functionality from the Server ==
	If the Lingobot service is running, from the ~~globalization server~~, one can verify the lingobot-cli functionality.		If the Lingobot service is running, from the Continuous G11n Server, one can verify the lingobot-cli functionality.

	> cd /var/lib/jenkins/lingoport/lingobot-cli-<x.y.z>		> cd /var/lib/jenkins/lingoport/lingobot-cli-<x.y.z>
Line 140:		Line 142:

	=Client Install Preparation=		=Client Install Preparation=
	The Lingobot installation creates a zip file in the <code>/var/lib/jenkins/lingoport</code> directory containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse, IntelliJ and Visual Studio IDEs. The zip file contains an '''app.properties''' file that should be populated with the correct information, which are the same values as the file on the ~~globalization server~~. If the server has been installed with the Stack Installer and configured, these values should have been automatically filled in correctly.		The Lingobot installation creates a zip file in the <code>/var/lib/jenkins/lingoport</code> directory containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse, IntelliJ and Visual Studio IDEs. The zip file contains an '''app.properties''' file that should be populated with the correct information, which are the same values as the file on the Continuous G11n Server. If the server has been installed with the Stack Installer and configured, these values should have been automatically filled in correctly.

	In addition to the app.properties settings mentioned above, it may be helpful to update the README.md file with any custom information that may be helpful to developers.		In addition to the app.properties settings mentioned above, it may be helpful to update the README.md file with any custom information that may be helpful to developers.

Rdaly: /* Client Install Distribution */

2018-08-17T17:57:26Z

Client Install Distribution

← Older revision		Revision as of 17:57, 17 August 2018
Line 145:		Line 145:

	=Client Install Distribution=		=Client Install Distribution=
	Make the lingobot-cli-<x.y.z>.zip available to developers as desired. This is often done through the System Administrator, and may involved distributing the zip file through the company's own website or software distribution portal.		Make the '''<code>lingobot-cli-<x.y.z>.zip</code>''' available to developers as desired. This is often done through the System Administrator, and may involved distributing the zip file through the company's own website or software distribution portal.

Rdaly: /* Client Install Distribution */

2018-08-17T17:57:01Z

Client Install Distribution

← Older revision		Revision as of 17:57, 17 August 2018
Line 145:		Line 145:

	=Client Install Distribution=		=Client Install Distribution=
	~~It's recommended that Lingoport customers re~~-zip ~~the client install and make it~~ available to ~~their own~~ developers as desired. This is often done through the System Administrator, and may involved distributing the ~~necessary~~ file through the company's own website or software distribution portal.		Make the lingobot-cli-<x.y.z>.zip available to developers as desired. This is often done through the System Administrator, and may involved distributing the zip file through the company's own website or software distribution portal.

Rdaly: /* Client Install Preparation */

2018-08-17T17:47:59Z

Client Install Preparation

← Older revision		Revision as of 17:47, 17 August 2018
Line 140:		Line 140:

	=Client Install Preparation=		=Client Install Preparation=
	The Lingobot installation creates a zip file in the <code>/var/lib/jenkins/lingoport</code> directory containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse, IntelliJ and Visual Studio IDEs. The zip file contains an '''app.properties''' file that should be populated with the correct information, which are the same values as the file on the globalization server. If the server has been installed with the Stack Installer, these values should have been automatically filled in correctly.		The Lingobot installation creates a zip file in the <code>/var/lib/jenkins/lingoport</code> directory containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse, IntelliJ and Visual Studio IDEs. The zip file contains an '''app.properties''' file that should be populated with the correct information, which are the same values as the file on the globalization server. If the server has been installed with the Stack Installer and configured, these values should have been automatically filled in correctly.

	In addition to the app.properties settings mentioned above, it may be helpful to update the README.md file with any custom information that may be helpful to developers.		In addition to the app.properties settings mentioned above, it may be helpful to update the README.md file with any custom information that may be helpful to developers.

Rdaly: /* Client Install Preparation */

2018-08-17T17:47:07Z

Client Install Preparation

← Older revision		Revision as of 17:47, 17 August 2018
Line 140:		Line 140:

	=Client Install Preparation=		=Client Install Preparation=
	The Lingobot installation creates a zip file in the <code>/var/lib/jenkins/lingoport</code> containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse, IntelliJ and Visual Studio IDEs. The zip file contains an '''app.properties''' file that should be populated with the correct information, which are the same values as the file on the globalization server. If the server has been installed with the Stack Installer, these values should have been automatically filled in correctly.		The Lingobot installation creates a zip file in the <code>/var/lib/jenkins/lingoport</code> directory containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse, IntelliJ and Visual Studio IDEs. The zip file contains an '''app.properties''' file that should be populated with the correct information, which are the same values as the file on the globalization server. If the server has been installed with the Stack Installer, these values should have been automatically filled in correctly.

	In addition to the app.properties settings mentioned above, it may be helpful to update the README.md file with any custom information that may be helpful to developers.		In addition to the app.properties settings mentioned above, it may be helpful to update the README.md file with any custom information that may be helpful to developers.

Rdaly: /* Client Install Preparation */

2018-08-17T17:46:37Z

Client Install Preparation

← Older revision		Revision as of 17:46, 17 August 2018
Line 140:		Line 140:

	=Client Install Preparation=		=Client Install Preparation=
	The Lingobot installation creates a zip file in the <code>/var/lib/jenkins/lingoport</~~directory~~> containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse, IntelliJ and Visual Studio IDEs. The zip file contains an '''app.properties''' file that should be populated with the correct information, which are the same values as the file on the globalization server. If the server has been installed with the Stack Installer, these values should have been automatically filled in correctly.		The Lingobot installation creates a zip file in the <code>/var/lib/jenkins/lingoport</code> containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse, IntelliJ and Visual Studio IDEs. The zip file contains an '''app.properties''' file that should be populated with the correct information, which are the same values as the file on the globalization server. If the server has been installed with the Stack Installer, these values should have been automatically filled in correctly.

	In addition to the app.properties settings mentioned above, it may be helpful to update the README.md file with any custom information that may be helpful to developers.		In addition to the app.properties settings mentioned above, it may be helpful to update the README.md file with any custom information that may be helpful to developers.

Rdaly: /* Client Install Preparation */

2018-08-17T17:46:20Z

Client Install Preparation

← Older revision		Revision as of 17:46, 17 August 2018
Line 140:		Line 140:

	=Client Install Preparation=		=Client Install Preparation=
	The Lingobot installation creates a zip file containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse, IntelliJ and Visual Studio IDEs. The zip file contains an '''app.properties''' file that should be populated with the correct information, which are the same values as the file on the globalization server. If the server has been installed with the Stack Installer, these values should have been automatically filled in correctly.		The Lingobot installation creates a zip file in the <code>/var/lib/jenkins/lingoport</directory> containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse, IntelliJ and Visual Studio IDEs. The zip file contains an '''app.properties''' file that should be populated with the correct information, which are the same values as the file on the globalization server. If the server has been installed with the Stack Installer, these values should have been automatically filled in correctly.

	In addition to the app.properties settings mentioned above, it may be helpful to update the README.md file with any custom information that may be helpful to developers.		In addition to the app.properties settings mentioned above, it may be helpful to update the README.md file with any custom information that may be helpful to developers.

Rdaly: /* Client Install Preparation */

2018-08-17T17:45:33Z

Client Install Preparation

← Older revision		Revision as of 17:45, 17 August 2018
Line 140:		Line 140:

	=Client Install Preparation=		=Client Install Preparation=
	The Lingobot installation creates a zip file containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse, IntelliJ and Visual Studio IDEs. The zip file contains an '''app.properties''' file that should be populated with the correct information. If the ~~machine~~ has been installed with the Stack Installer, these values should have been automatically filled in correctly.		The Lingobot installation creates a zip file containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse, IntelliJ and Visual Studio IDEs. The zip file contains an '''app.properties''' file that should be populated with the correct information, which are the same values as the file on the globalization server. If the server has been installed with the Stack Installer, these values should have been automatically filled in correctly.

	~~<pre>~~		In addition to the app.properties settings mentioned above, it may be helpful to update the README.md file with any custom information that may be helpful to developers.
	~~lingobot_domain=http://ec2-35-168-158-45.compute-1.amazonaws.com~~
	~~lingobot_port=5001~~
	~~lingobot_api_token=ZDIwY2IyMWU4M2RlNDhhZjIxZjY0Y2NhODdh~~
	~~</pre>~~

	~~==lingobot_domain==~~
	~~This value should be updated with the URL of the Lingobot server to be called.~~

	~~==lingobot_port==~~
	This value should be updated for the Port at which Lingobot server is to be called. Normally this will be 5001, unless it has been changed from that default value in lingobot_config.sh (Port property).

	~~==lingobot_api_token==~~
	This value should be set to the same value as LINGOBOT_API_TOKEN in the Server Setup section above. The values must be synchronized to the same value or the client commands reaching the server will be rejected.

	In addition to the app.properties settings mentioned above, it may be helpful to update the ~~ReadMe~~ file with any custom information that may be helpful to developers.

	=Client Install Distribution=		=Client Install Distribution=
	It's recommended that Lingoport customers re-zip the client install and make it available to their own developers as desired. This is often done through the System Administrator, and may involved distributing the necessary file through the company's own website or software distribution portal.		It's recommended that Lingoport customers re-zip the client install and make it available to their own developers as desired. This is often done through the System Administrator, and may involved distributing the necessary file through the company's own website or software distribution portal.

Rdaly: /* Client Install Preparation */

2018-08-17T17:43:22Z

Client Install Preparation

← Older revision		Revision as of 17:43, 17 August 2018
Line 140:		Line 140:

	=Client Install Preparation=		=Client Install Preparation=
	The Lingobot installation ~~includes~~ a zip file containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse ~~IDE~~. ~~However, the following values should be updated in the~~ '''app.properties''' ~~(<code>/var/lib/jenkins/lingoport/lingobot-cli-x.y.z/app.properties</code>)~~ file of the ~~zip file before it is distributed to developers~~. If the machine has been installed with the Stack Installer, these values should have been automatically filled in correctly.		The Lingobot installation creates a zip file containing the files needed to run Lingobot CLI from a client machine, and integrate the calls into the Eclipse, IntelliJ and Visual Studio IDEs. The zip file contains an '''app.properties''' file that should be populated with the correct information. If the machine has been installed with the Stack Installer, these values should have been automatically filled in correctly.

	<pre>		<pre>

Rdaly: /* Settings */

2018-08-17T17:36:34Z

Settings

← Older revision		Revision as of 17:36, 17 August 2018
Line 125:		Line 125:
	If the first digit is 0, it will check the timeout value immediately. If you don't wish the system to check the status, set the first value to zero.		If the first digit is 0, it will check the timeout value immediately. If you don't wish the system to check the status, set the first value to zero.

	~~<code>~~		export LINGOBOT_API_STATUS_INTERVAL_SECONDS_ARRAY=0,10,20,30
	export LINGOBOT_API_STATUS_INTERVAL_SECONDS_ARRAY=0,10,20,30
	~~</code>~~

	'''LINGOBOT_API_STATUS_TIMEOUT_MINUTES'''		'''LINGOBOT_API_STATUS_TIMEOUT_MINUTES'''
Line 133:		Line 131:
	This value defaults to 2 minutes if it is not set, and identifies how long JVM clients will continue to check with the server for completion before a timeout is reached. Since a single JVM may use 50mb or more of memory, keeping this value low helps manage memory on client machines, particularly when multiple commands may be issued in a short period of time. If it is set to zero, then the command will timeout immediately, giving back the command line to run other commands.		This value defaults to 2 minutes if it is not set, and identifies how long JVM clients will continue to check with the server for completion before a timeout is reached. Since a single JVM may use 50mb or more of memory, keeping this value low helps manage memory on client machines, particularly when multiple commands may be issued in a short period of time. If it is set to zero, then the command will timeout immediately, giving back the command line to run other commands.

	~~<code>~~		export LINGOBOT_API_STATUS_TIMEOUT_MINUTES=2
	export LINGOBOT_API_STATUS_TIMEOUT_MINUTES=2
	~~</code>~~

	'''LINGOBOT_API_STATUS_MINUTES_TO_KEEP_MAXIMUM'''		'''LINGOBOT_API_STATUS_MINUTES_TO_KEEP_MAXIMUM'''
Line 141:		Line 137:
	This value identifies the maximum number of minutes the server will remember the result of any particular command. The value default to 500; however, the retrieval and distribution to the client of a command result also eliminates the tracking of that command. Thus, it is rare that any particular command will be tracked this long.		This value identifies the maximum number of minutes the server will remember the result of any particular command. The value default to 500; however, the retrieval and distribution to the client of a command result also eliminates the tracking of that command. Thus, it is rare that any particular command will be tracked this long.

	export LINGOBOT_API_STATUS_MINUTES_TO_KEEP_MAXIMUM =		export LINGOBOT_API_STATUS_MINUTES_TO_KEEP_MAXIMUM =

	=Client Install Preparation=		=Client Install Preparation=