This section explains how to configure and personalize several aspects of the tool. It covers the following topics:
These parameters are global for all the users of the tool.
Elements Shown to the Users¶
You can specify which elements from the catalog the users are allowed to see:
Only Web Services
It affects the results shown in the following sections:
You can choose whether to Allow users to browse by Databases/Folders or not. If this option is disabled, users will not be able to access the Databases/Folders panel. In this case, you can also choose to Hide uncategorized views and web services from users (uncategorized views and web services will not appear in search results or when browsing by Categories or Tags).
You can customize this tool to adapt it to the branding of your company. You can change the following:
The logo displayed on the top left.
The image displayed on the background of the Login page.
The image displayed on the background of the Welcome page.
Maximum size for uploaded images is 5MB.
You can add an informative message that will be displayed to all users when they access the Data Catalog. It will show up at the top of the page.
It can be used to display a welcome message, inform users when the service is expected to be down for maintenance, legal disclaimers, etc.
To enter the message in HTML, click Source in the editor, enter the HTML and click Source again. The Save button is disabled while in Source mode.
Allow HTML Descriptions and Properties¶
In this section, there is an option for specifying if user can create HTML properties and add HTML descriptions for categories, tags, databases, views, web services, groups and properties.
If HTML inputs are not allowed, element descriptions will always be displayed as plain text and existing HTML type properties will be converted to Long Text type. In addition, it will not be allowed to create HTML type properties.
Export Format Configuration¶
The available export formats, among: CSV, HTML, Excel and Tableau (the section below explains how to enable the exports to Tableau). All enabled by default.
The maximum number of rows using each of the available formats.
If only the users with the role data_catalog_exporter in Virtual DataPort can export the results of the queries using each of the available exporters.
Enabling Exports to Tableau¶
To enable the feature of exporting data to Tableau, you need to install the “Tableau Data Extract API” in the host where the Denodo Platform is installed. To do this, follow these steps:
Go to the web site of the Tableau Data Extract API.
In this page, sign in and download the package C/C++/Java 64-bit version. Select Windows or Linux depending on the operating system where the Denodo server runs.
Uncompress the downloaded file.
If the Denodo server runs on Windows, copy the files of the folder
binin the downloaded file to
If the Denodo server runs on Linux:
Copy the files of the folder
binin the downloaded file to
Copy the files of the folder
lib/dataextractin the downloaded file to
Restart the Data Catalog.
Database and View Connection URIs¶
You can choose whether to display the
Show Connection URIs button or not in
the databases’ and views’ details page. If you choose to show it, you can customize several
Introduction text of the database connections panel: this will be shown in the panel instead of the default introduction.
URI Patterns: these describe how to access the server’s databases through JDBC, ODBC, REST and OData. You may use the following variables in the pattern definitions:
$database_name. These variables will be replaced by the appropriate values when showing the URIs to the user.
The Data Catalog allows showing usage statistics of the views and web services by analyzing the usage data collected by Denodo Virtual DataPort. This feature requires some preparation steps, that will be explained later on this section.
When this feature is enabled, the details page of views and web services includes a new tab that shows some statistics about its usage (after they are collected and computed).
Steps to Configure the Gathering of Statistics¶
In order to show the Usage tab in the details page of views and web services, a user with administration privileges has to perform the following steps:
Configure the Denodo Monitor to store the log of requests in a database (for instance, a table in Oracle). By default, Denodo Monitor saves the log information to a file. You need to modify this to use a database instead the log file.
<DENODO_HOME>/tools/monitor/denodo-monitor/conf/ConfigurationParameters.properties, search for the following text and follow the instructions of the file.
# ================================================================================ # Settings to store the output of the Virtual DataPort query monitor in a database # ================================================================================
Data Catalog requires to use the Denodo Monitor included in update 20180926 or later.
Create the necessary views in a Virtual DataPort server:
Create a database named as denodo_logs. This is the recommended name for the database and the next steps are explained assuming this name, but you can use any other one. If you use a different name, you will need to update the VDP data source created in the step 4 after importing the file data_catalog_statistics_scheduler.zip (from
<DENODO_HOME>/resources/data-catalog/statistics/) in the Scheduler Server.
Create a base view over the previously configured table (request_notification) in the Denodo Monitor for the requests log.
You have to name that base view as request_notification and include the columns with the default names.
Import the VQL file usage-statistics.vql together with its properties file usage-statistics.properties from
<DENODO_HOME>/resources/data-catalog/statisticsto the Virtual Database created in step 2.1 (e.g. denodo_logs). This will create a new FULL CACHE view, usage_statistics_src and associated objects.
Note that you may need to modify the properties file before importing:
The property (or properties) ending by URL should point to the Data Catalog. You may need to change them if the Tomcat server where the Data Catalog is running is not listening on the default port and/or is not resolvable as localhost from the Virtual DataPort server.
The properties ending by USER, PASSWORD, and PASSWORD.ENCRYPTED indicate the user name and password that will be used to call the REST API of the Data Catalog. By default, they are configured to use the default admin user with its default password.
The property (or properties) ending by TIMEOUT indicates the timeout (in miliseconds) of the calls to the Data Catalog API. .
If the cache is not enabled in the Denodo Virtual DataPort server, you have to enable and configure it.
Due to license restrictions, you cannot use the Denodo Virtual DataPort server shipped with the Solution Manager installer.
Enable the usage statistics in the Data Catalog:
Configure the period/s to compute the usage statistics: Last day, Last month and/or All time.
Configure the element/s over which to calculate the usage statistics: User, User Agent and/or Query.
Configure the connection details to the Virtual DataPort server containing the views over the Denodo Monitor requests log (needed to calculate the usage statistics), as explained before.
Database: the database where the views were created. If no value is specified in this field, the database of the Connection URI will be used.
View Name: the name of the view to query the usage statistics. The default value usage_statistics_src will be used if no value is specified in this field.
Compute the statistics:
Once you get to this step, you have everything configured but nothing is shown in the new statistics tab from the details page. This is because no statistics were computed yet. The next step, is to make the Data Catalog process the information stored in Denodo Virtual DataPort to compute and show the statistics. To do that, there are two options:
Scheduled with Denodo Scheduler:
Create the INCREMENTAL_CACHE_LOAD stored procedure in Denodo Virtual DataPort.
Import the file data_catalog_statistics_scheduler.zip from
<DENODO_HOME>/resources/data-catalog/statistics/in a Scheduler server. It creates a project named data_catalog_statistics. This project contains a VDP data source that should be edited to point to the VDP server and database configured in the step 1 (make sure to configure it with a user with enough privileges on that server and database). Besides, it contains several jobs that will be different depending on the update you have installed.
Since Denodo Platform 7.0 update 20190903, it includes the job load_cache_and_update_statistics, a VDP job that executes a view over the Data Catalog API to incrementaly load the cache of the view usage_statistics_src) and compute the usage statistics. You just need to schedule this job to be executed periodically. It is recommended to schedule it to be executed at least once a day (or more times if you desire to refresh the usage statistics more frequently).
If you are using an older update, you should use the following three jobs:
cache_load_first_time: A VDPCache job to load the cache of the view usage_statistics_src the first time. It is not mandatory to use this job, but it is recommended to use it if you have stored the Denodo Monitor logs for several days or weeks and you have not executed the job cache_load_incremental (explained in the next step) yet. Execute this job just once, and then use the job cache_load_incremental to load the cache incrementally, as explained in the following step.
cache_load_incremental: A VDP job to call the incremental cache load stored procedure over the view usage_statistics_src. It is recommended to schedule it to be executed at least once a day (or more times if you desire to refresh the usage statistics more frequently).
update_statistics: A VDP job to execute a view over the Data Catalog API to compute the usage statistics using the data obtained from the view usage_statistics_src. It is recommended to schedule it to be executed just after the job cache_load_incremental, on which it depends.
If your project contains the job load_cache_and_update_statistics, use it. Otherwise, you are forced to use the other three jobs as explained.
Manually from the Data Catalog:
You can compute the usage statistics by clicking the Compute usage statistics now button in the Data Catalog. The action dispatched with this button loads the cache with new data since the last time the cache was refreshed, and then computes the statistics (as Denodo Scheduler does, but in a scheduled way).
The recommended option to keep your statistics up to date is by using the Denodo Scheduler. You can modify the scheduling triggers according to your needs.