Difference between revisions of "Dashboard Users Guide"

From Lingoport Wiki
Jump to: navigation, search
(→‎Viewing the Lingoport Dashboard)
(→‎Hiding the Project)
 
(45 intermediate revisions by 4 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|850px]]
 +
[[File:Dashboard7.8.1_overview.PNG|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 reusing the database name
  +
  +
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 Localyzer </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 24: Line 26:
 
== Simple Startup ==
  
== Simple Startup ==
 
<ol start="1">
  
<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>
 +
<li>If your system was installed with the Stack Installer or Stack Updater, the Jenkins user will have an alias to check the Dashboard On the system where the Lingoport Dashboard Server was installed, try: </li>
  +
> sonar.sh status
  +
> sonar.sh start
  +
<li>If that does not work, 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>
  
<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
−
<li>Give it a few minutes and then open a browser and enter '''<nowiki>http://localhost:9000</nowiki>''' to see the Dashboard. If you installed with a port other than 9000, use that port instead. </li>
  
  +
> ./sonar.sh start
−
<li>If the browser comes up in maintenance mode, the database may need to be upgraded. Enter '''<nowiki>http://localhost:9000/setup</nowiki>''' and follow the directions on the page.
 
  +
> ./sonar.sh status
  +
<li>Give it a few minutes and then open a browser and enter '''<nowiki>http://localhost</nowiki>''' or '''<nowiki>https://<system URL></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>''' or '''<nowiki>http://<system URL>/setup</nowiki>''' and follow the directions on the page.
 
</ol>
  
</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].
 +
To run the Sonar process as a service, follow the instructions at [https://docs.sonarqube.org/latest/setup/operate-server/ SonarQube].
   
 
== Viewing the Lingoport Dashboard ==
  
== Viewing the Lingoport Dashboard ==
Line 38: Line 47:
 
<li>On your local system, open a browser and enter the host name and port number of the Lingoport Dashboard Server. For example:
  
<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:9000/</nowiki> </li>
 +
<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>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>Read the [http://www.sonarqube.org/sonarqube-5-6-lts-in-screenshots/ SonarQube introduction] to learn about the capabilities of the SonarQube framework. </li>
Line 53: Line 62:
 
= Uploading Project Data to the Lingoport Dashboard =
 
= Uploading Project Data to the Lingoport Dashboard =
 
== Generate Globalyzer Scan Report ==
  
== Generate Globalyzer Scan Report ==
−
== Generate LRM Status Report ==
 +
== Generate Localyzer Status Report ==
−
== Upload Globalyzer and LRM Data to Dashboard ==
 +
== Upload Globalyzer and Localyzer Data to Dashboard ==
  +
  +
= Managing Project Visibility =
  +
  +
Projects may be managed so that they are visible only to a select list of users or groups.
  +
  +
General administration privileges are required to manage project visibility.
  +
  +
To manage project visibility, projects must first be set to Private. Then they may be set to have view permissions for specific users.
  +
  +
== Setting a project as private ==
  +
  +
Open the project.
  +
  +
Click on '''Administration''' for the Project, then '''Permissions'''.
  +
  +
  +
[[File:db_administer_project_permissions.png]]
  +
  +
  +
  +
Select '''Private''', so that the project is only shown to authorized users.
  +
  +
  +
[[File:db_project_private.png]]
  +
  +
== Managing individual project permissions ==
  +
  +
Once a project is Private, permissions may be restricted so that only specific users or groups may have visibility.
  +
  +
To do this for a single project, open the project, then go to '''Administration''' for the Project and '''Permissions''' in the pulldown.
  +
  +
[[File:db_administer_project_permissions.png]]
  +
  +
  +
  +
Ensure that '''Private''' is set, as it's required for the other permissions settings to take effect.
  +
  +
[[File:db_project_private.png]]
  +
  +
  +
Then, set permissions for users and groups as you find appropriate.
  +
  +
[[File:Db_project_permissions-a_group.png]]
  +
  +
== Managing multiple project permissions ==
  +
  +
To bulk manage project visibility, you must have general administer permission on the dashboard.
  +
  +
=== Projects Must first be set to Private ===
  +
  +
Projects must be Private for permissions to take effect. The Private setting is an individual project toggle, and bulk toggling of the private setting is not supported.
  +
  +
It is possible to set the default visibility of new projects, which will affect all projects that have not yet been created. You must be a global administrator to perform these steps. To do so:
  +
  +
First go to '''Administration''' in the black global bar. Then under the Administration heading, select '''Projects->Management'''.
  +
  +
[[File:Db_project_bulk_management_goto.png]]
  +
  +
Set the default visibility in the top right.
  +
  +
[[File:Db_project_permissions-default-visibility.png]]
  +
  +
=== Creating a permission template ===
  +
  +
Permissions templates can be used to set general permissions for a project. They may optionally affect projects based on their naming scheme.
  +
  +
To create a permissions template, you must be a general administrator.
  +
  +
Go to '''Administration''' in the black global bar then '''Security->Permission Templates'''
  +
  +
[[File:Db_project_permission_temaplates_go.png]]
  +
  +
Then click '''Create''' on the top right.
  +
  +
[[File:Db_project_permission_temaplates_view.png]]
  +
  +
In the first popup give the template a name. You may also optionally specify a regular expression for project targeting.
  +
  +
After creating a permission template, any newly created projects which match this regular expression will have the permission template applied to them.
  +
  +
You must manually apply the permission template to existing projects, it will not be applied automically, even if the name matches.
  +
  +
[[File:Db_project_permission_templates-create1.png]]
  +
  +
Set the permissions you would like for the appropriate users and groups.
  +
  +
[[File:Db_project_permission_templates-create2.png]]
  +
  +
=== Applying a permission template ===
  +
  +
First go to Administration[Global] at the black bar. Then under the Administration heading, select Projects->Management.
  +
  +
[[File:Db_project_bulk_management_goto.png]]
  +
  +
You will see a list of all projects, with up to 50 entries initially shown.
  +
  +
[[File:Db_project_bulk_management_list.png]]
  +
  +
Search and sort the projects as you find most appropriate, then select all that you wish to apply the permission template to.
  +
  +
[[File:Db_project_search_selected.png]]
  +
  +
Select 'Bulk Apply Permission Template', then select your permission template from the dropdown and click Apply.
  +
  +
[[File:Db_project_permission_templates-bulk-apply2.png]]
   
 
= Removing an Uploaded Lingoport Dashboard Project=
  
= Removing an Uploaded Lingoport Dashboard Project=
  +
  +
== Permanently Deleting a Project ==
  +
  +
Permanently deleting a project entirely removes it from the dashboard. While it may later be re-created, you will lose any historical data associated with the project.
  +
  +
To delete a project, you must have permissions to administer it.
  +
  +
With the project open, select '''Administration''' at the Project then '''Deletion'''.
  +
  +
[[File:Db_project_delete_admin_.png]]
  +
  +
You will be prompted for deletion. '''Confirm'''.
  +
  +
[[File:Db_project_delete_confirm.png]]
  +
  +
== Bulk project deletion ==
  +
  +
To bulk hide projects, you must have general administer permission on the dashboard.
  +
  +
To bulk delete projects, first go to '''Administration''' at the black global bar. Then under the Administration heading, select '''Projects->Management'''.
  +
  +
[[File:Db_project_bulk_management_goto.png]]
  +
  +
You will see a list of all projects, with up to 50 entries initially shown.
  +
  +
[[File:Db_project_bulk_management_list.png]]
  +
  +
Search and sort the projects as you find most appropriate, then select all that you wish to delete.
  +
  +
[[File:Db_project_search_selected.png]]
  +
  +
Select the red '''Delete''' option to the top right. Then '''confirm''' the popup.
  +
  +
[[File:Db_project_search_delete_poppup.png]]
  +
  +
== Hiding the Project ==
  +
  +
Hiding a project is a non-permanent removal option. The project may later be un-hidden to restore it with existing data intact.
  +
  +
To hide a project, you must have permissions to administer it.
  +
  +
Click on '''Administration''' in the Project, then '''Permissions'''.
  +
  +
[[File:db_administer_project_permissions.png]]
  +
  +
Select '''Private''', so that the project is only shown to authorized users.
  +
  +
[[File:db_project_private.png]]
  +
  +
Then, uncheck all permissions for all users and groups. You may still wish to leave the project visible to sonar-administrators, or you may prefer to hide it entirely.
  +
  +
[[File:db_project_permissions_remove.png]]
   
 
= 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>

Latest revision as of 21:00, 13 July 2021

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.

Dashboard7.8.1 overview.PNG

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 reusing the database name

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 Localyzer
  • Upgrade to a later version of the Lingoport Dashboard Client

Starting the Dashboard Server

Simple Startup

  1. If your system was installed with the Stack Installer or Stack Updater, the Jenkins user will have an alias to check the Dashboard On the system where the Lingoport Dashboard Server was installed, try: 
    2. > sonar.sh status
> sonar.sh start
  2. If that does not work, on the system where the Lingoport Dashboard Server was installed, go to the directory <server install directory>/bin.
    3. > 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
  4. Give it a few minutes and then open a browser and enter http://localhost or https://<system URL> to see the Dashboard. If you installed with a port such as 9000, use that port after localhost (http://localhost:9000).
  5. If the browser comes up in maintenance mode, the database may need to be upgraded. Enter http://localhost/setup or http://<system URL>/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 Localyzer Status Report

Upload Globalyzer and Localyzer Data to Dashboard

Managing Project Visibility

Projects may be managed so that they are visible only to a select list of users or groups.

General administration privileges are required to manage project visibility.

To manage project visibility, projects must first be set to Private. Then they may be set to have view permissions for specific users.

Setting a project as private

Open the project.

Click on Administration for the Project, then Permissions.


Db administer project permissions.png


Select Private, so that the project is only shown to authorized users.


Db project private.png

Managing individual project permissions

Once a project is Private, permissions may be restricted so that only specific users or groups may have visibility.

To do this for a single project, open the project, then go to Administration for the Project and Permissions in the pulldown.

Db administer project permissions.png


Ensure that Private is set, as it's required for the other permissions settings to take effect.

Db project private.png


Then, set permissions for users and groups as you find appropriate.

Db project permissions-a group.png

Managing multiple project permissions

To bulk manage project visibility, you must have general administer permission on the dashboard.

Projects Must first be set to Private

Projects must be Private for permissions to take effect. The Private setting is an individual project toggle, and bulk toggling of the private setting is not supported.

It is possible to set the default visibility of new projects, which will affect all projects that have not yet been created. You must be a global administrator to perform these steps. To do so:

First go to Administration in the black global bar. Then under the Administration heading, select Projects->Management.

Db project bulk management goto.png

Set the default visibility in the top right.

Db project permissions-default-visibility.png

Creating a permission template

Permissions templates can be used to set general permissions for a project. They may optionally affect projects based on their naming scheme.

To create a permissions template, you must be a general administrator.

Go to Administration in the black global bar then Security->Permission Templates

Db project permission temaplates go.png

Then click Create on the top right.

Db project permission temaplates view.png

In the first popup give the template a name. You may also optionally specify a regular expression for project targeting.

After creating a permission template, any newly created projects which match this regular expression will have the permission template applied to them.

You must manually apply the permission template to existing projects, it will not be applied automically, even if the name matches.

Db project permission templates-create1.png

Set the permissions you would like for the appropriate users and groups.

Db project permission templates-create2.png

Applying a permission template

First go to Administration[Global] at the black bar. Then under the Administration heading, select Projects->Management.

Db project bulk management goto.png

You will see a list of all projects, with up to 50 entries initially shown.

Db project bulk management list.png

Search and sort the projects as you find most appropriate, then select all that you wish to apply the permission template to.

Db project search selected.png

Select 'Bulk Apply Permission Template', then select your permission template from the dropdown and click Apply.

Db project permission templates-bulk-apply2.png

Removing an Uploaded Lingoport Dashboard Project

Permanently Deleting a Project

Permanently deleting a project entirely removes it from the dashboard. While it may later be re-created, you will lose any historical data associated with the project.

To delete a project, you must have permissions to administer it.

With the project open, select Administration at the Project then Deletion.

Db project delete admin .png

You will be prompted for deletion. Confirm.

Db project delete confirm.png

Bulk project deletion

To bulk hide projects, you must have general administer permission on the dashboard.

To bulk delete projects, first go to Administration at the black global bar. Then under the Administration heading, select Projects->Management.

Db project bulk management goto.png

You will see a list of all projects, with up to 50 entries initially shown.

Db project bulk management list.png

Search and sort the projects as you find most appropriate, then select all that you wish to delete.

Db project search selected.png

Select the red Delete option to the top right. Then confirm the popup.

Db project search delete poppup.png

Hiding the Project

Hiding a project is a non-permanent removal option. The project may later be un-hidden to restore it with existing data intact.

To hide a project, you must have permissions to administer it.

Click on Administration in the Project, then Permissions.

Db administer project permissions.png

Select Private, so that the project is only shown to authorized users.

Db project private.png

Then, uncheck all permissions for all users and groups. You may still wish to leave the project visible to sonar-administrators, or you may prefer to hide it entirely.

Db project permissions remove.png

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.
Retrieved from "http://wiki.lingoport.com/index.php?title=Dashboard_Users_Guide&oldid=95533"