<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>4.6. Custom Fields — Bugzilla 5.0.4 documentation</title>
<link rel="stylesheet" href="../_static/bugzilla.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '5.0.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="4.7. Field Values" href="field-values.html" />
<link rel="prev" title="4.5. Flags" href="flags.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="field-values.html" title="4.7. Field Values"
accesskey="N">next</a></li>
<li class="right" >
<a href="flags.html" title="4.5. Flags"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Bugzilla 5.0.4 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">4. Administration Guide</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="custom-fields">
<span id="id1"></span><h1>4.6. Custom Fields<a class="headerlink" href="#custom-fields" title="Permalink to this headline">¶</a></h1>
<p>Custom Fields are fields defined by the administrator, in addition to those
which come with Bugzilla by default. Custom Fields are treated like any other
field—they can be set in bugs and used for search queries.</p>
<p>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="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Before adding a Custom Field, make sure that Bugzilla cannot 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>
</div>
<p>Administrators can manage Custom Fields using the
<code class="docutils literal"><span class="pre">Custom</span> <span class="pre">Fields</span></code> 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" id="adding-custom-fields">
<span id="add-custom-fields"></span><h2>4.6.1. Adding Custom Fields<a class="headerlink" href="#adding-custom-fields" title="Permalink to this headline">¶</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>
<ul>
<li><p class="first"><em>Name:</em>
The name of the field in the database, used internally. This name
MUST begin with <code class="docutils literal"><span class="pre">cf_</span></code> to prevent confusion with
standard fields. If this string is omitted, it will
be automatically added to the name entered.</p>
</li>
<li><p class="first"><em>Description:</em>
A brief string used as the label for this Custom Field.
That is the string that users will see, and it should be
short and explicit.</p>
</li>
<li><p class="first"><em>Type:</em>
The type of field to create. There are
several types available:</p>
<dl class="docutils">
<dt>Bug ID:</dt>
<dd><p class="first last">A field where you can enter the ID of another bug from
the same Bugzilla installation. To point to a bug in a remote
installation, use the See Also field instead.</p>
</dd>
<dt>Large Text Box:</dt>
<dd><p class="first last">A multiple line box for entering free text.</p>
</dd>
<dt>Free Text:</dt>
<dd><p class="first last">A single line box for entering free text.</p>
</dd>
<dt>Multiple-Selection Box:</dt>
<dd><p class="first last">A list box where multiple options
can be selected. After creating this field, it must be edited
to add the selection options. See
<a class="reference internal" href="field-values.html#edit-values-list"><span class="std std-ref">Viewing/Editing Legal Values</span></a> for information about
editing legal values.</p>
</dd>
<dt>Drop Down:</dt>
<dd><p class="first last">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 class="reference internal" href="field-values.html#edit-values-list"><span class="std std-ref">Viewing/Editing Legal Values</span></a> for information about
editing legal values.</p>
</dd>
<dt>Date/Time:</dt>
<dd><p class="first last">A date field. This field appears with a
calendar widget for choosing the date.</p>
</dd>
</dl>
</li>
<li><p class="first"><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 class="first"><em>Reverse Relationship Description:</em>
When the custom field is of type <code class="docutils literal"><span class="pre">Bug</span> <span class="pre">ID</span></code>, you can
enter text here which will be used as label in the referenced
bug to list bugs which point to it. This gives you the ability
to have a mutual relationship between two bugs.</p>
</li>
<li><p class="first"><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 class="reference internal" href="../using/filing.html#filing"><span class="std std-ref">Filing a Bug</span></a>
for information about filing bugs.</p>
</li>
<li><p class="first"><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 class="first"><em>Is obsolete:</em>
Boolean that determines whether this field should
be displayed at all. Obsolete Custom Fields are hidden.</p>
</li>
<li><p class="first"><em>Is mandatory:</em>
Boolean that determines whether this field must be set.
For single and multi-select fields, this means that a (non-default)
value must be selected; for text and date fields, some text
must be entered.</p>
</li>
<li><p class="first"><em>Field only appears when:</em>
A custom field can be made visible when some criteria is met.
For instance, when the bug belongs to one or more products,
or when the bug is of some given severity. If left empty, then
the custom field will always be visible, in all bugs.</p>
</li>
<li><p class="first"><em>Field that controls the values that appear in this field:</em>
When the custom field is of type <code class="docutils literal"><span class="pre">Drop</span> <span class="pre">Down</span></code> or
<code class="docutils literal"><span class="pre">Multiple-Selection</span> <span class="pre">Box</span></code>, you can restrict the
availability of the values of the custom field based on the
value of another field. This criteria is independent of the
criteria used in the <code class="docutils literal"><span class="pre">Field</span> <span class="pre">only</span> <span class="pre">appears</span> <span class="pre">when</span></code>
setting. For instance, you may decide that some given value
<code class="docutils literal"><span class="pre">valueY</span></code> is only available when the bug status
is RESOLVED while the value <code class="docutils literal"><span class="pre">valueX</span></code> should
always be listed.
Once you have selected the field that should control the
availability of the values of this custom field, you can
edit values of this custom field to set the criteria; see
<a class="reference internal" href="field-values.html#edit-values-list"><span class="std std-ref">Viewing/Editing Legal Values</span></a>.</p>
</li>
</ul>
</div>
<div class="section" id="editing-custom-fields">
<span id="edit-custom-fields"></span><h2>4.6.2. Editing Custom Fields<a class="headerlink" href="#editing-custom-fields" title="Permalink to this headline">¶</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 class="reference internal" href="field-values.html#edit-values-list"><span class="std std-ref">Viewing/Editing Legal Values</span></a>. All
other attributes can be edited as described above.</p>
</div>
<div class="section" id="deleting-custom-fields">
<span id="delete-custom-fields"></span><h2>4.6.3. Deleting Custom Fields<a class="headerlink" href="#deleting-custom-fields" title="Permalink to this headline">¶</a></h2>
<p>Only custom fields that are marked as obsolete, and that have never
been used, can be deleted completely (else the integrity
of the bug history would be compromised). For custom fields marked
as obsolete, a "Delete" link will appear in the <code class="docutils literal"><span class="pre">Action</span></code>
column. If the custom field has been used in the past, the deletion
will be rejected. Marking the field as obsolete, however, is sufficient
to hide it from the user interface entirely.</p>
<hr class="docutils" />
<p>This documentation undoubtedly has bugs; if you find some, please file
them <a class="reference external" href="https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation">here</a>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/bugzilla.png" alt="Logo"/>
</a></p>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">4.6. Custom Fields</a><ul>
<li><a class="reference internal" href="#adding-custom-fields">4.6.1. Adding Custom Fields</a></li>
<li><a class="reference internal" href="#editing-custom-fields">4.6.2. Editing Custom Fields</a></li>
<li><a class="reference internal" href="#deleting-custom-fields">4.6.3. Deleting Custom Fields</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="flags.html"
title="previous chapter">4.5. Flags</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="field-values.html"
title="next chapter">4.7. Field Values</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="field-values.html" title="4.7. Field Values"
>next</a></li>
<li class="right" >
<a href="flags.html" title="4.5. Flags"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Bugzilla 5.0.4 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >4. Administration Guide</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
</div>
</body>
</html>
