You are viewing the documentation for Blueriq 14. Documentation for other versions is available in our documentation directory.

What is it for?

A field type is used for defining a reusable template for displaying fields on a page.

Field type is a new global element type which defines a template for a field that can be placed on a page. This feature makes it easier for business engineers to organize and work with fields that share common presentation styles, data types or other field related properties.

For example, if one project requires multiple fields to have the same presentation styles then a field type can be created where those presentation styles can be defined. Afterwards the fields can be just assigned that type and so they will automatically inherit the presentation styles (rather than specifying the presentation styles individually for every field).


Before learning about field types

In order to understand field types one must first understand the concept of Fields. Please refer to that respective documentation page if needed.

Creating a new Field type

  1. On the Globals tab, in the Others group, click the New field type icon  (or activate the Field type’s list view and use keyboard shortcut CTRL + N)
  2. Fill out the name of the Field type (required field). 
  3. Click Save or Save and Close.

Field type parameters

The following parameters can be specified for a field type:

  • Output - The type of data that will be displayed when the field is placed on a page 
    • Attribute : if this option is selected, the field will be able to display the value of an attribute;
  • Data type - If the selected Output type is attribute; the data type of the output attributes 
  • Precondition - indicates whether the "Precondition" property can be edited when the field is placed on a page
  • Readonly - indicates whether the "Readonly" property is available for edit when the field is placed on a page
  • Required - indicates whether the "Required" property is available for when the field is placed on a page
  • Refresh - indicates whether the "Refresh" property is available for edit when the field is placed on a page
  • Length - indicates whether the "Length" property is available for edit when the field is placed on a page
  • Presentation styles - defines the list of available Presentation Styles that can be selected when the field is placed on a page
  • Parameters - defines the list of available Parameters that can be selected when the field is placed on a page

Example

Aquima Library provides a set of Field Types which are suitable for the data types available in Blueriq. For example, the AQ_String field type:  

    

  • The name of the field type can be selected in the inline field properties. 
  • The output type and the data type from the Field Type determine the output of the inline field. In this example, the output is an attribute with data type String. When selecting an attribute in the inline field, the data type needs to match.