A collection is a type of user variable that contains a list of items. A collection is always one of the following types:

  • Simple collection: Contains a list of values. Each value is of the same data type (number, date, etc.)
  • Object collection: Contains a list of items (objects) that are each made up of a set of fields. For example, a Customer object would be made up of the fields First Name, Last Name, Account ID, Phone Number, and so on.

Note: For more details about collections and their configuration, refer to Defining Collections.

The Collection Display Interaction element enables you to display the items in a collection to the end user. Collections of objects are always displayed in table rows. Simple collections can be displayed in any of the following formats:

  • Bulleted list
  • Numbered list
  • Paragraphs
  • Table rows

To display a simple collection:

  1. From the Insert menu, select Collection Display. Alternatively, from the toolbar, click IconInsertCollectionDisp.
    The Collection Display Definition dialog opens.

  2. In the Reference Name field, enter an appropriate name for the element.
  3. In the Page Title field, enter text to be displayed at the top of the page.
  4. From the Select a Collection dropdown list, select the relevant simple collection.
  5. From the Display Options dropdown list, select the desired display option.
    The default display option is Bulleted List.

  6. If desired, enter a header and/or footer to be displayed before/after the collection of values.
  7. Click OK.
    The Collection Display element is added to the Interaction.

To display an object collection:

  1. From the Insert menu, select Collection Display. Alternatively, from the toolbar, click IconInsertCollectionDisp.
    The Collection Display Definition dialog opens.

  2. In the Reference Name field, enter an appropriate name for the element.
  3. In the Page Title field, enter text to be displayed at the top of the page.
  4. From the Select a Collection dropdown list, select the relevant object collection.
    The Fields tab is enabled. At the bottom of the dialog, the Display as field is populated.

  5. If desired, enter a header and/or footer to be displayed before/after the collection of values.
  6. From the Fields tab, configure the presentation of the fields:
    • To prevent certain fields from being displayed to the end user, clear the Visible checkbox in the rows of the relevant fields.
    • To change the order in which the fields are displayed, select a row. Then, at the right side of the dialog, click the Up/Down arrows, as required.
    • To change the alignment of the field in the table row, from the Align column of the relevant row, select Left, Right, or Center.

  7. Click OK.
    The Collection Display element is added to the Interaction.

Revision:

Comments