QMetry Reports Installation Guide (without Docker)

In this guide, we'll run you through installing QMetry Reporting Tool manually when docker is not being used for installation.

Section I

Pre-requisites

  • Linux Server is required with support of these commands: wget and unzip.
  • Java 1.8 installed should be installed on the machine 
  • Operations should be performed by sudo user only
  • Reporting server has access of qmetry database

  • Port 3000 is open of Reporting server

  • Qmerty server can access Reporting server with respective port by default will be 8080

Installing QMetry Reporting Tool

Step 1. Download Reporting server setup to your instance using the links provided by QMetry Support Team.                      

Step 2. Unzip the QmetryReport_{version}.zip , which contains:       

  1. tomcat
  2. Discovery setup (if this does not work, then follow manual steps)                     

Discovery setup needs to be installed first.

  1. Provide execution rights to the installer by executing below command (Two setups have been provided in package. They should be used as per your system OS. Use CentOS, else use generic one)
    • chmod +x PlatformServices_centos7_3_1_272linux_x64installer.run
  2. Run file using below command (keep installation path to /opt/ folder)
    • ./PlatformServices_centos7_3_1_272linux_x64installer.run 

While running the file, you will be asked for certain inputs like below

Do you accept this license? [y/n]: Y

  1. Yes, install bundled Java 1.8 now, for use only with the Logi Platform Services.
  2. No, I'll download and Install Java 8 myself at later time.

Please choose an option [1]: 1


Enter user and password details when prompted.

Enter the details as shown in the screenshot (Remember this Password as it will be required for further configuration).

On successful installation, you will see the following output


Once service has been installed successfully, update license of Discovery module. Enter the following command.

1. Stop discovery services using the following command (then wait for 2 minutes after stopping service)

  • cd /opt/LogiPlatformServices/platform/bin
  • ./logiDiscovery.sh stop

2. Remove Existing License

  • ./licenseTool.sh deletelicense --license-id=<yourLicFilename-noExt> --user=admin --password=<yourAdminPW>
  • Example:
    • ./licenseTool.sh deletelicense --license-id=logiTrial03 --user=admin --password=qmetry@123

