6.3 Creating Forms

This section describes how to create new forms and add controls to them. It includes these topics:

6.3.1 Creating New Forms

  1. With the provisioning request definition editor open, click the Forms tab.

  2. In the Form Selection section of the page, click Add to access the New Form Wizard.

  3. Fill in the fields as follows:



    Form Name

    Type the name of the form as you want it to appear in Designer.

    Create a form using one of the templates

    If you want to base the new form on an existing template, select this option and select one of the forms from the Form templates list.

  4. Click OK to save the form or click Cancel to exit without saving.

6.3.2 Adding Form Controls and Actions

Use the Form Controls section to define the content and layout of the form.

NOTE:The Designer places form controls on the form from top to bottom and left to right. Use Linebreaks to force spacing between controls

To add a control to a form:

  1. Click Add. Designer adds a control named Field to the bottom line of the form.

    If you add more than one control of the same name to the form, Designer adds a unique number to the end of the control name.

  2. Define the following properties for the control:



    Form Field Name

    A unique name for the field. The name is used in

    • The Workflow tab’s Data Item Mapping dialog box.

    • The ECMA expression builder dialog box.

    • An internal XML reference in the provisioning request definition file.

    Consider the naming conventions you want to use for form fields to avoid confusion in the Data Item Mapping and ECMA expression builder dialog boxes. For example, the request and approval forms might both contain a field called Reason. To make it clear which field you are working with while performing data mappings, you can preface the field name with the name of the form where it is used. You might name one reason field Req_Reason and the other App_Reason.

    Data Type

    The field’s data type. The data type determines the valid control types and the type of validation performed.

    Control Type

    The type of visual control used to display or edit the data. The selection list is filtered based on the selected data type.


    Defines the number of lines you want inserted after the control.

    Form field controls do not have Data Item Mappings or E-mail notifications property sheets.

  3. For each control, specify its properties in the Properties tab (available via Window > Show View > Properties). For more information, see Section 6.5, Form Control Reference.

  4. Click the Actions tab to define what the user can do with the form. For example, you can add actions that allow the user to submit a form or cancel it.

    A request form must have, at a minimum, a SubmitAction. Without a SubmitAction, the request will not process. It is recommended that every form also have a CancelAction. Each approval form must have at least one action defined.

  5. In the Actions page, click Add to add a new Action. Fill in the fields as follows:



    Actions Location

    Choose the location for the action buttons you add to the form.

    Bottom. Places the action buttons on the bottom of the form. (Default.)

    Top: Places the action buttons on the top of the form.

    Top and Bottom: Places the buttons at both the top and bottom of the form.

    Action Command

    Choose an action for the button. For more information, see Section 6.4, Action Reference.


    Defines the number of lines you want inserted after the action button.

  6. Save the form.

6.3.3 Defining Events

The scripts you attach to an event handler are scoped to the appropriate control, not the browser window.

Defining an Event

  1. Select the form control where you want to define an event and open the property sheet.

  2. Navigate to the Event property and add an event. Designer adds a row with the default event name onEvent.

  3. Click in the Event Name field and select the onchange or onload event. For more information on adding other events, see Creating Custom Events.

  4. Click in the Action Expression field. You can type the script directly in this field, or click the button to access the Event Action Expression Builder.

  5. Define the action script, check the syntax, then click OK. Repeat this procedure to add more events to this control.

For more information on the onChange and onLoad events, see the events property description in Section 6.5.2, General Form Control Properties.

Creating Custom Events

You can create your own events to notify other controls of conditions or user actions on the form. You create the event using the Events property. You can give the event any name. You must explicitly fire the event using the fireEvent() method and passing in the name of the event.

You might want to perform a query on the Groups container that returns only the groups that match the values entered by a user. In the example shown in Figure 6-7, the user types a value in the name field, When the user tabs to the next field, the contents of the drop-down list are populated from a query launched by the namechange custom event.

Figure 6-7 User Application Runtime Custom Event Sample

The Name field defines an Events property that fires the namechange event on an onchange event. The definition is shown in Figure 6-8.

Figure 6-8 Sample field.FireEvent() Method

The namechange event contains an expression that executes a query called groups.

Figure 6-9 Custom Event Definition Example

For more information on using queries, see Section 6.7, Using DAL Queries in Forms.

6.3.4 Using the Scripts Tab

Use the Scripts tab to define a script that has a page-level scope. A page-level scope means that the script loads at page load time and is available through the life of the form. You can supply the script in one of the ways described in Table 6-2.

Table 6-2 Script types

Script type



The script is incorporated into the page by reference using the supplied URL. The script block will look something like this: <<script type=”test/javascript” scr=”http://some.server/custom.js”>. The custom.js file is imported at form load.


The script is inserted directly into the form in a <script> block.

Because these scripts are loaded at page load, the form controls and any of their associated event handler scripts are not in scope when the page is loaded. Avoid coding dependencies between page-level scripts and event-level scripts; however, you can call page-level scripts from within an event-level script.

To add a link to an external JavaScript file:

  1. With the Scripts tab open, click Add .

  2. Complete the fields as follows:




    Specify a meaningful name. This value displays in the Event Action Expression Builder.


    Leave the default value of external.

    URL/Inline Script

    Click within the field so that the Script URL Editor button displays to the right, then click the button to display the editor.

    Type the URL to the .js file and click OK to return to the Scripts tab. Adding an external link generates this line in the page that displays the form:

    <script src=" someURL.com/script.js"/>

To create an inline script:

  1. With the Scripts tab open, click Add .

  2. Complete the fields as follows:




    Specify a meaningful name. This value displays in the Event Action Expression Builder.


    Set the value to inline.

    URL/Inline Script

    You edit your JavaScript using the ECMAScript Editor. You can access the editor by clicking the tab of the same name as the ID you specified above. This tab is located next to the Signatures Declarations tab.

    For inline scripts, the following is inserted in the page:

    <script>whatever you type</script>

Both inline and external scripts are executed at page load but before the page loads the controls. In addition, they are also executed when specifically called on a form control event.