Portlet Factory, Version 6.1.2

 

Rich Data Definition builder

The Rich Data Definition builder lets you associate rich user interface (UI) descriptions with fields that are defined in a schema. The Rich Data Definition builder provides the most automated way of controlling the detailed user interface for application data fields. With it, you can automatically control the UI in the following ways.

  • Add formatting or validation to a field. For example, you can format or validate a date, remove characters from a string, or apply labels.

  • Specify user-friendly labels for fields.

  • Specify lookup tables to provide user-friendly lists of choices.

  • Change the UI behavior of a field. For example, apply data entry controls, restrict to view only, or make a link for a field.

  • Automate control of all field behavior for a field type. For example, use a Calendar Picker builder on all date fields.

  • Control data formatted in columns. For example, make column names easier to read, hide columns that do not need to be displayed, add sorting capability, adjust column width, and align columns.

This builder works by associating UI descriptions with a schema. When the schema is used to generate page elements (with Data Page builder or View & Form builder, for example), all of the UI characteristics are automatically applied to the page. Because this builder also uses of the functionality of the Data Field Modifier builder, you can use that builder to learn about specific settings, for example, validation and formatting.

This builder modifies the schema before the schema is used by the Data Page builder to create the visual elements for a page. In contrast, builders such as Data Field Modifier and Data Column Modifier modify the definition of the elements that go on the page. Therefore, if you use the schema for two different variables that are used by two different Data Page builders, you see the effects of the Rich Data Definition builder on both variables.

In this builder, after you describe the data based on fields in a schema, you can save the descriptions in a data definition file so that they can be reused. You can place common data definitions in a shared base library. For example, you can create a base library that has all the information about how date fields should be presented, and you can reference that library in all of your models.

 

Key inputs

In most common applications of this builder, these are the inputs you need.

  • Schema

    This is a required input. The schema defines the fields to modify in a form or data page.

  • Data Definition Type

    The first time that you use this builder, enable Specify Data Definitions in Builder UI. After you enter individual properties that are applied to the schema, use Save Sample Data Definition File to write the properties to an XML file. This file can be used as a base definitions file for other data definitions files or can be reused for other schemas.

    Enable Read Data Definition File to apply a previously saved data definitions file to the schema. The data definition information attached to a schema is used internally by the Data Page builder for modifying the data display.

  • Data definition properties

    You can include various data definition properties in a data definition file. You must add the properties directly to the XML file because the properties are not exposed in the Rich Data Definition builder.

 

Key objects this builder creates

This builder primarily works by attaching information to existing schema objects. In some cases, such as Lookup Tables, it also creates auxiliary objects.

 

Samples

A sample model incorporates data definitions and illustrates techniques for applying data definitions. 
models/samples/datapage/RichDataDefinition.model

This model shows how to associate rich data definitions with fields in a schema.

Parent topic: Builder help

Library | Support |