TIBCO EBX®
Documentation > User Guide > Data models > Implementing data models
Navigation modeDocumentation > User Guide > Data models > Implementing data models

Properties of data model elements

After the initial creation of an element, you can set additional properties in order to complete its definition.

Basic element properties

Common basic properties

The following basic properties are shared by several types of elements:

Information

Additional non-internationalized information associated with the element.

Minimum number of values

Minimum number of values for an element.

As primary keys cannot be multi-valued, they must have this property set to '1' or 'undefined'. The minimum number of values is automatically set to '0' when defining the field as a selection node.

Maximum number of values

Maximum number of values for an element. When set to a value greater than '1', the element becomes multi-valued.

As primary keys cannot be multi-valued, they must have this property set to '1' or 'undefined'.

For tables, the maximum number of values is automatically set to 'unbounded' upon creation. The maximum number of values is automatically set to '0' when defining the field as a selection node.

Validation rules

This property is available for tables and fields in tables except Password fields, reusable types, fields in complex reusable types, and selection nodes. Used to define powerful and complex validation rules with the help of the provided XPath 1.0 criteria editor.

This can be useful if the validation of the value depends on complex criteria or on the value of other fields.

Using the associated wizard, you can define localized labels for the validation rule, as well as define a localized message with severity to be displayed if the criteria is not met.

When defining the severity of the validation message it is possible to indicate whether an input that would violate a validation rule will be rejected or not when submitting a form. The error management policy is only available on validation rules defined on a field and when the severity is set to 'error'. If the validation rule must remain valid, then any input that would violate the rule will be rejected and the values will remain unchanged. If errors are allowed, then any input that would violate the rule will be accepted and the values will change. If not specified, the validation rule always blocks errors upon the form submission by default.

Basic properties for fields

The following basic properties are specific to fields:

Default value

Default value assigned to this field. In new data creation forms, the default value appears automatically in the user input field. The default value must comply with the defined type of the field.

Conversion error message

Internationalized messages to display to users when they enter a value that is invalid for the data type of this field.

Computation rule

This property is available for fields in tables, except in reusable types. Defines a rule for computing the value of the field using the provided XPath 1.0 editor.

This can be useful if the value depends on other values in the same record, but does not require a programmatic computation.

The following limitations exist for computation rules:

  • Computation rules can only be defined on simple fields inside a table.

  • Computation rules cannot be defined on fields of type OResource or Password.

  • Computation rules cannot be defined on selection nodes and primary key fields.

  • Computation rules cannot be defined when accessing an element from the validation report.

Advanced element properties

Advanced properties for fields

The following advanced properties are specific to fields.

Disable validation

Specifies if the constraints defined on the field must be disabled. This property can only be defined on computed fields. If true, cardinalities, simple and advanced constraints defined on the field won't be checked when validating associated datasets.

Auto-increment

This property is only available for fields of type 'Integer' that are contained in a table. When set, the value of the field is automatically calculated when a new record is created. This can be useful for primary keys, as it generates a unique identifier for each record. Two attributes can be specified:

Start value

Value with which to begin the auto-increment. If this attribute is not specified, the default value is '1'.

Increment step

Amount the value is incremented based on the previous value of the auto-increment. If this attribute is not specified, the default is value is '1'.

Disable auto-increment checks

Specifies whether to disable the check of the auto-incremented field value in associated datasets against the maximum value in the table being updated.

Inherited field

Defines a relationship from the current field to a field in another table in order to automatically fetch its field value.

Source record

A foreign key or white space-separated sequence of foreign keys that leads from the current element to the record from which to inherit this field's value. If this property is not specified, the current record is used as the source record for the inheritance.

Source element

XPath of the element in the source record from which to inherit this field's value. The source element must be terminal, belong to the record described by 'Source record', and its type must match the type of this field. This property is mandatory when using field inheritance.

See inheritance in the glossary.

Advanced properties for tables

The following advanced properties are specific to tables.

Table

Primary key

A list of fields in the table that compose the table's primary key. You can add or remove primary key fields here, as in the 'Data structure' view.

Each primary key field is denoted by its absolute XPath notation that starts under the table's root element.

If there are several elements in the primary key, the list is white-space delimited. For example, "/name /startDate".

Presentation

Specifies how records are displayed in the user interface of this table in a dataset.

Presentation > Record labeling

Defines the fields to provide the default and localized labels for records in the table.

Attention: Access rights defined on associated datasets are not applied when displaying record labels.
Fields that are usually hidden due to access rights restrictions will be displayed in labels.

Presentation > Default rendering for groups in forms

Specifies the default display rendering mode of the groups contained in this table. If nothing is defined here, the default policy set in the Administration area will be used to display groups.

Enabled rendering for groups

Specifies a display rendering mode to be enabled for groups in the table in addition to the modes 'expanded' and 'collapsed', which are always available. Tabs must be enabled on the table to have the option to display groups as tabs. Similarly, links must be enabled to have the option to display groups as links.

Default rendering for groups

Specifies the default display rendering mode to use for the groups contained in this table. If a group does not specify a default mode then the default mode defined for this table will be used. Links must be enabled to define the default rendering mode as 'Link'. Select a rendering mode according to network and browser performance. Link mode is lighter as its content is not displayed on the same page, whereas the expanded and collapsed modes are heavier.

Note: When the tabs view is enabled on a table, any groups that would otherwise have used links are automatically converted to collapsed mode. This is done to avoid the inherent display layout complexities that would arise from links and tabs coexisting in the same user interface.

Presentation > Specific rendering of forms

Defines a specific rendering for customizing the record form in a dataset.

Toolbars

Defines the toolbars to use in this table.

Toolbars can be edited in the Configuration > Toolbars section.

Tabular view top: Defines the toolbar to use on top of the default table view.

Tabular view row: Defines the toolbar to use on each row of the default table view.

Record top: Defines the toolbar to use in the record form.

Hierarchy top: Defines the toolbar to use in the default hierarchy view of the table.

History

Specifies when historization is to be performed, and the level of guarantee requested. The available history profiles can be edited in Administration > History and logs.

Indexes

Defines the fields to index in the table. Indexing speeds up table access for requests on the indexed fields. No two indexes can contain the exact same fields.

Index name: Unique name for this index.

Fields to index: The fields to index, each represented by an absolute XPath notation starting under the table root element.

Specific filters

Defines record display filters on the table.

Actions

Specifies the actions that are allowed on the table in associated datasets. By default, all actions are allowed unless specific access rights are defined in a dataset.

Uniqueness constraints

Indicates which fields or set of fields must be unique across the table.

/ebx_search.png User guide table of contents

Documentation > User Guide > Data models > Implementing data models