Cloudera Docs

Managing help and support site settings

As an administrator, you can customize the default settings of the Help menu in Cloudera Data Visualization (CDV). You can edit or change the link for Documentation and Support directly on the CDV UI, or in the settings.py file.

Customizing Help on the UI

You can change the default settings of the Help menu in Cloudera Data Visualization. You can customize the links for Documentation and Support on the Site Settings interface.

In Site Settings > Help and Support, you can change the following:

  • You can change the Text to display for documentation link from the default Documentation to any other title, for example as Customer Documentation.
  • You can change the URL for documentation link from the default https://docs.cloudera.com/data-visualization/7/index.html to a different URL, such as http://books.mycompany.com.
  • You can set whether you want to show a webpage link or an email address for Support contact information.
    • You can change the Text to display for Support web page link option from the default Cloudera Support Hub and the URL for Support web page link from the default https://my.cloudera.com/support.html.
    • You can change the Email address for Support from the default support@cloudera.com to another email, such as support@mycompany.com.

Customizing Help through configuration file

You can customize the Help menu on the main navigation bar by deleting default links provided by Cloudera Data Visualization, or by adding new links.

To customize the Help menu, modify the local configuration file, such as settings.py, and restart the server.

Components of the Help Menu

By default, the Help menu contains links to What's New in the current release, Documentation, Knowledge Base, YouTube Channel, Support Email, licensing status, and the current version of Cloudera Data Visualization.

To modify this menu, you must change the corresponding settings from TRUE to FALSE.

HELP_SHOW_WHATSNEW

Set to TRUE to show the release number of the running instance of Cloudera Data Visualization. 

HELP_SHOW_WHATSNEW = True

This is TRUE by default. To remove the "What's new" link, set the parameter to FALSE:

HELP_SHOW_WHATSNEW = False
HELP_SHOW_DOCUMENTATION

Set to TRUE to show the link to our documentation at documentation.arcadiadata.com/release_number/.

HELP_SHOW_DOCUMENTATION = True

This is TRUE by default. To remove the "Documentation" link, set the parameter to FALSE:

HELP_SHOW_DOCUMENTATION = False
HELP_SHOW_SUPPORT_EMAIL

Set to TRUE to show a link to contact our support team at support@arcadiadata.com.

HELP_SHOW_SUPPORT_EMAIL = True

This is TRUE by default. To remove the "Support" link, set the parameter to FALSE:

HELP_SHOW_SUPPORT_EMAIL = False
HELP_SHOW_VERSION

Set to TRUE to show the release number of the running instance of Cloudera Data Visualization. 

HELP_SHOW_VERSION = True

This is TRUE by default. To remove the version, set the parameter to FALSE:

HELP_SHOW_VERSION = False
HELP_SHOW_LICENSE

Set to TRUE to show if your license is valid. 

HELP_SHOW_LICENSE = True

This is TRUE by default. To remove the license information, set the parameter to FALSE:

HELP_SHOW_LICENSE = False
HELP_MENU_LINKS

To add custom links that supplement the default Data Visualization help links, use the HELP_MENU_LINKS parameter and a list of links in the form of type:link, link:url_address, and label:link_label.

You can also insert a divider between these custom links, in the form: type:divider, 

HELP_MENU_LINKS = [
  {
    "type": "link",
    "link": "url_address_1",
    "label": "link_label_1",
  }
  {
    "type": "link",
    "link": "url_address_2",
    "label": "link_label_2",
  }
  ...
  {
    "type": "divider",
  }
  {
    "type": "link",
    "link": "url_address_n",
    "label": "link_label_n",
  }
]

Sample Help Menu Configuration

Here is a sample of configuration settings for the Help menu:

# To display the default Data Visualization help links in the Help menu, set the flag to "True"
HELP_SHOW_WHATSNEW = True
HELP_SHOW_DOCUMENTATION = True
HELP_SHOW_SUPPORT_EMAIL = True
HELP_SHOW_VERSION = True

# To remove an Arcadia link from the Help menu, set the flag to "False"
HELP_SHOW_LICENSE = False

# To add new links in the Help menu, enter the following code: 
#In this example, we are adding links to Knowledge Base and YouTube Channel.
HELP_MENU_LINKS = [
  {
    "type": "link",
    "link": "https://www.arcadiadata.com/resources/knowledge-base/",
    "label": "Knowledge Base",
  },
#  You can also specify a divider between the two rows as follows: 
#  {
#    "type": "divider",
#  },
  {
    "type": "link",
    "link": "https://www.youtube.com/channel/UCmubDZSISQMKg1Q0HXo03HQ",
    "label": "YouTube Channel",
  },
]