How to edit a form

The Service Management Form Editor is a simple user interface that enables you to view and edit a form. The Form Editor enables you to:

  • Add a field, association, or section to a form.

  • Rearrange the field order to change the position of the parts of a form.

  • Configure properties of parts of the form.

The Forms tab, which includes the Form Editor, enables you to view and edit the forms for a record.

Note  

  • The existing forms for a record type are provided out-of-the-box and may be edited, but you cannot add a new form.
  • If you have development and production tenants, all configuration changes must be made on the development tenant. For more information about synchronizing the tenants, see Dev2Prod - How to synchronize your development and production tenants.

Form Editor

To access the Form Editor, from the main menu, select Administration > Configuration > Records > Forms.

  • The tab displays the forms for the record type selected in the drop-down list at the top of the page.

  • If the record has more than one form, you can select the form you want to view or edit, using the drop-down list at the top of the Forms tab.

You can do the following in the Form Editor:

Add a field

You can add a Service Management field to a form. To add a field:

  1. Select the section of the form where you want the field to appear.

  2. Click Add field.

    The Select fields dialog box appears. This displays the fields belonging to the record type. For more information about fields, see Fields, and Generic relationship fields.

  3. Click each field you want to add. (Click again to cancel your selection.)

    Note  

    • You can select more than one field.

    • The number of fields you select, and the section of the form, appear at the bottom of the dialog box.

    • You can change the section of the form, using the drop-down.

  4. Click Done.

    The selected fields appear in the form. You may now edit the fields.

  5. Click Save.

  6. If you want to add more fields to another section, click Add and continue the selection.

Edit a field

You can edit a field in a form. To edit a field:

  1. Select the field.

    The field properties appear in the right pane.

  2. Edit the properties as required.

    Property Description
    Name The name of the field.
    Display name

    The label of the field that Service Management displays in the user interface.

    To edit:

    • Type the name in the box in the right pane.

    • Click the ellipsis button to select a different language.

    Type The field type. This is read-only.
    Editor

    The type of editor available for the user to edit the field contents.

    For the following field types, Service Management automatically populates this property as follows:

    Field type Editor
    SMALL_TEXT TextBox
    LARGE_TEXT TextArea
    ENUM DropDownList
    ENUM_SET MultiDropDownList
    BOOLEAN CheckBox
    ENTITY_LINK EntityPicker
    DOUBLE NumericTextBox
    PERCENTAGE Percentage
    IMAGE Image

    For the following field types, you can select the editor type from the drop-down list:

    Field type Editor options
    MEDIUM_TEXT
    • TextBox. Text is displayed on a single line.

    • TextArea. Text is displayed on multiple lines.
    RICH_TEXT
    • RichEditor. Text can be displayed in HTML.

    • TextArea. Text is displayed in plain text.
    DATE
    • DatePicker. Select a date from the calendar.

    • DateTimePicker. Select a date and time from the calendar.
    INTEGER
    • DurationPicker. Select a duration from the drop-down list.

    • IntegerTextBox. Enter an integer.

    Note The value range for INTEGER field type is -2147483647 to 2147483647.

    URL
    • TextBox. Text is displayed on a single line.

    • Link. Text is displayed on a single line. Click URL button to open a browser window.
    DATE_TIME
    • DatePicker. Select a date from the calendar.

    • DateTimePicker. Select a date and time from the calendar.
    EMAIL
    • TextBox. Text is displayed on a single line.
    • Email. Text is displayed on a single line. Click Email button to open a new email message.
    Size

    The width of the space available to type in field contents. Service Management automatically populates this property based on the field type.

    The available sizes are:

    • Medium. A field with a size of medium displays in half the width of the form.

    • Large. A field with a size of large displays in the whole width of the form.

    Index

    The order of the field in the contents of the form. A field with an index of 1 is first in the form, and so on.

    To change the order of the field:

    1. Select the field.

    2. Click Move up or Move down (as appropriate) in the right pane.

    Start on a new line If selected, the user interface displays this field at the start of a new line in the form.
    Precision

    The lowest unit of time displayed for a field using the DurationPicker Editor.

    For example:

    • If you select Minutes, the editor displays days, hours, and minutes.

    • If you select Hours, the editor displays months, days, and hours.

  3. Click Save.

Add an association

You can add an association to a form. Each association is a self-contained section. You may not add anything else to a section with an association.

To add an association:

  1. Select the section of the form where you want the association to appear.

  2. Click Add association.

    The Select associations dialog box appears. This displays the available associations.

  3. Click each association you want to add. (Click again to cancel your selection.)

    Note You can select more than one association.

  4. Click Done. The selected associations appear in the form.

  5. Click Save.

Add a section

You can add a section to a form. To add a section:

  1. Click Add section.

    The section appears at the bottom of the form, with the properties in the right pane.

    You can move the section by changing the order in the form. See Change the order of a field or section.

  2. Edit the section properties as required.

    Property Description
    Name

    The name of the section.

    Caution The name of the section must be in upper camel case. For example: GroupData.

    Header

    The display name of the section.

    To edit:

    • Type the name in the box in the right pane.
    • Click the ellipsis to select a different language.
    Expanded If selected, on loading the form, the user interface displays this section fully expanded.
    Hide header If selected, the section is not visible in the user interface.
  3. Click Save.

Note When adding a new section to a form in Administration > Configuration > Records > Forms, you must add fields to the section before saving it.

Edit a section

You can edit the section of a form. To edit a section:

  1. Select the section.

    The section properties appear in the right pane.

  2. Edit the section properties as required.

    Property Description
    Name

    The name of the section.

    Caution The name of the section must be in upper camel case. For example: GroupData.

    Header

    The display name of the section.

    To edit:

    • Type the name in the box in the right pane.
    • Click the ellipsis to select a different language.
    Expanded If selected, on loading the form, the user interface displays this section fully expanded.
    Hide header If selected, the section is not visible in the user interface.
  3. Click Save.

Change the order of a field or section

You can change the order of a field or a section. To change the order:

  1. Select the field or section of the form.

  2. In the right pane, click Move up or Move down as appropriate.

    The selected field or section moves up or down in the form.

  3. Click Save.

Add Insert More/Less point

You can add an expand and contract control in your form. This displays as More or Less on the form. The user can view or hide those parts of the form below the control by clicking it. To add the control:

  1. Select where in the form you want the control to appear.

  2. Click Insert More/Less point.

  3. Click Save.

Note  

  • When you select part of a form, its properties appear in the right pane.

  • To delete part of a form, select it and click Delete in the right pane.

  • To move from one part of the form to another, click Previous or Next in the right pane.

  • To discard all your changes at any time before you have saved them, click Discard.

  • You must save your changes for them to be effective.

Related topics