Field instructions

Technologies / User Interface Add-Ins / Assemblies with Multiple Panels / Find-Manage with Categories

You can add per-field help to display either instruction text next to the field, or an icon with a tooltip.

To display the instructions text next to the field, add the instructions element to the field:

     <field ...>
<instructions>The KB priority ranges from 0 (do not work on the KB) to 100 (do immediately). </instructions>

To display the help icon with a tooltip next to the field, add the tooltip element to the field:

     <field ...>
<tooltip>The KB priority ranges from 0 (do not work on the KB) to 100 (do immediately). </tooltip>

form_instruction.png

You can change the instructions text or its style properties such as color dynamically from Java Script code:

var instructionsEl = form.fields.get('wr.location').getInstructionsEl();
instructionsElement.innerHTML = getMessage('status_text');
instructionsElement.className = 'instructionWarning';

Recommended practices:

  • Use instructions to make help obvious for casual users. Keep the text short so that it does not obscure the form data.
  • Use tooltip to provide more extensive instructions.

Example view:

http://localhost:8080/archibus/schema/ab-products/solutions/assemblies/work-wizard/ab-ex-work-wizard-create.axvw