Setting up custom fields

Summary: Add your own fields to projects, tasks, notes or cards. Set up the unit of measure that holds the field's values, then add the field in the Custom fields editor.

Applies to

Before you start

• Every custom field takes its values from a unit of measure. The unit sets the kind of value (its Data type) and, for a picklist, the values people can choose from. Which data types and options there are is explained in Understanding units of measure.
• One unit can serve several fields. In the example space, the Product Group unit is used both by the project field Domain and by the task field Task Domain. Some admins prefer to give each field its own unit, to keep things clear. If you later change a unit, every field that uses it changes too.
• Check whether a suitable unit already exists before you make a new one.

Procedure

Set up the unit of measure

1. Select Go to configuration, then select Units of measure.
2. Select New in the left-hand bar. A new unit appears at the top of the list.
3. Enter a Description: this is the unit's name.
4. Choose the Data type.
5. Set Unit of measure to Standard, or to Picklist if people should choose from a list.
6. For a picklist, select + under Picklist values and add each value.
7. Select Save in the left-hand bar.

Add the custom field

1. Select Open custom properties at the bottom of the units list. The Custom fields editor opens. You can also open it from Go to configuration > Object Configuration > Custom fields.
2. Set Object type to the object the field belongs to: Project, Task, Note or Card custom fields.

3. Select +. A new row appears, with its Key already filled in.
4. Double-click the row's Name cell, type the field's name, and press Enter.
5. Double-click the row's Unit of measure cell, and choose the unit.

6. Optionally, tick ReadOnly. The field is then shown but cannot be changed by hand. Use it for a value LYNX-X fills in for you, such as a delivery date set by a card update trigger, or to show information on a card that comes from elsewhere, for example from its workpackage.
7. Select OK to save the editor.

For a note field, the editor also shows a Note kind list. Tick the kinds of note that should carry the field. Notes are covered in Adding notes to projects, tasks and cards.

Expected outcome

The field is now part of the object, and people fill it in where they edit that object. A project field, for example, appears on the Custom fields tab of the project's Project properties. A picklist field offers its values in a drop-down, and a unit's symbol is shown after the field's name, as in Profit [€].

Additional information

• Removing a field you no longer need. In the Custom fields editor, select the field's row, select the delete button next to +, then select OK. The row goes at once, without a question. To remove its unit as well, select the unit on the Units of measure page, select Delete, then Save. LYNX-X asks you to confirm; select Apply changes.

• The Key column shows the key LYNX-X gave each field, such as FIELD_0027. Card update triggers refer to fields by their key; see Automating card updates with triggers.

See also

• Understanding units of measure
• Adding notes to projects, tasks and cards
• Automating card updates with triggers

Revision history