Defining the user interface

To control how pattern users view and edit pattern parameters in the Pattern Instance editor after the pattern user has created an instance of a user-defined pattern, you must define the user interface.

Before you begin

Complete the following tasks:

About this task

When a pattern user creates an instance of a user-defined pattern, the parameter groups and pattern parameters that are defined in the Pattern Configuration tab of the Pattern Authoring editor are displayed in the Pattern Instance editor. If the Pattern Configuration tab displays groups or parameters that you do not want in the final pattern, you must delete them from the Pattern Configuration tab before building the pattern plug-ins.

To define the user interface, open the Pattern Configuration tab of the Pattern Authoring editor. In the Groups and Parameters list, entries are shown in a hierarchy in which groups contain pattern parameters, and pattern parameters contain target properties.

Procedure

To define the user interface, choose one or more of the following options:

  1. You can define the groups in which pattern parameters are displayed and assign target properties to pattern parameters:
    1. To define the groups in which pattern parameters are displayed in the Pattern Instance editor, drag pattern parameters to groups.
      To add new groups or edit existing groups, see Adding and editing parameter groups. To control whether parameter groups are enabled by using XPath expressions, see Enabling parameter groups.
    2. To assign target properties to pattern parameters, drag target properties to pattern parameters.
      If the target property and pattern parameter do not use a compatible editor, an error message is displayed; see step 5 to change the parameter editor. If you drag multiple target properties to one pattern parameter, all target properties in that pattern parameter are populated with the same value that is entered for the pattern parameter by the pattern user.
  2. To add a new pattern parameter, click Add Parameter, and click OK.
    To configure the new parameter, see steps 4 and 5.
  3. To remove a pattern parameter or parameter group, select the pattern parameter or parameter group to remove and click Delete.
    • To remove a parameter group it must have no pattern parameters assigned to it.
    • To remove a pattern parameter it must have no target properties assigned to it. To remove a target property so that you can remove a pattern parameter, clear the target property in the Message Flow editor of the Application Development view. For more information about defining target properties, see Defining the target properties. When you remove a target property in the Message Flow editor, the associated pattern parameter and parameter group are not automatically deleted in the Pattern Configuration tab of the Pattern Authoring editor.
  4. You can change the name of a pattern parameter, create help text, create a field prompt, and configure parameter options in the Basic tab. In the Groups and Parameters list, select the pattern parameter and click Edit, or double-click the pattern parameter. The Edit Parameter window opens.
    • To change the name of the pattern parameter, enter a name for the pattern parameter in the Display Name field and click OK. The name for the pattern parameter is changed to the new name.
    • To change parameter options, select or clear the Hide the parameter and Mandatory parameter check boxes, as required.
    • To enter a field prompt, type a text into the Field prompt field.
    • To provide help text for the pattern parameter, type the text in the Help Text (HTML) field.
    • To close the Edit Parameter window after you have completed your changes, click OK.
  5. You can change the parameter editor, and set a default value for a pattern parameter in the Editor tab. In the Groups and Parameters list, select the pattern parameter and click Edit, or double-click the pattern parameter. The Edit Parameter window opens. Click the Editor tab.
    • To change the parameter editor, select the required editor in the Parameter editor list.
      • To use an enumerated type for the parameter, select Drop Down Selection in the Parameter editor list, then select an enumerated type for the parameter in the Type selection field. For more information, see Using enumerated values for pattern parameters.
      • To use a table type for the parameter, select Table Editor in the Parameter editor list, then select a table type for the parameter in the Type selection field. For more information, see Using tables for pattern parameters.
      • To use a user-defined editor for the parameter, select User-Defined Editor in the Parameter editor list. For more information, see Using user-defined editors for pattern parameters.
    • To enter a default value for a pattern parameter, if Parameter editor is Drop Down Selection or Check Box, select a value from the Default value list. Otherwise, enter a value in the Default value field.
    • To close the Edit Parameter window after you have completed your changes, click OK.

What to do next

You can build the pattern plug-ins, see Building pattern plug-ins.