AX1601
for Axiom forms
The Form Help component displays custom help text in an Axiom form. You can use this component to provide information and instructions about the current form to end users.
For example, you may have a form that is used to gather user inputs and save them to the database, and you want to provide users with guidance on how certain fields in the form should be filled out, or give users information on how the inputs will be used after saving. Or the form may contain reporting data and charts, and you want to provide users with more information on the data, or explain certain terms and abbreviations used in the charts.
The Form Help component displays as a question mark icon in the form. When a user clicks on the icon, a panel slides out from the right-hand side of the form to display the help text associated with the component.
Example Form Help component
Displaying custom help for an Axiom form is a two-part process that requires the following:
-
Defining a help code and the associated help text that you want to display in the form. This is done separately, using the Form Help Admin page in the Web Client. For more information, see Managing custom help codes. (If a help code already exists for your desired text, you can use that code in as many forms as needed.)
-
Placement and configuration of a Form Help component on the Axiom form canvas. When configuring the component, you specify which help code it should use.
The Form Help component can be used by itself, or in conjunction with the form-level Help Code property. For example, you might use the form-level help code to provide overall help for the form, and then use the Form Help component to provide context-sensitive help for particular sections, fields, or other items in a form.
NOTE: If you want to use a Form Help component in conjunction with a Menu component, to provide help on the various tabs in the menu, then you can specify the help codes directly in the Menu data source. For more information, see Menu component for Axiom forms.
You can define the following properties for a Form Help component.
(missing or bad snippet)(missing or bad snippet)| Item | Description |
|---|---|
Help Code | The code that identifies the help text to display in the help panel. For example, you might have a defined code such as Help_Comment_Input that defines help text for a form named Comment_Input. Help codes and their associated text are defined separately, using the Form Help Admin page in the Web Client. For more information, see Managing custom help codes. Currently, it is not possible to look up a help code from within the component properties. You must already know the appropriate code and manually enter it. Or, if you are an administrator, you can go to the Form Help Admin page, search for the appropriate code, and then copy / paste it into the component properties. If the specified code does not match a defined Form Help code in your system, then clicking the help icon will do nothing in the rendered form. No error will occur. |
Currently, the Axiom Financial Institutions Suite platform does not provide any styles specifically designed for Form Help components. Only the generic styles are available.
(missing or bad snippet)(missing or bad snippet)NOTE: The size of the Form Help icon is fixed and does not respond to changes to Width and Height. If you size the component larger than its default size, this will just increase the space taken up by the component; it will not make the icon larger.
Component behavior
The Form Help component displays as a blue question mark icon. It is not possible to change the size or appearance of this icon. The intent is to provide a consistent icon so that users can easily identify the icon in their forms and instantly understand its purpose.
When a user clicks on the icon, a standardized help panel slides out from the right-hand side of the form and displays the help text for the specified help code. The panel overlays the form.
To close the panel, the user can click the question mark icon in the gray task bar, or click inside the form.
