Personalization

From the Personalization dialog you can configure the aspect of the Data Catalog and the available features in its interface. It is organized in the following tabs:

  • Elements. The features related to the elements of the catalog are configured here.

  • Informative message. You can configure a message to show to the users before they log in the application.

  • Export. In this tab you configure which options are available to export the results of a query.

  • Connection. From this tab you can customize the connection URLs and decide where to show them.

  • Usage statistics. You can enable the usage statistics in this tab and which options are available.

  • Theme. You will find here a dialog to redefine the visual aspect of the Data Catalog.

Elements

In the Search and browse configuration section you configure the following settings:

  • Select the elements that will be shown to the users. You can specify if the users only have access to views, to web services or to both of them. In addition to searching and browsing, this setting will affect the home page and the saved queries.

  • Choose how the elements will be displayed by default. Select the display mode of the elements by default: list or grid.

  • Allow users to browse by Databases/Folders. If disabled, the Browse menu will not show the Databases / Folders option.

  • Show only views and web services belonging to any category. In case the browsing by database and folders is disabled, you can decide if the Data Catalog will show all elements in the server when searching or browsing, or only those elements with a category.

Search and browse configuration section in the Elements tab

Search and browse configuration section in the Elements tab

In the Queries section, you configure if users are allowed to save queries or not with the option Allow saved queries. If disabled, the My Queries menu will not be shown.

Queries section in the Elements tab

Queries section in the Elements tab

In the Allow HTML section, with the Allow HTML descriptions and properties you decide if HTML is supported in descriptions for databases, views, web services, categories or tags; and if a property group supports HTML type properties. If disabled:

  • Element descriptions will always be displayed as plain text,

  • Existing HTML type properties will be converted to type Long text, and

  • Property groups will not allow to create properties of type HTML.

Allow HTML section in the Elements tab

Allow HTML section in the Elements tab

Informative Message

In the Informative message tab you can configure an informative message that will be displayed to users as a modal pop-up before they log in the Data Catalog. It can be used to display a welcome message, inform users when the service is expected to be down for maintenance, legal disclaimers, etc.

Informative Message shown before a user logs in the Data Catalog

Informative Message shown before a user logs in the Data Catalog

In the editor you can enter plain text or HTML text with the help of the toolbar. Use the code icon in the toolbar to enter HTML code in the editor.

Dialog to configure the informative message

Dialog to configure the informative message

Export

