373 lines
7.6 KiB
HTML
373 lines
7.6 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<HTML
|
|
><HEAD
|
|
><TITLE
|
|
>Custom Fields</TITLE
|
|
><META
|
|
NAME="GENERATOR"
|
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
|
|
REL="HOME"
|
|
TITLE="The Bugzilla Guide - 3.6.1
|
|
Release"
|
|
HREF="index.html"><LINK
|
|
REL="UP"
|
|
TITLE="Administering Bugzilla"
|
|
HREF="administration.html"><LINK
|
|
REL="PREVIOUS"
|
|
TITLE="Keywords"
|
|
HREF="keywords.html"><LINK
|
|
REL="NEXT"
|
|
TITLE="Legal Values"
|
|
HREF="edit-values.html"></HEAD
|
|
><BODY
|
|
CLASS="section"
|
|
BGCOLOR="#FFFFFF"
|
|
TEXT="#000000"
|
|
LINK="#0000FF"
|
|
VLINK="#840084"
|
|
ALINK="#0000FF"
|
|
><DIV
|
|
CLASS="NAVHEADER"
|
|
><TABLE
|
|
SUMMARY="Header navigation table"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
CELLPADDING="0"
|
|
CELLSPACING="0"
|
|
><TR
|
|
><TH
|
|
COLSPAN="3"
|
|
ALIGN="center"
|
|
>The Bugzilla Guide - 3.6.1
|
|
Release</TH
|
|
></TR
|
|
><TR
|
|
><TD
|
|
WIDTH="10%"
|
|
ALIGN="left"
|
|
VALIGN="bottom"
|
|
><A
|
|
HREF="keywords.html"
|
|
ACCESSKEY="P"
|
|
>Prev</A
|
|
></TD
|
|
><TD
|
|
WIDTH="80%"
|
|
ALIGN="center"
|
|
VALIGN="bottom"
|
|
>Chapter 3. Administering Bugzilla</TD
|
|
><TD
|
|
WIDTH="10%"
|
|
ALIGN="right"
|
|
VALIGN="bottom"
|
|
><A
|
|
HREF="edit-values.html"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
><HR
|
|
ALIGN="LEFT"
|
|
WIDTH="100%"></DIV
|
|
><DIV
|
|
CLASS="section"
|
|
><H1
|
|
CLASS="section"
|
|
><A
|
|
NAME="custom-fields"
|
|
>3.10. Custom Fields</A
|
|
></H1
|
|
><P
|
|
> The release of Bugzilla 3.0 added the ability to create Custom Fields.
|
|
Custom Fields are treated like any other field - they can be set in bugs
|
|
and used for search queries. Administrators should keep in mind that
|
|
adding too many fields can make the user interface more complicated and
|
|
harder to use. Custom Fields should be added only when necessary and with
|
|
careful consideration.
|
|
</P
|
|
><DIV
|
|
CLASS="tip"
|
|
><P
|
|
></P
|
|
><TABLE
|
|
CLASS="tip"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
><TR
|
|
><TD
|
|
WIDTH="25"
|
|
ALIGN="CENTER"
|
|
VALIGN="TOP"
|
|
><IMG
|
|
SRC="../images/tip.gif"
|
|
HSPACE="5"
|
|
ALT="Tip"></TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
VALIGN="TOP"
|
|
><P
|
|
> Before adding a Custom Field, make sure that Bugzilla can not already
|
|
do the desired behavior. Many Bugzilla options are not enabled by
|
|
default, and many times Administrators find that simply enabling
|
|
certain options that already exist is sufficient.
|
|
</P
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
><P
|
|
> Administrators can manage Custom Fields using the
|
|
<SPAN
|
|
CLASS="QUOTE"
|
|
>"Custom Fields"</SPAN
|
|
> link on the Administration page. The Custom
|
|
Fields administration page displays a list of Custom Fields, if any exist,
|
|
and a link to "Add a new custom field".
|
|
</P
|
|
><DIV
|
|
CLASS="section"
|
|
><H2
|
|
CLASS="section"
|
|
><A
|
|
NAME="add-custom-fields"
|
|
>3.10.1. Adding Custom Fields</A
|
|
></H2
|
|
><P
|
|
> To add a new Custom Field, click the "Add a new custom field" link. This
|
|
page displays several options for the new field, described below.
|
|
</P
|
|
><P
|
|
> The following attributes must be set for each new custom field:
|
|
<P
|
|
></P
|
|
><UL
|
|
><LI
|
|
><P
|
|
> <EM
|
|
>Name:</EM
|
|
>
|
|
The name of the field in the database, used internally. This name
|
|
MUST begin with <SPAN
|
|
CLASS="QUOTE"
|
|
>"cf_"</SPAN
|
|
> to prevent confusion with
|
|
standard fields. If this string is omitted, it will
|
|
be automatically added to the name entered.
|
|
</P
|
|
></LI
|
|
><LI
|
|
><P
|
|
> <EM
|
|
>Description:</EM
|
|
>
|
|
A brief string which is used as the label for this Custom Field.
|
|
That is the string that users will see, and should be
|
|
short and explicit.
|
|
</P
|
|
></LI
|
|
><LI
|
|
><P
|
|
> <EM
|
|
>Type:</EM
|
|
>
|
|
The type of field to create. There are
|
|
several types available:
|
|
<P
|
|
></P
|
|
><TABLE
|
|
BORDER="0"
|
|
><TBODY
|
|
><TR
|
|
><TD
|
|
> Large Text Box: A multiple line box for entering free text.
|
|
</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
> Free Text: A single line box for entering free text.
|
|
</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
> Multiple-Selection Box: A list box where multiple options
|
|
can be selected. After creating this field, it must be edited
|
|
to add the selection options. See
|
|
<A
|
|
HREF="edit-values.html#edit-values-list"
|
|
>Section 3.11.1</A
|
|
> for information about
|
|
editing legal values.
|
|
</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
> Drop Down: A list box where only one option can be selected.
|
|
After creating this field, it must be edited to add the
|
|
selection options. See
|
|
<A
|
|
HREF="edit-values.html#edit-values-list"
|
|
>Section 3.11.1</A
|
|
> for information about
|
|
editing legal values.
|
|
</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
> Date/Time: A date field. This field appears with a
|
|
calendar widget for choosing the date.
|
|
</TD
|
|
></TR
|
|
></TBODY
|
|
></TABLE
|
|
><P
|
|
></P
|
|
>
|
|
</P
|
|
></LI
|
|
><LI
|
|
><P
|
|
> <EM
|
|
>Sortkey:</EM
|
|
>
|
|
Integer that determines in which order Custom Fields are
|
|
displayed in the User Interface, especially when viewing a bug.
|
|
Fields with lower values are displayed first.
|
|
</P
|
|
></LI
|
|
><LI
|
|
><P
|
|
> <EM
|
|
>Can be set on bug creation:</EM
|
|
>
|
|
Boolean that determines whether this field can be set on
|
|
bug creation. If not selected, then a bug must be created
|
|
before this field can be set. See <A
|
|
HREF="bugreports.html"
|
|
>Section 5.6</A
|
|
>
|
|
for information about filing bugs.
|
|
</P
|
|
></LI
|
|
><LI
|
|
><P
|
|
> <EM
|
|
>Displayed in bugmail for new bugs:</EM
|
|
>
|
|
Boolean that 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.
|
|
</P
|
|
></LI
|
|
><LI
|
|
><P
|
|
> <EM
|
|
>Is obsolete:</EM
|
|
>
|
|
Boolean that determines whether this field should
|
|
be displayed at all. Obsolete Custom Fields are hidden.
|
|
</P
|
|
></LI
|
|
></UL
|
|
>
|
|
</P
|
|
></DIV
|
|
><DIV
|
|
CLASS="section"
|
|
><H2
|
|
CLASS="section"
|
|
><A
|
|
NAME="edit-custom-fields"
|
|
>3.10.2. Editing Custom Fields</A
|
|
></H2
|
|
><P
|
|
> 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 <A
|
|
HREF="edit-values.html#edit-values-list"
|
|
>Section 3.11.1</A
|
|
>. All
|
|
other attributes can be edited as described above.
|
|
</P
|
|
></DIV
|
|
><DIV
|
|
CLASS="section"
|
|
><H2
|
|
CLASS="section"
|
|
><A
|
|
NAME="delete-custom-fields"
|
|
>3.10.3. Deleting Custom Fields</A
|
|
></H2
|
|
><P
|
|
> It is only possible to delete obsolete Custom Fields
|
|
if the field has never been used in the database.
|
|
To remove a field which already has content,
|
|
mark it as obsolete.
|
|
</P
|
|
></DIV
|
|
></DIV
|
|
><DIV
|
|
CLASS="NAVFOOTER"
|
|
><HR
|
|
ALIGN="LEFT"
|
|
WIDTH="100%"><TABLE
|
|
SUMMARY="Footer navigation table"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
CELLPADDING="0"
|
|
CELLSPACING="0"
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="keywords.html"
|
|
ACCESSKEY="P"
|
|
>Prev</A
|
|
></TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="index.html"
|
|
ACCESSKEY="H"
|
|
>Home</A
|
|
></TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="edit-values.html"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
>Keywords</TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="administration.html"
|
|
ACCESSKEY="U"
|
|
>Up</A
|
|
></TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
>Legal Values</TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
></BODY
|
|
></HTML
|
|
> |