You can customize the Help menu on the main navigation bar by deleting default links provided by Arcadia Data, or by adding new links.
To customize the Help menu, modify the local configuration file, such
as settings.py
, and restart the server.
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 Arcadia Enterprise.
To modify this menu, you must change the corresponding settings from TRUE
to FALSE
.
Set to TRUE
to show the release number of the running instance of Arcadia Enterprise.
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
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
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
Set to TRUE
to show the release number of the running instance of
Arcadia Enterprise.
HELP_SHOW_VERSION = True
This is TRUE
by default. To remove the version, set the parameter to
FALSE
:
HELP_SHOW_VERSION = False
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
To add custom links that supplement the default Arcadia 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",
}
]
Here is a sample of configuration settings for the Help menu:
# To display the default Arcadia 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",
},
]