3. Add new Licence (licence file provided in zip file named (lgx030502.lic)

  • ./licenseTool.sh createlicense --inputfile=/opt/<lgxYourLicFile.lic> --user=admin --password=<yourAdminPW>
  • Example :
    • ./licenseTool.sh createlicense --inputfile=/opt/lgx030502.lic --user=admin --password=qmetry@123         

4. Start Discovery Service using below command

  • ./logiDiscovery.sh start

               

Step 3. Copy tomcat as well as scheduler under /opt folder.

 1. Rename Tomcat folder name using the following command (only if tomcat is has name other than "tomcat")       

  • mv apache-tomcat-8.5.32(currentfolderName) tomcat

2. Rename scheduler using below command (only if scheduler has name other than QMetrySchedulerService)

  •  mv scheduler(currentSchudelerName) QMetrySchedulerService

3. Go to bin/ folder of tomcat. Provide execution rights to the following files using the following commands 

  • chmod +x startup.sh
  • chmod +x catalina.sh
  • chmod +x shutdown.sh

4. Start tomcat using the command below.

  • ./startup.sh

5. Steps to restart Scheduler Service

  • cd /opt/scheduler OR cd /opt/QMetrySchedulerService
  • cd bin
  • sudo ./Scheduler.sh start


Step 4. Go to folder where the zip file is extracted. Provide execution access to the following file:

  • chmod +x change_setting_lgx_file.sh

Run this file using the following command and enter inputs as shown in the table below.

  • sh change_setting_lgx_file.sh

                       

OptionsType Comments / example
Enter Mysql Database Host IP / DNS NameMandatoryQMetry DB Host Public IP/DNS, example: 10.10.11.100
Enter Mysql Database PortMandatoryQMetry DB Port, example: 3306
Enter Mysql Database SchemaMandatoryName of existing QMetry Application DB, example: qmetry
Enter Mysql Database UserNameMandatoryQMetry DB Username, example: root
Enter Mysql Database PasswordMandatoryQMetry DB Password
Enter SMTP HostNameOptionalSMTP Server Host IP/DNS, for sending report emails
Enter SMTP From EmailOptionalFrom email address that appears while emails are received
Enter SMTP Authentication PasswordOptionalSMTP Server Authentication Password (hit enter if no password is required)
Enter SMTP PortOptionalSMTP Server Port, example: 587
Enter Qmetry Application Service URL with Port No. (http://demo.qmetry.com)MandatoryComplete QMetry URL, example : http://demo.qmetry.com
Enter Report Server URL with Port No.(http://qmetryreport.qmetry.com:3000)MandatoryReport Server's URL, example: http://<ReportServerIP/DNS>:3000
Enter Discovery User's PasswordMandatoryExample: qmetry123#
Enter IP Address of QMetry  & Report Server (Add Multi IP Address sepreted by comma)MandatoryQMetry App and Report Server IP Addresses, comma separated without space.


Section II

Pre-requisites

Java , nodejs ,wget ,unzip should be installed.


Get Java, Node by below apporach:

1. You can get java and node folder from installed Discovery service which was failed and not completed ,they can be found in below path

  • /opt/LogiPlatformServices/platform

2. If step 1 does not work you can use folder which  are provided along with setup

Installing QMetry Reporting Tool

Step 1. Ensure that you're logged to the server as an administrator, and also remove any existing Discovery setup by running uninstall file available in /opt/LogiPlatformServices/platform

Step 2. Create a new folder named Discovery in /opt folder

Step 3. Unzip provide zip file (LogiPlatformServices3_1_272.zip)

Step 4. Move platform folder to /opt/Discovery

Step 5. Move java and nodejs (unzip them if you are using from provided zip) to /opt

Step 6. Once the extraction completes, use an editor and edit file logiconfig.sh provided in /opt/Discovery/platform/bin and set respective path in

JAVA_HOME, LOGI_HOME, NODE_HOME

Example :

  • export JAVA_HOME=/opt/Discovery/platform/java/jre1.8.0_102
  • export LOGI_HOME=/opt/Discovery
  • export NODE_HOME=/opt/Discovery/platform/nodejs


Step 7. Generate Master Key data by opening a terminal or command line window, navigating to the /opt/Discovery/platform/bin folder, and executing: 

  • sudo chmod +x keygen.sh
  • sudo ./keygen.sh -alg aes -default -install

A successful execution will look like the above screenshot. Leave the command line open for later use.

Step 8. Open the /opt/Discovery/platform/bin/logiDiscovery.sh file and edit the environment variable paths, as you did in Step #6

Step 9. Save and then copy the edited logiDiscovery.sh file to    the /etc/init.d folder, using the appropriate source path:

  • sudo cp /opt/Discovery/platform/bin/logiDiscovery.sh /etc/init.d/logiDiscovery.sh

Step 10. Still in /opt/Discovery/platform/bin, grant full permissions to the logiApplicationService.sh and logiDataService.sh files, using these commands:

  • sudo chmod 755 logiApplicationService.sh
  • sudo chmod 755 logiDataService.sh

Step 11. Open and run the Logi services using the following commands:

  • cd /etc/init.d
  • sudo chmod +x logiDiscovery.sh
  • sudo ./logiDiscovery.sh start

It will take some time to start, wait for a while before proceeding with the next step.

Step 12. Next, you need  to import the product license , Stop the services and import the license using the following commands, providing the correct path and license file name.:

  • sudo ./logiDiscovery.sh stop

It will take some time to stop, wait for a while before proceeding to below commands.

  • cd /opt/Discovery/platform/bin
  • sudo chmod +x licenseTool.sh
  • sudo ./licenseTool.bat createlicense --inputfile=/opt/lgx030502.lic --user=admin --password=password



Note: The user and password values are literally "admin" and "password" - do not substitute your own values here. 

Step 13. Restart the Logi services, using the following commands:

  • cd /etc/init.d
  • sudo ./logiDiscovery.sh start

Step 14. Update the "Client Secret", using the following commands and providing the correct path:

  • cd /opt/Discovery/platform/bin
  • sudo chmod +x clientSecret.sh
  • sudo ./clientSecret.sh --username=admin --password=password

Again, use the literal "admin" and "password" argument values.

Step 15. Stop and restart the reporting services again. (wait for two minute after each operation)

In your browser, navigate to localhost:3000/Datahub or http://<IPAddress/DNS>:3000/Datahub. Once this page opens up correctly should mean that reports are installed correctly. There is no need to log into this page.

Step 16. After the above steps are completed, log into QMetry application.

  • Go to "Admin" Profile and Edit the Profile.
  • Update QMetry Base URL and Report Server URL




If you are facing any issues during the installation process, write us at qtmprofessional@qmetrysupport.atlassian.net. This will automatically open a ticket with our support team and help you to follow the progress.