Adding help text to fields

You can write help text that describes a field or provides instructions about how to use it.

Before you begin

The maximum length of the help text is 254 characters.

Procedure

To add help text to a field:
  1. In the Schema Repository Explorer view, expand the Record Types folder in your schema and then double-click on a record type.
    The record type editor opens.
  2. Click the Fields tab to view the Record Fields grid.
  3. In the Record Fields grid, select the field to which you want to add help text.
  4. In the Properties page for the Field, click the Help Text section.
  5. Enter the help text. The text limit is 254 characters, which is about two-thirds of the space available in the Help Text box.
  6. To make the help text available, check in the schema and upgrade the user database.

Results

To view the help text in HCL Compass Client, right-click a field and click Help.

To view the help text in the HCL Compass Web client, position the cursor over a field name and click when you see the question mark.