Customizable Help Topics

Help buttons can be found at different places of the user interface within Cadenza. Clicking on one of these buttons opens a help page in a new browser tab or window. The help page shown contains help texts and illustrations directly related to the current context of the application. These help pages can be customized by overriding them in the way described below and thus adapted to the respective customer scenario.

Configuration

Set a system property or an environment variable named HELP_TOPICS_BASE_PATH (see Environment Variables, System Properties and Other Runtime Configuration Options) that points to a folder with your help topics. The folder must contain further folders for every language that is relevant for your Cadenza installation (currently de and en are supported subfolder names).

The path has to end with the folder name containing the locale subfolder(s) without the ending slash /.
Example:

If Cadenza is installed on a Windows system and the language Cadenza will be launched with is German and the HTML help page files should be located in the folder H:\CadenzaCustomization\helptopics\de the system property or environment variable HELP_TOPICS_BASE_PATH has to be set to H:/CadenzaCustomization/helptopics.

Example 1. Different Languages

The German localization of the different HTML pages have to be placed in the subfolder de of the configured HELP_TOPICS_BASE_PATH.

The only other currently supported language in Cadenza is English.

The English localization of the different HTML pages have to be placed in the subfolder en of the configured HELP_TOPICS_BASE_PATH.

Modifying Help Pages

Cadenza has a fixed set of help pages you can override by inserting these pages in the specified directory in the subfolder of the appropriate language. The file name of a help page must exactly match the file name of the page to be overwritten, otherwise the overwrite mechanism will not work. Find the file names and a short description for them in the section Customizable help topic page files and short description.

The help page files are read and delivered in the UTF-8 encoding so make sure your editor is also using this setting. This becomes relevant when entering non-ASCII characters such as 'รค' for example.

If you do not override a help page, the internal Cadenza default is used.
You may also customize the header of the help pages (see Writing Custom Page Content).

Customizable help topic page files and short description

File name Where is it displayed? 
 cch-import-wizard--attributes.html

On the More Attributes page of the Import Data wizard for importing files to Cadenza Workbooks.

 
 cch-import-wizard--file.html

On the File page of the Import Data wizard for importing files to Cadenza Workbooks.

 
 cch-import-wizard--contents.html

On the Contents page of the Import Data wizard for importing files to Cadenza Workbooks.

 
 cch-import-wizard--file-interpretation.html

On the Interpretation page of the Import Data wizard for importing files to Cadenza Workbooks.

 
 cch-import-wizard--objecttype.html

On the Object type page of the Import Data wizard for importing files to Cadenza Workbooks.

 
 cch-import-wizard--spatial-reference.html

On the Spatial page of the Import Data wizard for importing files to Cadenza Workbooks.

 
 cch-import-wizard--temporal-reference.html

On the Temporal page of the Import Data wizard for importing files to Cadenza Workbooks.

 
 cch-import-wizard--validation.html

On the Validation page of the Import Data wizard for importing files to Cadenza Workbooks.

 
 cch-import-wizard--data-protection.html

On the Data protection page of the Import Data wizard for importing files to Cadenza Workbooks.

 
 cch-query-editor--cql-syntax.html

On the dialog for creating or editing a query condition in Cadenza Workbooks.

 
 cch-filters--ela-like-query-syntax.html

Next to the Pattern option of a text pattern condition created for an Elasticsearch attribute in Cadenza Workbooks.

 
 cch-animation-settings.html

In the preview of the date filter map animation.

 
 cch-enrichment--measures-from-spatial-overlay.html

In the "Data enrichment by spatial overlay" dialog.

 
 cch-workbook-dialog--simplified-operation.html

On the "Simplified operation" page of the workbook management dialog.

 
 cch-mc-ot--attribute-relations.html

In the dialog for managing attribute relations.

 
 cch-mc-ot--function-formula.html

In the dialog for editing the formula of a function attribute.