The Bugzilla Guide - 3.0.2 Release
Prev | Chapter 3. Administering Bugzilla | Next

# 3.9. Custom Fields

One of the most requested features was the ability to add your own custom fields to bugs, based on your needs. With the release of Bugzilla 3.0, this dream finally comes true. Administrators can manage these fields using the "Custom Fields" link in the footer of pages. The first thing they will see is the list of existing custom fields (which is empty by default).

## 3.9.1. Adding Custom Fields

The "Add a new custom field" link permits you to add a new field which can be either a free text box or a drop down menu. More field types will be available in future releases.

The following attributes must be set for each new custom field:

- Name: the name of the field, used internally. This name MUST begin with "cf_". If you omit this string, it will be automatically added to the name you entered. This way, all custom fields added to Bugzilla begin with "cf_", avoiding any conflict with default fields.

- Description: the string which is used as a label for this custom field. That is the string that users will see, and so should be short and explicit.

- Type: as mentioned above, only two types are implemented so far. Free text boxes let you type any string, while drop down menus only let you choose one value in the list provided. The list of legal values for this field can be created and edited as soon as this custom field is added to the DB. See Section 3.10.1 for information about editing legal values.

- Sortkey: this integer determines in which order custom fields are displayed in the UI, especially when viewing a bug. Fields with lower values are displayed first.

- Can be set on bug creation: this boolean determines whether this field can be set on bug creation or not. If not, then you have to create the bug first before being able to set this field. Else you can set its value at the same time you file a bug, see Section 5.6 about filing bugs.

- Displayed in bugmail for new bugs: this boolean determines whether the value set on this field should appear in bugmail when the bug is filed. This attribute has no effect if the field cannot be set on bug creation.

- Is obsolete: this boolean determines whether or not this field should be displayed at all. Obsolete custom fields are hidden.

## 3.9.2. Editing Custom Fields

As soon as a custom field is created, its name and type cannot be changed. If this field is a drop down menu, its legal values can be set as described in Section 3.10.1. All other attributes can be edited as described above.

## 3.9.3. Deleting Custom Fields

At this point, it is not possible to delete custom fields from your web browser. If you don't want to make one available anymore, mark it as obsolete. This way, you will preserve your DB referential integrity.

Prev | Home | Next
Flags | Up | Legal Values