Skip to content

Working with the Form Editor

The Form Editor provides a graphical user interface enabling you to create and edit forms without having to edit the xml directly.

The Form Editor contains the following sections:

  • Detail View -- detailed information about the selected form

  • Expandable Tree View -- provides an ordered, hierarchical view of the form components

  • Edit Options -- the available attributes for the selected form item

Detail View

This section displays the detail information about the selected form on clicking the Details button. The following table lists displayed attributes for the respective Form Type:

Form Type Attributes
Application Provisioning Policy Form Title, Subtitle, Wizard, Owner
Role Provisioning Policy Form Title, Subtitle, Wizard, Application, Owner
Workflow Form Title, Subtitle, Wizard

Expandable Tree

The expandable tree section provides an ordered and hierarchical view of the form components.

The tree section can be subdivided into the following components:

Action buttons

Buttons for following actions:

  • Add Section -- adds section to the expandable tree view

  • Add Button -- adds button to the bottom of the expandable tree view. The Add Button is applicable to Workflow Approval Forms.

    • Preview Form -- displays the form layout for all included form components in the editor. Helps to preview the form while developing a form to see how it renders on actual operations.

Components in the tree view

These are the different components of the tree panel:

  • Section -- Multiple sections can be added to the tree panel through the Add Section button. Using + icon Fields and Row with Columns can be added. The Section item can be expanded or collapsed by clicking on them.

    • Add Field -- Fields can be added under the Section.

    • Add Row with Columns -- Rows with a maximum of four columns can be added under the Section using the Choose how many columns in this row dropdown list under the Edit Options section.

      Note

      When using Rows, the columns attribute of Section and columnSpan attribute of Field would be calculated by Form Editor and existing values would be overwritten.

  • Button -- All the defined Buttons are added at the end in the tree panel.

Reordering Form Components

Form components can be reordered using the drag / drop feature in the following way:

  • Sections -- sections can be reordered. Sections cannot have sections within them.

  • Rows -- rows can be reordered within the Section or dragged and dropped into any Section.

  • Fields -- fields can be reordered within Rows or dragged and dropped into any Section.

  • Buttons -- can be reordered only within Buttons.

Note

For inappropriate moves of the form components the not allowed icon is displayed.

Edit Options

The Edit Options section on the Editor page displays the attributes that must be modified for the respective actions.

Click on the Apply button after the attributes are modified.

Section

Attributes Description
Basic
Name Internal name for section.
Label Label of Section determines Section text on Edit page. Labels can be specified as text, message catalog keys, or variables (specified with $(variableName) notation).
Subtitle Section subtitle as description (displayed at the top of the section, above all fields in the section).
Settings
Hidden Boolean that, when true, prevents the field from being displayed on the form.
Read Only Section properties are read only.
Hide Nulls When set to true, hides fields within the section which have a null value.

Fields and Rows

Attributes Description
Settings
Name Name for the field that can be referenced in code as the variable name in which the fields value is stored
Display Name Label for the field; can be text or a message key.
Help Text The text that appears when hovering the mouse over the help icon.
Type Select the type of field from the drop down list. Select from the following:
  • Boolean -- true or false values field.
  • Date -- calendar date field.
  • Integer -- only numerical values field
  • Long -- similar to integer but is used for large numerical values.
  • Identity -- specific identity in IdentityIQ field.
  • Secret -- hidden text field.
  • String -- text field
  • Application -- list of existing application
  • Role -- existing type of bundles
    		•
    Type Settings
    Multi-Valued Enable this to have more than one selectable value in this field of the generated form.
    Refresh On Change Boolean that, when true, causes the form to refresh when the fields data value changes, running any rules or scripts that run on form reload.
    Authoritative Enable to have the field value override the current value rather than merge with it. Applicable only for multivalued attributes.
    Required Boolean indicating whether a value is mandatory for the field; required="true" marks field with * on form to indicate required and prevents form submission without a value for the field.
    Read Only Determine how the read only value is derived:
  • True -- value based on the selection from the drop down list
  • Rule -- value is based on a specified rule
  • Script -- value is determined by the execution of a script
    		•
    Hidden Boolean that, when true, prevents the field from being displayed on the form.
  • True -- value based on the selection from the drop down list
  • Rule -- value is based on a specified rule
  • Script -- value is determined by the execution of a script
    		•
    owner The owner of the field / row. This is determined by selecting from the following:
  • None -- no owner is assigned to this field/row
  • Requester -- sets the Owner to this field/row
  • Rule -- use a rule to determine the owner of this field/row
  • Script -- use a script to determine the owner of this field/row
    		•
    Value Settings
    Value Sets the default / initial value for the field / row. This can be overwritten on the form if the field /row is not marked as Read Only. Select None, Value, Rule or Script option.
    Allowed Values Specifies a set of values from which the user can select to assign the field value. Automatically created for fields with an allowed values property set to Value (with a list of values specified) through user interface specification. Select Value, Rule, or Script.
    Validation Ability to specify a script or rule for validating the user's value by selecting None, Rule or Script.

    Button

    Attributes Description
    Settings
    Action Action determines what the system does in response to clicking the associated button. Select one from the drop down list:
  • Next -- used in the Transition logic to advance the workflow to the next step
  • Back -- used in the Transition logic to return to a previous step or any other appropriate action for a rejection.
  • Refresh -- save the entered form data and regenerate the form; not a state transition just a redisplay of the form
    		•
    Read Only Determines whether to show a button or not on the form renderer.
    Skip Validation Determines if client-side required item validation is necessary based on the button clicked by the user. Validation is required if the button is not configured to skip validation, the action is NEXT and there are required items.
    Label Determines the text displayed on the button.
    Parameter Action-parameter of the button.
    Value Action-parameter value.