Adding custom fields

Add custom fields to capture additional information in items. For example, you can add a date/time field to let users set an initial due date estimate before items are assigned.

You can also add custom fields to workflow event dialog boxes to capture information as items move through the workflow. See Customizing workflow event fields and icons.

You follow similar steps for adding custom fields for all field types. If you need to add test variants, see Adding test variant custom fields.

Custom fields added in the web client are displayed on the item Custom Fields tab in the desktop client.

1. Choose Tools > Administration > Custom Fields.

The Setup Custom Fields dialog box opens.

2. Select an Item type. The fields displayed depend on the selected type.

3. To add a field, click Add in the Active Fields area. The Helix ALM project must be locked to add active custom fields. See Locking and unlocking projects.

To add a field without affecting existing items, click Add in the Draft Fields area. See Creating draft custom fields.

The Add Custom Fields dialog box opens.

4. Enter a Field name.

5. Enter the Long label.

Long labels are displayed in drop-down lists and help users distinguish between the same fields in different workflow events.

6. Enter the Field code.

A field code is a variable that is replaced with a specific field value. They can be used in emails, reports, and other areas. For example, if you use a %Z_HIREDATE% field code in an email template, it is replaced with the Hire Date field value for the specific item the email is sent about.

7. Select a Field type and any Field Properties. The available options depend on the selected field type. See Custom field types for more information and examples.

Field type Use to:
Text Enter a value. You can add multi-line and single line text fields.

Multi-line text fields support multiple lines of text and other content. Select the Number of rows displayed to specify how many rows of content to show. The default value is 4 rows. Users can format text in these fields and insert images, tables, hyperlinks, and stamps. See Working with text fields.

Single line text fields support one line of text. The following formats are available.
  • String accepts an alphanumeric text value. Enter a maximum field Length. The default length is 255 characters.
  • Integer accepts a numeric value. Enter a maximum field Length. The default length is 10 digits.
  • Decimal Number accepts a numeric decimal value. Enter a maximum field Length. The default length is 255 characters.
  • Hyperlink accepts an address to a web page or file and displays it as a hyperlink. Enter a maximum field Length. The default length is 255 characters.
Date/Time Set a date or date/time value.
Check Box Select a check box to indicate if a value applies to an item or event.
Pop-Up Menu Select values from a list. Select Supports multiple selection to allow users to select multiple values. Click the Choose Value List button to select the value list for the field. Click Setup List Items to update list values. See Configuring custom value lists.
Calculated View a read-only field with a value calculated from other field values. See Configuring calculated custom fields.

8. Click OK to add the field to corresponding list in the Setup Custom Fields dialog box.

9. Click OK to save the changes.

If you added an active field, all items in the project are updated to include it.

If you added a draft field, you must promote it to active or replace an existing active field to make it available in the project. See Promoting draft custom fields or Replacing custom fields with drafts.

Tip:  To require users to set values in custom fields when adding or editing items, make sure they are set as required fields. You can also select the default value for custom fields. See Defining required fields and default values.