Create a formatter

Creating a custom formatter involves three tasks.

  1. Create a UI macro to define content for the formatter.
  2. Create a formatter that refers to the UI macro.
  3. Add the formatter to the form.

Create a UI macro for a formatter

Create a UI macro to define the content that the formatter displays.

Before you begin

This functionality requires a knowledge of Jelly script.

Role required: ui_macro_admin

Procedure

  1. Navigate to System UI > UI Macros.
  2. Click New.
  3. Complete the form.
  4. In the XML script field, enter Jelly script to define the content to be displayed by the formatter.
    Note: The UI Macro for the formatter represents a row in the UI. It must begin and end with <TR></TR> tags.
    Formatter UI macro

    This Jelly script is reproduced below in plain text that you can copy into the Macro form as a basis for your macro script.

    <?xml version = "1.0" encoding = "utf-8" ?> 
     <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null"> 
     <tr> 
        <td colspan="2">
           Here  is some descriptive text  for the Priority field.
        </td> 
     </tr> 
     </j:jelly>
  5. Click Submit.

Create a formatter and add it to a form

Create the formatter after creating the UI macro that defines the content.

Before you begin

Role required: admin

About this task

With the UI macro in place, create the formatter that references it, and add it to the form.

Procedure

  1. Navigate to System UI > Formatters.
  2. Click New.
  3. In the Name field, enter a descriptive name for the formatter.
  4. In the Formatter field, enter the name of the UI macro with .xml appended to it.
  5. In the Table field, select the table in which the formatter will be used.
  6. In the Type field, select Formatter.
  7. Click Submit.
  8. To add the formatter to a form, configure the form.
    The formatter appears on the form according to your selections.