Custom Attributes

→ To get access to the management of the Custom Attributes, the permission ADMIN_CUSTOM_ATTRIBUTE_PERMISSION is required.

What is a Custom Attribute?

A Custom Attribute is a field that can be added to the most important Objects in order to customise BizDock and enhanced its data model. For example, it is possible to add a field “Complexity” on an Initiative with a pre-defined list of possible values as this is not a standard field in BizDock.

Custom Attributes are visible on the “View” page of an object and can be edited as any other attribute. They can have default value and can be marked as mandatory to ensure they are filled in by BizDock User.

Attributes

All Custom Attributes share the following characteristics:

Field Description
Type The type of the attribute. The following types are available: boolean, date, integer, number, select list (multi or single value), string, text, URL
Name Name of Custom Attribute
Description Description of the Custom attribute
Conditional rule The conditional rule allows to limit the activation (displaying) of the custom attribute according to the value of another attribute (a full definition is given below).
Displayed Display the Custom Attribute when its related objects are listed
Configuration a key/value list of possible configuration for the Custom Attribute. One property per line with the syntax: property name=property value

Conditional rule

A Conditional rule is used to limit the activation of a custom attribute according to the value of another attribute (called the depending attribute).

It is possible to set a Conditional rule only for the custom attributes with the following types:

  • Boolean (checkbox)
  • Date
  • Integer
  • Number
  • Single dropdown
  • String
  • Text
  • URL
  • Script

A Conditional rule is composed by 2 elements:

  • The depending attribute: the other attribute for which a value is expected for.
  • The depending value: the value itself, meaning if the depending attribute has this value then the custom attribute is displayed.

The depending attribute could be a direct attribute of the related entity (for example the name of an Initiative) or another custom attribute:

  • Direct attribute: the possible direct attributes depend of the entity itself, usually the attributes with type Boolean (checkbox), Integer, Number, Select list and string are authorized.
  • Custom attribute: the possible custom attributes depend of their type, the authorized types are: Boolean (checkbox), Integer, Number, Single dropdown and String.

The format of depending value is related to the type of the depending attribute:

Type Value format Example
Boolean (checkbox) true of false true
Integer A list of authorized integer values (the list can contain only 1 value). 4
7,8
Number A list of authorized number values (the list can contain only 1 value). Each value should be formatted with 2 decimals (even if the decimal part is 0), this format should also be applied when filling the entity value. 150.00
18.45,192.10
Select list / Single dropdown A list of authorized identifiers that correspond to the dropdown items (the list can contain only 1 value). 1
8,12
String A list of authorized string values (the list can contain only 1 value). The system is not case sensitive (meaning “CRM” is interpreted as “crm”). The entity value should correspond exactly to the depending value (no wildcard is used). CRM
ERP,It tool

If a custom attribute has a Conditional rule then the required constraint (constraint.required=true) is ignored.

Add a Custom Attribute

  1. First select the BizDock Object you want to extend with a Custom Attribute,
  2. Click on the icon,
  3. Complete the Custom Attribute's attributes,
  4. Save.

Remove a Custom Attribute

  1. First select the BizDock Object,
  2. Click on the icon for the wished Custom Attribute,
  3. Edit the attributes,
  4. Save.

Remove a Custom Attribute

  1. Click on the icon for the wished Custom Attribute,
  2. Confirm that you want to delete this Custom Attribute.

Custom Attributes types

Each Custom Attribute has a type that defines its display and the possible configuration options.

Type Display Possible configurations Example
Boolean default.value: true or false default.value=true
String default.value: the default value for this field
constraint.required: true to set the field as mandatory
default.value=CC4587
constraint.required=true
Text default.value: the default value for this field
constraint.required: true to set the field as mandatory
default.value=No more information
constraint.required=true
Date default.value: the default value (can be “0” which will set the default value to the current date or “n” where n is a number of days in the future or “-n” where n is a number of days in the past)
constraint.required: true to set the field as mandatory
default.value=5
constraint.required=true
List
(single value)
constraint.required: true to set the field as mandatory constraint.required=true
List
(multi values)
constraint.required: true to set the field as mandatory constraint.required=true
Number constraint.required: true to set the field as mandatory
default.value: the default value
constraint.max: a number setting the max value for the field
constraint.min: a number setting the min value for the field
constraint.required=true
default.value=0.5
constraint.max=0.9
constraint.min=0.1
Integer constraint.required: true to set the field as mandatory
default.value: the default value
constraint.max: a number setting the max value for the field
constraint.min: a number setting the min value for the field
constraint.required=true
default.value=0
constraint.max=100
constraint.min=0
URL default.value: the default value
constraint.required: true to set the field as mandatory
constraint.new_window: to open the URL in a new window
default.value=https://www.bizdock.io
constraint.required=true
constraint.new_window=false
Script script: a javascript scriptlet that will be executed for computing the read only value script=function getValue(objectType, objectId) { return “Hello World!”; }

Once set, the type of Custom Attribute can not be changed.