In the Export tab you can configure the following settings about the exportation of the query results of views and web services:

  • The available export formats, between CSV, HTML, Excel, Tableau (.tde) and Tableau (.hyper). By default, all formats are enabled.

    See also

    The section Enabling Exports to Tableau explains how to configure the Denodo Platform to enable the exports to Tableau.

  • If only users with the data_catalog_exporter role in Virtual DataPort can export the results of the queries using each of the available exporters.

  • If Data Catalog should generate these files with a header by default. This setting only applies to CSV, HTML and Excel files. Exporting to Tableau (.tde) and Tableau (.hyper) always include the header.

  • The maximum number of rows that will be exported using each of the available formats. First, you need to check the Limit maximum number of rows to export option and then provide a value in the corresponding Maximum numbers of rows field.

  • The field delimiter character used when exporting to a CSV file. You can choose between Comma, Pipeline, Semicolon, Space and Tab; or click the edit button and enter a user-defined delimiter character.

    Note

    The double quote character (") cannot be set as a delimiter character.

Dialog to configure the settings for exporting the query results

Dialog to configure the settings for exporting the query results

Enabling Exports to Tableau

To enable the feature of exporting data to Tableau, you need to install the Tableau Data Extract API (for .tde format) or Extract API 2.0 (for .hyper format) in the host where the Denodo Platform is installed. To do this, follow these steps:

  1. Go to the web site of the Tableau Data Extract API or Extract API 2.0.

  2. 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.

  3. Decompress the downloaded file.

  4. If the Denodo server runs on Windows, copy the files of the folder bin in the downloaded file to <DENODO_HOME>/jre/bin.

  5. If the Denodo server runs on Linux:

    1. Copy the files of the folder bin (for .tde format) or bin/hyper (for .hyper format) in the downloaded file to <DENODO_HOME>/jre/bin.

    2. Copy all the .so files of the folder lib64/dataextract (for .tde format) or lib64/tableausdk (for .hyper format) in the downloaded file to <DENODO_HOME>/jre/bin. Files under the Java subfolder are no needed. For some Linux distributions, it is necessary to copy all the mentioned .so files to /lib directory of the Linux root folder.

  6. Restart the Data Catalog.

Note

There is a limitation in Linux environments when installing Tableau libraries. It is only allowed to configure libraries for one Tableau format (.tde or .hyper) in Data Catalog.

Connection

You can choose whether to display the Connection URLs button or not in the Summary tab of databases, views and web services. If you choose to show it, you can customize several parameters:

  • Introduction text of the connections panel. This value will be shown in the panel instead of the default introduction.

  • URL patterns. These values describe how to access the databases and views of the server through JDBC, ODBC, REST and OData; and the URL for accessing web services. You may use the following variables in the pattern definitions: $protocol, $vdp_host, $vdp_port, $odbc_port, $webcontainer_port, $user_name, $database_name and $view_name. These variables will be replaced by the appropriate values when showing the URLs to the user.

  • Show the button to generate a Tableau data source. Enable this option to show the Tableau button in the Summary tab of views, which generates a data source to query the view from Tableau.

Dialog to configure the connection URLs for databases, views and web services

Dialog to configure the connection URLs for databases, views and web services

Usage Statistics

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 for views and web services includes a new tab called Usage that shows some statistics about its usage.

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:

  1. 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.

    Edit <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
    # ================================================================================
    
  2. Do the following steps in Virtual DataPort:

    Note

    Due to license restrictions, you cannot use the Virtual DataPort server included in the Solution Manager.

    1. Create a database called denodo_logs. Although you could use a different name, if you do, you will have to modify the properties file of the Scheduler project that you will import in step #4.

    2. Create a JDBC data source that points to the database where Denodo Monitor will store the log of requests. If you already have this data source, you do not need to create a new one.

    3. Create a base view over the table request_notification of this data source. This is the table in which Denodo Monitor will store the requests log.

      This base view has to be called request_notification. Do not modify the names of the fields.

    4. Check that the cache engine of Virtual DataPort is enabled.

    5. Edit the file <DENODO_HOME>/resources/data-catalog/statistics/usage-statistics.properties and do these changes:

      • The properties ending with URL have to 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 Virtual DataPort.

      • The properties ending with 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 properties ending with TIMEOUT indicate the timeout (in milliseconds) of the calls to the Data Catalog API.

    6. Import the file <DENODO_HOME>/resources/data-catalog/statistics/usage-statistics.vql along with the properties files you just modified, into database denodo_logs.

      This will create a new full cache view, usage_statistics_src and associated objects.

    7. Load the Denodo Incremental Cache Load stored procedure in Denodo Virtual DataPort.

    8. Create the incremental_cache_load stored procedure in the database denodo_logs of Denodo Virtual DataPort (or in the database indicated in the first step done for Virtual DataPort).

  3. Enable the usage statistics in the Data Catalog. Follow these steps:

    • Configure the period to compute the usage statistics: Last day, Last month or All time.

    • Configure the elements over which to calculate the usage statistics: User, User Agent (Applications) 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 URL 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.

    Usage Statistics

    Usage Statistics

  4. Compute the statistics.

    At this point, the statistics need to be computed so Data Catalog can display them in the Usage tab of the Data Catalog. To do this, there are two options:

    • Scheduled with Denodo Scheduler. Import the file <DENODO_HOME>/resources/data-catalog/statistics/data_catalog_statistics_scheduler.zip into Scheduler. It creates a project named data_catalog_statistics, which contains:

      • A VDP data source. Edit it so it points to the VDP server and database configured in the step #2 (make sure to configure it with a user with enough privileges on that server and database).

      • A Scheduler job called load_cache_and_update_statistics. This is a job of type VDP that executes a view over the Data Catalog API to incrementally load the cache of the view usage_statistics_src and compute the usage statistics. Schedule this job to run periodically. We recommend scheduling it to run at least once a day (or more times if you desire to refresh the usage statistics more frequently).

    • Manually from the Data Catalog. You can compute the usage statistics by clicking the Compute usage statistics 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).

Note

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.

Theme

You can customize the interface of the Data Catalog to adapt it to the branding of your company. You can change the following settings:

  • The colors.

  • The border and shadows of the dialogs and forms.

  • The fonts.

  • The logo, header and other images of the application.

    Note

    The maximum size for uploaded images is 5MB.

Dialog to configure the theme of the Data Catalog

Dialog to configure the theme of the Data Catalog

Click on the Apply theme if you want to test your changes before persist them. The changes will only be applied for the current tab of your browser. Other tabs or other browsers will ignore these changes.

If you want to persist your changes, click the Save button. You need to restart the Data Catalog for your changes to take effect.

You can always go back to the original settings by clicking the Restore defaults button.

If you want to save your settings to a file, use the Export button. To load the settings from a file, use the Import button.