Difference between revisions of "Dashboard Users Guide"

From Lingoport Wiki
Jump to: navigation, search
(About Lingoport Dashboard)
(Simple Startup)
(26 intermediate revisions by 2 users not shown)
Line 7: Line 7:
 
[http://lingoport.com/software-internationalization-products/ Lingoport Suite].
 
[http://lingoport.com/software-internationalization-products/ Lingoport Suite].
   
[[File:LingoportDashboard.jpg|center|600px]]
+
[[File:LingoportDashboard.jpg|center|850px]]
   
 
== When to Update the Dashboard Server ==
 
== When to Update the Dashboard Server ==
 
You will need to re-run the Lingoport Dashboard Server Installer whenever you upgrade to a later version of the Dashboard. Be sure to retain your current Dashboard database by unchecking the '''Install LINGODASH Database Data''' checkbox.
 
You will need to re-run the Lingoport Dashboard Server Installer whenever you upgrade to a later version of the Dashboard. Be sure to retain your current Dashboard database by unchecking the '''Install LINGODASH Database Data''' checkbox.
  +
  +
For more details, see [[Dashboard_Installation#Updating_Your_Existing_Installation|Updating Your Existing Installation]].
   
 
== When to Update the Dashboard Client ==
 
== When to Update the Dashboard Client ==
Line 16: Line 18:
 
You will need to re-run the Lingoport Dashboard Client Installer whenever you:
 
You will need to re-run the Lingoport Dashboard Client Installer whenever you:
 
<ul type="disk">
 
<ul type="disk">
<li> Set up a new or updated connection to Globalyzer</li>
+
<li> Set up a new or updated version of Globalyzer</li>
<li>Set up a new or updated connection to Lingoport Resource Manager (LRM)</li>
+
<li>Set up a new or updated version of Lingoport Resource Manager (LRM)</li>
 
<li>Upgrade to a later version of the Lingoport Dashboard Client</li>
 
<li>Upgrade to a later version of the Lingoport Dashboard Client</li>
 
</ul>
 
</ul>
Line 23: Line 25:
 
= Starting the Dashboard Server =
 
= Starting the Dashboard Server =
 
== Simple Startup ==
 
== Simple Startup ==
  +
<ol start="1">
  +
<li>On the system where the Lingoport Dashboard Server was installed, go to the directory <code><server install directory>/bin</code>.</li>
  +
> cd /var/lib/jenkins/lingoport/dashboard-server-x.y.z/bin/
  +
<li>Choose your platform directory and then run <code>sonar.sh start</code>. To make sure that it started, check the status <code>sonar.sh status</code>.</li>
  +
> cd linux-x86-64
  +
> ./sonar.sh start
  +
> ./sonar.sh status
  +
<li>Give it a few minutes and then open a browser and enter '''<nowiki>http://localhost</nowiki>''' to see the Dashboard. If you installed with a port such as 9000, use that port after localhost (<nowiki>http://localhost:9000</nowiki>). </li>
  +
<li>If the browser comes up in maintenance mode, the database may need to be upgraded. Enter '''<nowiki>http://localhost/setup</nowiki>''' and follow the directions on the page.
  +
</ol>
  +
 
== Starting as a Service ==
 
== Starting as a Service ==
  +
  +
To run the Sonar process as a service, follow the instructions at [http://docs.sonarqube.org/display/SONARQUBE52/Running+SonarQube+as+a+Service+on+Linux SonarQube].
  +
 
== Viewing the Lingoport Dashboard ==
 
== Viewing the Lingoport Dashboard ==
  +
<ol>
  +
<li>On your local system, open a browser and enter the host name and port number of the Lingoport Dashboard Server. For example:
  +
  +
<nowiki>http://company.net/</nowiki> </li>
  +
<li>Click the '''Help on Lingoport Dashboard''' link at the bottom of the page to learn more about the Lingoport Dashboard features. </li>
  +
<li>Read the [http://www.sonarqube.org/sonarqube-5-6-lts-in-screenshots/ SonarQube introduction] to learn about the capabilities of the SonarQube framework. </li>
  +
<li>For administration features, click LOG IN in the menu bar and enter:
  +
<br>
  +
Login: admin<br>
  +
Password: admin<br>
  +
  +
Be sure to change the password.
  +
  +
As the Administrator, you will be able to adjust the dashboard configuration, as well as add Users and Groups to fine tune access to your Lingoport Dashboard Projects.</li>
  +
</ol>
   
 
= Uploading Project Data to the Lingoport Dashboard =
 
= Uploading Project Data to the Lingoport Dashboard =
Line 35: Line 66:
 
= Changing Project Configuration =
 
= Changing Project Configuration =
 
== sonar-project.properties ==
 
== sonar-project.properties ==
== MySQL Packet Error
+
== MySQL Packet Error ==
  +
A communication packet is a single SQL statement sent to the MySQL server, a single row that is sent to the client, or a binary log event sent from a master replication server to a slave.
  +
  +
The largest possible packet that can be transmitted to or from a MySQL 5.7 server or client is 1GB.
  +
  +
When a MySQL client or the mysqld server receives a packet bigger than max_allowed_packet bytes, it issues an ER_NET_PACKET_TOO_LARGE error and closes the connection. With some clients, you may also get a Lost connection to MySQL server during query error if the communication packet is too large.
  +
  +
Both the client and the server have their own max_allowed_packet variable, so if you want to handle big packets, you must increase this variable both in the client and in the server.
  +
  +
To resolve this issue, please see the steps below:
  +
  +
Set <code>max_allowed_packet</code> in the <code>/etc/my.cnf</code> file. For example, to set the size for the server to 16MB, add the following lines in an option file:
  +
  +
<pre>
  +
[mysqld]
  +
max_allowed_packet = 16M
  +
</pre>
  +
  +
Stop the service, typically with:
  +
<pre> > sudo service mysqld stop </pre>
  +
  +
verify it's stopped and restart it:
  +
<pre>
  +
> sudo service mysqld status
  +
> sudo service mysqld start
  +
</pre>
  +
  +
To verify the packet size allowed has been modified, in MySQL do :
  +
<pre>
  +
mysql> show variables like 'max_allowed_packet';
  +
</pre>
  +
  +
https://dev.mysql.com/doc/refman/5.7/en/packet-too-large.html
  +
  +
Finally, restart sonar so that it picks up the MySQL change:
  +
<pre>
  +
jenkins: > sonar.sh stop
  +
Stopping SonarQube...
  +
Waiting for SonarQube to exit...
  +
Stopped SonarQube.
  +
  +
jenkins: > sonar.sh start
  +
Starting SonarQube...
  +
Started SonarQube.
  +
</pre>

Revision as of 22:04, 23 July 2018

Introduction

About Lingoport Dashboard

The Lingoport Dashboard, built on the SonarQube platform, helps you track and share the progress of your internationalization and localization efforts company-wide, by displaying both high-level and detailed views of your Globalyzer Project Scan data and your Lingoport Resource Manager status information.

For more details about Globalyzer and Lingoport Resource Manager please visit: Lingoport Suite.

LingoportDashboard.jpg

When to Update the Dashboard Server

You will need to re-run the Lingoport Dashboard Server Installer whenever you upgrade to a later version of the Dashboard. Be sure to retain your current Dashboard database by unchecking the Install LINGODASH Database Data checkbox.

For more details, see Updating Your Existing Installation.

When to Update the Dashboard Client

You will need to re-run the Lingoport Dashboard Client Installer whenever you:

  • Set up a new or updated version of Globalyzer
  • Set up a new or updated version of Lingoport Resource Manager (LRM)
  • Upgrade to a later version of the Lingoport Dashboard Client

Starting the Dashboard Server

Simple Startup

  1. On the system where the Lingoport Dashboard Server was installed, go to the directory <server install directory>/bin.
  2. > cd /var/lib/jenkins/lingoport/dashboard-server-x.y.z/bin/
    
  3. Choose your platform directory and then run sonar.sh start. To make sure that it started, check the status sonar.sh status.
  4. > cd linux-x86-64
    > ./sonar.sh start
    > ./sonar.sh status
    
  5. Give it a few minutes and then open a browser and enter http://localhost to see the Dashboard. If you installed with a port such as 9000, use that port after localhost (http://localhost:9000).
  6. If the browser comes up in maintenance mode, the database may need to be upgraded. Enter http://localhost/setup and follow the directions on the page.

Starting as a Service

To run the Sonar process as a service, follow the instructions at SonarQube.

Viewing the Lingoport Dashboard

  1. On your local system, open a browser and enter the host name and port number of the Lingoport Dashboard Server. For example: http://company.net/
  2. Click the Help on Lingoport Dashboard link at the bottom of the page to learn more about the Lingoport Dashboard features.
  3. Read the SonarQube introduction to learn about the capabilities of the SonarQube framework.
  4. For administration features, click LOG IN in the menu bar and enter:
    Login: admin
    Password: admin
    Be sure to change the password. As the Administrator, you will be able to adjust the dashboard configuration, as well as add Users and Groups to fine tune access to your Lingoport Dashboard Projects.

Uploading Project Data to the Lingoport Dashboard

Generate Globalyzer Scan Report

Generate LRM Status Report

Upload Globalyzer and LRM Data to Dashboard

Removing an Uploaded Lingoport Dashboard Project

Changing Project Configuration

sonar-project.properties

MySQL Packet Error

A communication packet is a single SQL statement sent to the MySQL server, a single row that is sent to the client, or a binary log event sent from a master replication server to a slave.

The largest possible packet that can be transmitted to or from a MySQL 5.7 server or client is 1GB.

When a MySQL client or the mysqld server receives a packet bigger than max_allowed_packet bytes, it issues an ER_NET_PACKET_TOO_LARGE error and closes the connection. With some clients, you may also get a Lost connection to MySQL server during query error if the communication packet is too large.

Both the client and the server have their own max_allowed_packet variable, so if you want to handle big packets, you must increase this variable both in the client and in the server.

To resolve this issue, please see the steps below:

Set max_allowed_packet in the /etc/my.cnf file. For example, to set the size for the server to 16MB, add the following lines in an option file:

[mysqld]
max_allowed_packet = 16M

Stop the service, typically with:

 > sudo service mysqld stop 

verify it's stopped and restart it:

> sudo service mysqld status
> sudo service mysqld start

To verify the packet size allowed has been modified, in MySQL do :

mysql> show variables like 'max_allowed_packet';

https://dev.mysql.com/doc/refman/5.7/en/packet-too-large.html

Finally, restart sonar so that it picks up the MySQL change:

jenkins: > sonar.sh stop
Stopping SonarQube...
Waiting for SonarQube to exit...
Stopped SonarQube.

jenkins: > sonar.sh start
Starting SonarQube...
Started SonarQube.