<< Back to Education centre

If you are missing a parameter, attribute, or field in Caflou that the system does not offer as part of its basic setup, then you can create your own custom fields. 

You can set such custom parameters in Account Settings, in the Custom Attributes section:

New custom attribute

What can be set:

  • Name - the attribute will appear under this name in forms, as a column in reports, or as a filter
  • Attribute type - here you choose the format of the field, e.g. whether it is a number, date, list/selection of values, text, email, etc.
  • Default value - if the value is to be pre-populated for new objects, then you set the default value in this field
  • Minimum/maximum - for a field of type "number" you can also set a minimum and maximum
  • Multiple choices - in the field of type "List" you can choose whether only one value can be selected from the list or multiple values
  • Object types - here you can select for which objects this attribute will be available, multiple object types can be selected for one attribute
  • Hint - if you fill in the value, then a "tooltip" (question mark icon) will appear in the form for the attribute with the text inserted
  • Create filter for filtering in overviews - if you select this option, the filter for the object type will allow filtering using this custom attribute
  • Create column in overviews - if you select this option, overviews for the object type will allow to display a column for this custom attribute (displaying a column works for exports as well)

Using the custom attribute

Form

You can see and fill in the custom attribute in the form of the object type at the bottom of the "Basic" tab:

Custom attribute in the form

Detail

You can also display custom attributes in the detail of the object type, including the ability to edit the attribute directly from the detail (i.e. "inline" change).

Custom attribute detail

Filters and overviews

Custom attributes can also be displayed as columns in overviews and can also be used in filtering. You can also use "inline" editing in the overviews.

Nový vlastní atribut

API

Custom attributes are also automatically available in the API, where they can be displayed (Get), used when creating objects (Post), and when editing objects (Patch).

Nový vlastní atribut

Tip 1: Editing or creating values for custom attributes via API - parameters need to be "wrapped" by a parent object, e.g. like this for a custom parameter in the project:

{
  "project": {
    "custom_column_month": "5"
  }
}

💡 Tip 2: Custom attributes (for company or project) can be inserted into contracts as variables in the contract text (header, body, footer) in the format {company_custom_column_XYZ} or {project_custom_column_XYZ}. You can get the code of the custom attribute (in the form "custom_column_XYZ") via API or by hovering over the name of the custom attribute in the "Custom attributes" section. For a contract, you then specify whether the value is retrieved from the company on the contract or from the project.

Availability of custom attributes

The feature is available only in the Dolphin and Shark plans.