Field Types

This page provides an overview of the various field types available in Brinkee and how they can be used to structure and organize your data. Each field type is described in detail, including its purpose, recommended usage, and any naming conventions. Examples are also provided to help illustrate each field type.

UID

Every record in Brinkee has a unique identifier. This unique identifier is called the UID. UIDs are 18 characters long and consist of alphanumeric characters.

Renaming the UID field

Regardless of the language you’re viewing Brinkee in, you will see the field name UID for the uid field. This field is part of the inner workings of Brinkee, and we believe that naming internal objects the same, regardless of the language, can help build a common understanding.

Single Line

Single line fields allow you to store text (single line) values. For example, a “First Name” field in a contact management system.

If you want to allow only a particular choice out of a list of available choices, it’s better to use a Choice field.

If you want to store longer (multi line) values, you need to use a Multi line field, or the value will be shortened to match the maximum length for this field.

Multi Line

Multi line fields allow you to store text (multi line) values. For example, a “Description” field in a blog or content management system.

If you will only store shorter (single line) values in this field, it’s better to use a Single line field.

Boolean

Boolean fields allow you to store true or false values. For example, the “Active” field on the user table.

Choice

Choice fields allow you to store a particular choice based on a list of available choices. This can help reduce errors and improve the consistency of your data. For example, the “Status” field on the task table.

Country

The “Country” field is a type of Choice field used to allow users to select a country from a predefined list of countries.

Language

The “Language” field is a type of Choice field used to allow users to select a language from a predefined list of languages.

Naming convention

To help create a common understanding, we recommend naming language fields simply "language" or "<prefix>_language", examples include: "communication_language". This will help clarify what kind of value is to be expected when viewing the fields through the API.

Integer

Integer fields allow you to store numeric values (whole numbers only). For example, a “Quantity” field in an inventory management system.

If you will store values that are not whole numbers, you need to use a Decimal field, or the part after the decimal point will not be stored due to limitations of the underlying database engine.

Decimal

Decimal fields allow you to store numeric values (decimals). For example, the “Value” field in an e-commerce system.

If you will only store values that are whole numbers, it is better to use an Integer field.

Reference

Reference fields allow you to reference a record in a table in Brinkee. The table to which the record points is predefined in the field definition. For example, a “Customer” field in an order management system that references the “Customers” table.

Multi Reference

Multi reference fields allow you to reference multiple records in a table in Brinkee. The table to which the records belong is predefined in the field definition. For example, a “Tags” field in a blog or content management system that references the “Tags” table.

Dynamic Reference

Dynamic reference fields allow you to reference a record in any table in Brinkee. Dynamic references are made up of a Choice field for the table selection, and of a Reference field for the reference.

The benefit of using a dynamic reference field rather than two separate fields has to do with the presentation of the stored value. Dynamic references can be opened directly from a form view, giving users the ability to see relevant information at a glance.

Datetime

Naming convention

To help create a common understanding, we recommend naming datetime fields according to the following format: <activity>_at, examples include: updated_at, created_at, publish_at or unpublish_at. The suffix _at will help clarify that this field contains a date, when viewing the fields through the API.

Date

Date fields allow you to store dates in Brinkee.

If you need to store a date and time, you can use a Datetime field instead. If you need to store a time, you can use a Time field instead.

Time

Time fields allow you to store times in Brinkee.

If you need to store a date and time, you can use a Datetime field instead. If you need to store a date, you can use a Date field instead.

Currency

Currency fields allow you to store currency values. Currency fields are made up of a Choice field for the currency selection, and of a Decimal field for the amount.

The benefit of using a currency field rather than two separate fields has to do with the presentation of the stored value.

Number

Number fields are auto-incrementing fields added by the system. They use the following format: <PREFIX>000001. Examples include: TASK1001001, CHANGE30023

Number formats

To avoid confusion between the letter O (as in October) and the digit 0 (zero), the prefix can’t end with the letter O.

Imagine you’re a seller of studio apartment and you want to maintain a list of all your studios in Brinkee. At first sight, it might make sense to use the prefix STUDIO to assign a unique identifier to each record. This is not permitted, as it can lead to subtle but annoying typos. Notice the difference between: STUDIO00001 vs STUDI000001

An alternative could be STUD or STUDIOAPT as the prefix, which would generate numbers STUD000001 or STUDIOAPT000001.