Specifying Structured Data for a Default Form

When a class from a business object model has been used as the data type of a parameter for a user task, the default form generates controls corresponding to the attributes of the class.

Structured data is defined in a business object model such as the one that is furnished with the FormsTutorialStart project. The furnished business object model is identical to one you already created yourself if you performed the earlier tutorial "How to Create Business Data."

Note: The business object model and its component parts—the package, classes, attributes, generalizations, and compositions—are explained in greater detail in the "How to Create Business Data" and "How to Use Business Data" tutorials. It is recommended that you perform these tutorials as a prerequisite to the present tutorial.

Procedure

  1. Open the business object model in the business object model editor. To do this, expand FormsTutorialStart > Business Objects > BusinessObjectModel.bom. Double-click on BusinessObjectModel.bom. The business object model editor opens, and displays the business object model.

    Note the following details of the business object model:

    • It contains a single package, called claim, which contains all the business objects.
    • Among those business objects are two classes, NoFaultClaim and FaultClaim, that are related by generalization to GenericClaim. This means they contain all the attributes of the generic claim, including a summary of the claim, the claim amount, and a description—as well as the two composite classes in the generic claim, which represent claimants and witnesses, respectively.
    • The NoFaultClaim class and the FaultClaim class are identical, with one exception: the FaultClaim class contains an additional attribute, counterParty, which represents the other party involved in claims where fault will be assigned to one of the parties.

      The difference between the attributes defined for the NoFaultClaim class and the FaultClaim class will be reflected in the default forms, in that there will be an additional text field on the FaultClaim form for identifying the counter party.

  2. Next, we will examine the data fields that have been defined for the Notification of claim business process. Drill down in the Project Explorer to FormsTutorialStart > Process Packages > ProcessPackage.xpdl > ProcessPackage > Processes > Notification of claim > Data Fields.
  3. Three data fields have been defined for this project, Fault Claim Field, IsFault, and No Fault Claim Field. Click the data field Fault Claim Field.
  4. The General tab is displayed in the Properties view for the data field:

    Notice that the radio button External Reference is selected, and that the Reference text field identifies the FaultClaim class as the type defined in the business object model on which the data field is based.

  5. In the furnished Notification of claim business process, the data field Fault Claim Field has already been added as a parameter to the user task Record fault claim details. To verify this:
    1. Click the user task Record fault claim details in the process editor.
    2. In the Properties view, click the Interface tab. The Parameters table shows FaultClaimField as the name of the process data associated with this user task.
    3. Click the plus sign on the far right of the Parameters table to open the dialog box Select Data Field or Formal Parameter.

      Here you can see that data fields or formal parameters are added to the interface for a user task by clicking them in the Matching items list and then clicking the Add button to add them to the Selection list.

  6. Click Cancel in the dialog box to close it without changing the settings.
  7. Click the user task Record no-fault claim details. Examine the Interface tab in the Properties view, and open the Select Data Field or Formal Parameters dialog. You will see that NoFaultClaimField has been added to the interface for the Record no-fault claim details user task.