Customizing Help Menu

Cadenza can be configured to show links in the help menu at the top right of the main header:

Screenshot of the help menu in Cadenza

These links can be customized in the basicweb configuration as menu entries. The icon for each menu entry is derived from its id (a help icon for entries of type help, etc). Additionally, depending on the id (type), you can specify a URL and a name.

In our default distribution we include links to our online documentation for the German and English locales. If you want to change these links to point to either a local copy of the documentation running in your own infrastructure or a different set of contents altogether, you can change the URLs accordingly.

For example, assuming that you have Cadenza running on https://example.com/cadenza you could point to your own help URLs in the following way:

<?xml version="1.0" encoding="UTF-8"?>
<basicWebConfiguration>
  <publicCadenzaUrl>https://example.com/cadenza/</publicCadenzaUrl>
  <management>
    <maxConcurrentUsers>10</maxConcurrentUsers>
  </management>
  <appearance>
    <menuEntries>
      <menuEntry id="help">
        <url>https://example.com/customhelp/</url>
        <printNameKey>help.link.label</printNameKey>
      </menuEntry>
    </menuEntries>
  </appearance>
</basicWebConfiguration>

In this case the value help.link.label must exist in your custom message properties (see Customizing Message Properties) and will resolve to the language that Cadenza is started with. As a result Cadenza will show only one menu entry in the help menu with a help icon, the resolved label and the link pointing to https://example.com/customhelp.

Similarly, you can also provide different links for different locales. The configuration file could look like this:

<?xml version="1.0" encoding="UTF-8"?>
<basicWebConfiguration>
  <publicCadenzaUrl>https://example.com/cadenza/</publicCadenzaUrl>
  <management>
    <maxConcurrentUsers>10</maxConcurrentUsers>
  </management>
  <appearance>
    <menuEntries>
      <menuEntry id="help">
        <urlKey>help.link.url</urlKey>
        <printNameKey>help.link.label</printNameKey>
      </menuEntry>
    </menuEntries>
  </appearance>
</basicWebConfiguration>

In this case also the help.link.url must exist in your custom message properties.