Data definitions are read from an XML file called a rich data definition (RDD) file.
Rich data definitions are used to clean up a portlet or a widget, for example, by hiding columns that do not need to be displayed. Rich data definitions are associated with a schema in your model. For each field in the selected schema, you can specify labels, control types, lookup tables, formatting, validation, and much more.
A data definition file works by associating user interface (UI) descriptions with a schema. When the schema is used to generate page elements (with Data Page builder or View and Form builder, for example), all of the UI characteristics are automatically applied to the page. By using the functionality of the Data Field Modifier builder, you can learn about specific settings, for example, validation and formatting.
A base rich data definition file is provided for your project. By default, each project has assigned an RDD file stored in the following location.
The RDD files base_datadef.xml
are supplied. You can override the default setting for your project by defining the following property in the override.properties
The default setting for this property is in the bowstreet.properties
file. Multiple files can be defined; the first file found is used.
You can use the Default RDD File
input in the Data Field Settings builder to override the base RDD file for the project in your model.
You can use builders to modify the data definition information that is associated with a schema in a WebApp for columns and fields on page automation forms and pages. Data definition is one of the internal data structures of the Data Page builder. When Data Page is used with a schema-typed variable, it looks for any data definition information attached to the schema in the WebApp. Those data definition properties become the defaults for any pages based on the schema. However, you can still use other builders such as Data Field Settings, Data Column Modifier, and Data Field Modifier to override the properties specified in the data definition that is associated with the schema.
The association of data definitions to schema elements is done using the element name. A data definition file typically stores a set of structures, with a child data definition for each field in the structure. The parent (structure) name in the schema must match the parent name in the data definition file, and then the individual fields are also matched by name.
What data definitions do
Rich data definition (RDD) files provide the most automated way of controlling the detailed user interface for application data fields. With RDD files, the user interface (UI) is automatically controlled in the following ways.
- Format or validate fields. 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.
Parent topic: Modifying field display settings: wpf7