Articles in this section

Setting Up Custom Attributes

Nate H

This feature allows you to add custom properties to the Assignments, Capacity, Employee profile, Project phase, Time offs, Vacancies, and Worklogs. The article is divided into two parts. In the first one, you'll find a short step-by-step instruction on adding a new custom attribute. In the further part of the article, you can read in-depth explanations of how the feature works. 

Table of contents

Part 1

Short instruction

Part 2

Custom Attribute Panel 

Usage of Custom Attributes

Adding Custom Attributes Step-By-Step

List of Created Custom Attributes

Edition of Existing Custom Attributes

Visibility of Custom Attributes

Examples

Creation of Text Type Attribute

Creation of Decimal Type List Attribute

Creation of Attributes With Special Permissions

 

Short instruction

  1. Log in to the Administrator Role
  2. Go to Settings and choose Custom attributes
  3. Choose where you want to add your custom attribute
  4. Click Add custom attribute+.
  5. Type a label name for the attribute
  6. Choose the attribute type you want (Text, number, date, time, etc.)
  7. (Optional) Choose whether this attribute will be in the form of a list or not
  8. (Optional) Choose whether this attribute will be required
  9. (Optional) Choose what will be the default value of this attribute
  10. (Optional) Choose how this default value will be propagated throughout the rest of the attributes
  11. (Optional) Add description
  12. (Optional) Click the Financial data checkbox to mark the attribute as financial which means it will be visible only for managers with finance permission
  13. Set permissions.

If we choose the list type of attributes, once we click “Add” our attributes form will appear again, allowing us to add possible values for the list.

 

Custom attribute panel

Custom attributes panel

Usage of Custom Attributes

  1. Custom attributes can be added as Administrator in Settings: Custom attributes panel.
  2. Custom attributes can be added to the below forms:
  • Assignment,
  • Capacity,
  • Employee profile,
  • Project,
  • Project phase,
  • Time off,
  • Vacancy,
  • Worklog,
  1. For each form below the Add custom attribute icon there is a list of already created attributes
  2. Every custom attribute can be edited or deleted at any time.

Adding Custom Attributes Step-By-Step

A Custom attribute creation form

  1. Label - label for a new attribute,
  2. Technical name - unique name (ID) for attribute. It can be edited during attribute creation. Not possible to edit later.
  3. Type - a kind of attribute. Once a type is set, it cannot be edited later. Possible types:
    • Text,
    • Number (integer),
    • Number (decimal),
    • Date - default value needs to be set up for this type of attribute,
    • Time - default value needs to be set up for this type of attribute,
    • Date and Time - default value needs to be set up for this type of attribute,
    • Boolean (True / False),
    • Url,
    • Manager - list of possible managers,
  4. List - activating this checkbox allows the creation of a list of possible values for the chosen type that can be set for this attribute. Setting up possible values is allowed when an attribute is created,

View for attribute with listed values

 

Setting up possible values

 

  1. Many - visible when the List checkbox is marked. Activating this checkbox gives the possibility to choose multiple values from the list. Once the checkbox is marked, it cannot be unmarked later,
  2. Required - activating this checkbox makes the attribute mandatory to be filled with any value,
  3. Default value - set up default value,
  4. Propagation of default value:
    • Propagate for empty - propagate to every form where there is no value for this attribute,
    • Do nothing - there will be no propagation of default value,
    • Propagate for all values - propagate to every form,
  5. Description - field for additional notes for attribute,
  6. Financial data - checkbox to mark attribute as financial, which means it will be visible only for managers with finance permission,
  7. Permissions:
    • Administrators - only the administrator can read or write this attribute,
    • Everyone - everyone can read or write this attribute,
    • Managers - managers can read or write this attribute,
    • Organization managers - organization managers can read or write this attribute,

Remarks

🔵 If permission to read will be unmarked for any group, permission to write will be unmarked automatically.
🔵 If the financial data checkbox will be marked, then permission for everyone will be unmarked automatically.
🔵 If attributes are marked as required, the “Do nothing” propagation option will be unavailable. It means that required attributes must be propagated for empty or to all forms.
🔵 Description for attributes are visible only for the Administrator Custom attributes panel.

 

List of Created Custom Attributes

Edition of Existing Custom Attributes

  1. The label can be edited at any moment,
  2. Technical name cannot be changed at any moment,
  3. Type cannot be changed during the edition phase. It means if a custom attribute was created with the wrong type, it needs to be removed, and a new one must be created,
  4. If the list is unmarked, the attribute cannot be changed to the list. The same way works the opposite, which means if the attribute is a list of some type, it cannot be changed to a value item,
  5. Required field can be marked or unmarked at any moment,
  6. Default value can be added or removed at any moment,
  7. Propagation of new default value can be done at any moment,
  8. Description can be updated at any moment,
  9. Financial data field can be marked or unmarked at any moment,
  10. Permissions can be modified at any moment,

Visibility of Custom Attributes

Visibility of custom attributes in project form

 

  1. Custom attributes are visible in the bottom of every form,
  2. “Project attribute #3” isn’t visible as the manager doesn’t have proper permissions.
  3. If permissions allow, all values in attributes can be overwritten by a manager.

Examples

Creation of Text Type Attribute

  1. Label which is mandatory needs to be filled by the Administrator,
  2. Technical name is filled automatically but can still be edited during the creation phase,
  3. Type of attribute is also mandatory,
  4. The List checkbox must be marked or left unmarked now as later there is no possibility to choose if the attribute shall be the list or not,
  5. The rest of the fields are optional and can be configured according to Customer needs. It also can be edited later,

Creation of Decimal Type List Attribute

  1. When all mandatory fields are filled, and List checkbox is marked, the additional checkbox Many is visible,
  2. When marked, multiple values from the list can be added.
  3. When the Add button is clicked possible values can be added to the list

  1. Click Set possible values to add value to the list

 

  1. When at least one value is added, there is a possibility to set a default value for the list and make the attribute required

 

Creation of an Attribute With Special Permissions

 

  1. Such attributes shouldn’t be visible in project form by the manager without the Organization's permission.



Was this article helpful?
0 out of 0 found this helpful