Field type reference

The field type and workflow type may not refer to the same type.

DevNote add some additional context about this.

Checkbox (Y/N)

A Checkbox field stores a true/false (truthy/faulty) value (a boolean).

A Checkbox field should be used when you wish to store a truthy/faulty value. For example, was the subscription paid, or is the contact subscribed to your newsletter.

A field of type Checkbox is represented as a label when it is being viewed. When the field is being edited, it is represented as a checkbox.

Table 1. Additional configurations:

True label

The option allows you to specify the display label of truthy values.

False label

The option allows you to specify the display label of faulty values.

Date and time

A Date and time field type stores a temporal value (a timestamp).

The Date and time field type should be used when you wish to store some temporal information; a date, a time, or both. For example, the time that the lead was converted.

A field of type Date and time is represented as a formatted string when viewed. When the field is being edited, it is represented as a date input, a time input, or a date-time input (depending on the configuration).

Table 2. Additional configurations:

Date only

Removes the time part of the timestamp and only keeps the date. When editing the field, only the date input is shown.

Time only

Removes the date part of the timestamp and only keeps the time. When editing the field, only the time input is shown.

Past values only

Changes the value validator to only allow past values. The displayed date-time picker disables future values.

Future values only

Changes the value validator to only allow future values. The displayed date-time picker also disables past values.

Output relative value

Displays the value relative to the current time. For example, 10min ago, or last month.

Output format

Defines the format string that is used when displaying the timestamps. The field supports all of the moment.js formatting options.

Email

An Email field type stores an email address.

The Email field type should be used when you wish to store an email. For example, the primary email address of the client.

A field of type Email is represented as a label or a clickable link when it is being viewed (depends on the configuration). When the field is being edited, it is represented as an email input box.

Internally, the email is stored as a plain-text regardless of the configuration. Display formatting is performed in the front-end application.

Table 3. Additional configurations:

Don’t turn email into a link

Displays the email as a regular string and not as a clickable link.

Select / dropdown

A select / dropdown field type stores a value from a pre-defined set of options.

The select / dropdown field type should be used when you wish to force suers to pick one of the pre-defined values. For example, the stage of a case or the stage of a lead.

A field of type select / dropdown is represented as a label when it is being viewed. When the field is being edited, it is represented as a dropdown input box.

Table 4. Additional configurations:

Options

Defines a set of available options that the field can have. For example, new, in progress, closed.

An option is a value-label pair, where the label defines how the value is displayed to the user.

When working with selects inside automation, use the value when working with values.

Multiple value input type

Defines how the multi-value variant of the field is represented.

DevNote list and describe the options?

Number

A Number field type stores a numeric value.

The Number field type should be used when you wish to store any numeric value. For example, the cost of a subscription or the cost of a lead.

A field of type Number is represented as a formatted label when it is being viewed. When the field is being edited, it is represented as a number input box.

Table 5. Additional configurations:

Prefix

Adds the specified prefix to the numeric value. For example, the prefix of $ and the value of 1000 would result in the label of $1000.

Suffix

The specified suffix to the numeric value. For example, the suffix of USD/h and the value of 1000 would result in the label of 1000USD/h.

Precision

Defines the precision at which to store the value. For example, the precision of 3 would allow you to store numbers with up to three decimal places.

The precision is limited to 6.

Format

Defines the format string that is used when displaying the numbers. The field supports all of the numeral.js formatting options.

Record

A Record field type stores a reference to another record.

The stored value is the recordID to the referenced record. If you wish to access the values of the referenced record, you need to fetch it from the REST API.

The Record field type should be used when you wish to define a relation between two modules. For example, the parent transaction, or the account owner.

You can only reference records in the same namespace.

A field of type Record is represented as a clickable link to the related record when it is being viewed. When the field is being edited, it is represented as a searchable dropdown box.

Table 6. Additional configurations:

Module

Defines what module’s records this field is linked to.

Record label field

Defines what module field from the related module should be used when displaying it’s records records.

Pre-filter records

Defines the pre-filter that is used when searching for the related records. Refer to the QL reference for details.

Query fields on search

Defines what fields are used for querying when searching over related records.

Multiple value input type

Defines how the multi-value variant of the field is represented.

DevNote list and describe the options?

String

A String field type stores a generic text value.

The String field type should be used when you wish to store some text. For example, the name of a contact or the TOS that should be shown to the client.

A field of type String is represented as a text when it is being viewed. When the field is being edited, it is represented as a text input box or a rich text input box (depending on the configuration).

Table 7. Additional configurations:

Multi-line

Changes the simple input box to be a multi-line textarea.

Use rich text editor

Changes the simple string imput to be a multi-line rich text editor. The value is encoded as a standard HTML document, so the value can be used in applications where HTML is accepted.

URL

A URL field type stores a URL address.

The URL field type should be used when you wish to store a URL address. For example, the link to the clients' homepage.

A field of type URL is represented as a label or a clickable link when it is being viewed (depending on the configuration). When the field is being edited, it is represented as a URL input box.

Internally, the URL is stored as a plain-text regardless of the configuration. Display formatting is performed in the front-end application.

Table 8. Additional configurations:

Trim # from the URL

Removes the URL fragment (the text after the #).

Trim ? from the URL

Removes the URL query (the text after the ?).

only allow SSL (HTTPS) URLs

Only allows secure (HTTPS) URL addresses.

Don’t turn URL into a link

The URL address is shown as a regular label instead of a clickable link.

User

A User field type stores a reference to a system user.

The stored value is the userID to the referenced user. If you wish to access the values of the referenced user, you need to fetch it from the REST API.

The User field type should be used when you wish to define a relation between a record and a system user. For example, the owner of the record or the task assignee.

A field of type User is represented as label when it is being viewed. When the field is being edited, it is represented as a searchable dropdown box.

Table 9. Additional configurations:

Pre-filter users

Defines the pre-filter that is used when searching for the related user. Refer to the QL reference for details.

Preset with current user

When checked, the current user will populate the given field by default.

User roles

Filters the users based on their membership.

multiple value input type

Defines how the multi-value variant of the field is represented.

File upload

A File upload field type stores a reference to an uploaded attachment.

The stored value is the attachmentID to the referenced user. If you wish to access the values of the referenced file, you need to fetch it from the REST API.

The File upload field type should be used when you wish to attach some document to the record. For example, the clients' quote or a legal document.

A field of type File upload is represented as clickable link when it is being viewed. When the field is being edited, it is represented as a drag’n drop file upload box.

Table 10. Additional configurations:

View mode

Defines how the files are presented when they are being viewed.

DevNote list & describe the available options.