Denodo Dashboard - User Manual Revision 20190321 NOTE This document is confidential and proprietary of Denodo Technologies. No part of this document may be reproduced in any form by any means without prior written authorization of Denodo Technologies. Copyright © 2021 Denodo Technologies Proprietary and Confidential Denodo Dashboard - User Manual 20190321 2 of 27 CONTENTS 1 PREFACE..........................................................................4 1.1 SCOPE..........................................................................................4 1.2 WHO SHOULD USE THIS DOCUMENT...............................................4 1.3 SUMMARY OF CONTENTS...............................................................4 2 INSTALLATION AND INITIAL CONFIGURATION......................5 2.1 SOFTWARE REQUIREMENTS............................................................5 2.2 INSTALLATION...............................................................................5 2.3 EXECUTION...................................................................................5 2.4 CONNECTING TO AN SSL-ENABLED SERVER.....................................6 3 OVERVIEW........................................................................8 4 SERVER MONITORING......................................................11 4.1 CREATING A NEW SERVER............................................................11 4.2 EDITING AN EXISTING SERVER......................................................12 4.3 MONITORING A SERVER...............................................................12 5 ENVIRONMENT MONITORING............................................22 5.1 CREATING A NEW ENVIRONMENT..................................................22 5.2 EDITING AN EXISTING ENVIRONMENT...........................................23 5.3 MONITORING AN ENVIRONMENT...................................................23 5.4 SYNCHRONIZING AN ENVIRONMENT..............................................25 Denodo Dashboard - User Manual 20190321 3 of 27 1 PREFACE 1.1 SCOPE Denodo Dashboard provides a single interface for real time monitoring of Denodo Platform servers and environments (groups of servers) and for import/export operations between several Denodo Platform servers, it allows you to synchronize VDP servers. This document introduces the reader to the main functionalities of the tool. 1.2 WHO SHOULD USE THIS DOCUMENT This document is aimed at system administrators that require detailed information of the status of a server in real time. 1.3 SUMMARY OF CONTENTS This document describes: ● How to install Denodo Dashboard ● How to connect to a server in order to monitor its main parameters and data sources ● How to define and monitor an environment (set of servers to be monitored together) Denodo Dashboard - User Manual 20190321 4 of 27 2 INSTALLATION AND INITIAL CONFIGURATION 2.1 SOFTWARE REQUIREMENTS This software requires, at least, Java 2 Runtime Edition version 6 (JRE1.6) installed. The environment variable JAVA_HOME must be pointing to the folder containing the JRE installation. In case you wish to use the import/export features, you will need to have the environment variable DENODO_HOME set and pointing to the installation folder of your Denodo Platform, or instead of using the platform you can use Denodo Tools, for this you will need to set the environment variable DENODO_DB_TOOLS_HOME. Otherwise, these variables are not necessary. 2.2 INSTALLATION This software is distributed in a zip file that only has to be extracted for installation. 2.3 EXECUTION To launch the application, execute one of the scripts included in the Denodo “bin” folder: ● For Windows systems, execute the script “denodo-dashboard.bat” ● In Unix-like systems, execute the shell script “denodo-dashboard.sh” ● For cygwin, execute the shell script “denodo-dashboard-cygwin.sh” All the scripts use the JAVA_OPTS environment variable to configure the JVM. If it does not exist, it will be set to -Xmx1024m (usually enough in case you use import/export features). Otherwise it will use the set value. Please, make sure you use enough memory in case you wish to use import/export features, as this feature needs it. Once the tool is launched, the initial empty screen will be displayed. Below there is an image of the main screen as it appears just after being started. Denodo Dashboard - User Manual 20190321 5 of 27 2.4 CONNECTING TO AN SSL-ENABLED SERVER Dashboard can be connected with a server that has SSL enabled. For this, the “Server uses SSL” option should be checked when registering the server. But some configuration might be needed at the startup scripts too: If you use the trust store by default and if the server's public key is signed by a well known international CA no further configuration will be required. If not, you should configure the trust store you are using. A common way to do this is to set the Java system property javax.net.ssl.trustStore by adding -Djavax.net.ssl.trustStore=<path_to_truststore> at the launcher script or at the JAVA_OPTS environment variable (if the client allows to use it), and the same for the system property javax.net.ssl.trustStorePassword only if it is necessary by adding -Djavax.net.ssl.trustStorePassword=<truststore_password>. Note that, depending on the Operating System you are using, you might need to modify denodo-dashboard.bat, denodo-dashboard.sh or denodo-dashboard- cygwin.sh. For example, you could adapt your denodo-dashboard.bat script by replacing this line: Denodo Dashboard - User Manual 20190321 6 of 27 %JAVA_BIN% %JAVA_OPTS% -classpath "%DENODO_SERVERMONITOR_CLASSPATH%" com.denodo.connect.monitoring.dashboard.MonitorTool %OPTIONS% ...with: %JAVA_BIN% %JAVA_OPTS% -Djavax.net.ssl.trustStore="C:/Program Files/Denodo Platform/certs/mycacerts" -Djavax.net.ssl.trustStorePassword=admin.10 -classpath "%DENODO_SERVERMONITOR_CLASSPATH%" com.denodo.connect.monitoring.dashboard.MonitorTool %OPTIONS% Denodo Dashboard - User Manual 20190321 7 of 27 3 OVERVIEW The Denodo Dashboard has three main areas: the menu bar, the side tree, and the workspace. The menu bar It has the following menu entries: ● File: contains the following submenu ○ New Server: opens the new server screen in the workspace area. ○ New Environment: opens the new environment screen in the workspace area. ○ Save Screenshot: saves a screenshot of the Denodo Dashboard window. A file chooser is opened to select the folder where the image will be stored in (the name of the file is autogenerated and will include the date and time of capture in the file name). ○ Exit: exits and closes the tool. ● Help: has the following submenu ○ About: shows an informative popup dialog that displays the version of the Denodo Dashboard and copyright information. The side tree The side tree shows a list of the elements that this tool is monitoring. It has two top level categories: servers and environments: ● Servers are individual Denodo Platform servers monitored by the Denodo Dashboard. ● Environments are named groups of individual servers. These groups can be created for the different environments present in an enterprise Denodo Platform installation (for example, an environment could be created for the Development servers, another environment for the QA servers, another for the Production cluster, etc). The side tree lists all the servers and environments that have been added to the Dashboard. The options available for each element are accessible using a right-click popup menu. Servers section Denodo Dashboard - User Manual 20190321 8 of 27 Shows all the servers created in the tool. The following options are available from the “Servers” right click menu: ○ New server: opens the new server screen in the workspace area. These are the right click menu options for each server in this section: ○ Monitor: opens the server monitor in the workspace area and starts monitoring the selected server, gathering real time information about its status. ○ Disconnect: disconnect from the server so that charts don’t keep receiving information from VDP. When connected, it does not matter whether the server monitor window is open or not, once opened the screen will show information as soon as the user starts monitoring it. ○ Ping: launches a ping query to this server. The ping time (in milliseconds) is displayed in a popup window. ○ Edit: opens the edit server dialog in the workspace area. ○ Delete: removes the server from the list and from all the environments it belongs to. A confirmation popup will be displayed prior to this operation. ○ Add to environment: adds the selected server to the environment selected from the submenu. Environments section Shows all the environments created in the tool. The following options are available from the right click menu: ○ New environment: opens the new environment dialog in the workspace area. For each environment, it shows all the servers that belong to it. The following options are available from the right click menu of each environment: ○ Monitor: opens the environment monitor in the workspace area ○ Edit: opens the edit environment dialog in the workspace area ○ Delete: removes the environment from the list. A confirmation popup will be displayed prior to this operation. ○ Synchronize Environment: imports metadata from the Master node to the other nodes in the environment. Denodo Dashboard - User Manual 20190321 9 of 27 For each server that belongs to the environment, these are the right click menu options: ○ Monitor: opens the server monitor in the workspace area. ○ Disconnect: disconnects the environment