Customize Tooltips

Information

PLANTA makes different types of tooltips available:

• Automatic tooltips are displayed on the headings which are truncated due to insufficient field length. In this case, the tooltip shows the entire heading.

• Tooltips with hard-coded help texts or explanations for the field in question. Such tooltips can be stored on both regular fields and bars.

• Tooltip modules which show additional data for the field in question based on the parameters defined in the tooltip module and depending on the selected record.

Tooltips with hard-coded content

Procedure

• In the customizer, open the data area which contains the data field for which you want to define a tooltip.

• Enter the required text in the Tooltip parameter in window 3 or use the required variables for output of dynamic contents (e.g. dates). For further information, please refer to the description of the Tooltip parameter.

Tooltip Modules

Information

• Tooltip Modules enable you to use the content of a module as tooltip and to have different data displayed in the tooltip of a field, depending on the respective record. They thus present an alternative to tooltips with hard-coded texts.

Procedure

• Customize a tooltip module like a regular module.

• Set the Class parameter to 4.

Embed Tooltip Module

• Enter the ID of the tooltip module in JSON format at the following positions, as shown in the example below:

  • either in the data field configuration of the required data field in a module, if the tooltip is only to be displayed in that very module.

  • or in the

    Data item configuration

    of the required data item, if the tooltip is to be displayed in all modules in which the data item is used.

    • If a data item has an entry in the data item configuration and at the same time it has a deviating entry in the Data field configuration, the entry in the Data field configuration overrides the entry in the data item configuration.

Example

{
   "Tooltip": {
      "Module": "009DQ6"
   }
}

Customizing Rules

• Tooltip modules can only contain one data window.

• From a performance point of view, a tooltip module may only contain the data fields which it requires. These are data fields which

  • are used for sorting or filter criteria of the tooltip module.

  • are required for the correct output of the visible sorting or filter criteria fields.

• The tooltip module must

  • only contain the visible traffic lights.

  • not contain buttons, links, listboxes, and other interactive elements.

Override Rule

Note

• The defined tooltips override automatic tooltips.

• The tooltip modules override defined and automatic tooltips.