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 follow similar steps for adding custom fields for all field types. If you need to add test variants, see Adding test variant fields.

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

Note:  You can configure calculated custom fields in the desktop client. Calculated fields generate values based on other field input values. See information about configuring calculated custom fields.

You can also configure draft custom fields in the desktop client. You can use draft fields to set up or edit custom fields without affecting existing items. Draft fields are not active in the project when changes are saved. See information about creating draft custom fields.

1. Click Administration.

The Admin Home page opens.

2. Click Custom Fields.

The Custom Fields page opens.

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

4. Click Add.

The Add Custom Fields dialog box opens.

5. Click the field type to add. See Custom field types.

You can search for a field type to easily find it.

6. Click Add.

The Add Custom Field page opens.

7. Enter the Field name.

The Long label and Field code field values are automatically added. You can change them.

  • Long label—The long label can help users distinguish between the fields with the same name in various areas of Helix ALM. The long label is displayed in the Name column on the Custom Fields page.
  • 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.

8. Enter or select the field Properties. The available options depend on the selected field type.

  • Default value—Select Not selected or Selected to indicate if the check box should be selected or not by default.
  • Allow users to select multiple values—Select to allow users to select more than one value in the list.
  • Customers to include—Select the type of customers to include in the list: Global, Local, or Global and local. See Managing users and customers.
  • Required—Select to make the field required. Users cannot save an item until they select a value in the field.
  • Default value—Select the value that is selected in the field by default.
  • Include time—Select to include the time with the date value.
  • Required—Select to make the field required. Users cannot save an item until they enter a value in the field.
  • Default value—Select the value to display in the field by default. Current date specifies the number of days, weeks, months, or years to add to the current date when an item is created.
  • Length—Enter the maximum number of characters allowed in the field. You can enter 1-255. 255 characters is the maximum and default length.
  • Required—Select to make the field required. Users cannot save an item until they enter a value in the field.
  • Default value—Enter the value that is in the field by default.
  • Value list—Select the list of values to use for the field.
    • If the project does not have a list of values you want to use for the field, select Add a new list. Click Configure List Values to add the value list. See Configuring dropdown field values. When you finish adding the list, you return to the Add Custom Field page and the list name is displayed.
    • If the project already has a list of values you want to use for the field, select Use an existing list and then select the list to use. Other fields using the list are displayed for reference. Click Configure List Values to make any changes to the value list. See Configuring dropdown field values. When you finish adding the list, you return to the Add Custom Field page.
  • Allow users to select multiple values—Select to allow users to select more than one value in the list.
  • Required—Select to make the field required. Users cannot save an item until they select a value in the field.
  • Default value—Select the value that is selected in the field by default.
  • Length—Enter the maximum number of characters allowed in the field. You can enter 1-255. 255 characters is the maximum and default length.
  • Required—Select to make the field required. Users cannot save an item until they enter a value in the field.
  • Default value—Enter the value that is in the field by default. Click Open to open the link.
  • Length—Enter the maximum number of characters allowed in the field. You can enter 1-10. 10 is the maximum and default length.
  • Required—Select to make the field required. Users cannot save an item until they enter a value in the field.
  • Default value—Enter the value that is in the field by default.
  • Required—Select to make the field required. Users cannot save an item until they enter a value in the field.
  • Default value—Enter the value that is in the field by default. Use the formatting toolbar to change the text formatting and insert images, tables, hyperlinks, and stamps. See Working with text fields. If you are inserting an image, click and then browse for or drag and drop an image to insert. To edit the image, select it in the field and click again.
  • Length—Enter the maximum number of characters allowed in the field. You can enter 1-255. 255 characters is the maximum and default length.
  • Required—Select to make the field required. Users cannot save an item until they enter a value in the field.
  • Default value—Enter the value that is in the field by default.
  • Allow users to select multiple values—Select to allow users to select more than one value in the list.
  • Users to include—Select the type of users to include in the list: Global, Local, or Global and local. See Managing users and customers.
  • Required—Select to make the field required. Users cannot save an item until they select a value in the field.
  • Default value—Select the value that is selected in the field by default.
  • Allow users to select multiple values—Select to allow users to select more than one value in the list.
  • Users and customers to include—Select the type of users and customers to include in the list: Global, Local, or Global and local. See Managing users and customers.
  • Required—Select to make the field required. Users cannot save an item until they select a value in the field.
  • Default value—Select the value that is selected in the field by default.

9. If you are adding a requirement field, make any changes to the Default Values and Required Settings to specify settings based on requirement types. See Configuring default values and required options for requirement fields based on requirement type.

10. Click Save.

The field is added and all items in the project are updated to include it. You return to the Custom Fields page.