Find 24.3

# Configure User-Friendly Names for Fields and Values

You can configure Find to display user-friendly names for fields and values in the user interface, in place of the values from your raw data. Find uses the display names that you specify in the parametric filter lists, as well as document metadata and the fields in document previews.

NOTE: You cannot modify the display name for the standard metadata fields that display in the full page document preview (for example, `title`, `reference`, and `database`).

You configure user-friendly display names by adding and modifying the `fieldsInfo` section of the Find configuration file.

To configure display names for fields and values

1. Go to the Find home directory.
2. Open `config.json` in a text editor.

3. Find or add the `fieldsInfo` section.

4. Create a property and definition object for each field that you want to modify. You can use the following properties:

   `names` | (Array, strings) An array of raw field names that you want to apply the field and value display names to.
   `displayName` | (String) The user-friendly display name to use in the Find user interface. NOTE: If you specify a display name, Find applies it to all the fields in the `names` array. This might result in multiple identical field names listed in the parametric filter list, corresponding to the different raw fields in your data. In general, OpenText recommends that you do not specify the display name if you set multiple values in `names`. You can specify multiple field names without the display name to normalize the field values to consistent display values.
   `values` | (Object) A JSON object to specify a field value and the display value to use for that value. This object has the following subproperties: `value` (string). The raw data value. `displayValue` (string). The user-friendly display name to use for this value.
   `advanced` | (Boolean) A Boolean value that specifies whether to display this field in document previews. For more information, see Configure Fields to Show or Hide in Document Previews.
   `csvExport` | (Boolean) A Boolean value that specifies whether to include this field in the CSV export. For more information, see Configure Fields to Export.

   For example:

       "fieldsInfo": {
          "country": {
             "names": [ "COUNTRY_ORIGIN" ],
             "displayName": "Country",
             "values": [ { "value": "UK", "displayValue": "United Kingdom of Great Britain and Northern Ireland" } ]
          },
          "elevation": {
             "names": [ "PLACE_ELEVATION" ],
             "displayName": "Place Elevation (ft)"
          }
       }

   The user interface displays a field called Country, with the value United Kingdom of Great Britain and Northern Ireland, and a Place Elevation (ft) field.

5. Save the file, and then restart Find to apply your configuration changes.

Copyright 2015-2024 Open Text
Version 24.3 | Last updated June 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Find 24.3

Topic Title: Configure User-Friendly Names for Fields and Values