<!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.5. Flags — 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.6. Custom Fields" href="custom-fields.html" />
<link rel="prev" title="4.4. Classifications, Products, Components, Versions, and Milestones" href="categorization.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="custom-fields.html" title="4.6. Custom Fields"
accesskey="N">next</a></li>
<li class="right" >
<a href="categorization.html" title="4.4. Classifications, Products, Components, Versions, and Milestones"
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="flags">
<span id="flags-admin"></span><h1>4.5. Flags<a class="headerlink" href="#flags" title="Permalink to this headline">¶</a></h1>
<p>If you have the <span class="group">editcomponents</span> permission, you can
edit Flag Types from the main administration page. Clicking the
<span class="guilabel">Flags</span> link will bring you to the <span class="guilabel">Administer
Flag Types</span> page. Here, you can select whether you want
to create (or edit) a Bug flag or an Attachment flag.</p>
<p>The two flag types have the same administration interface, and the interface
for creating a flag and editing a flag have the same set of fields.</p>
<div class="section" id="flag-properties">
<span id="flags-edit"></span><h2>4.5.1. Flag Properties<a class="headerlink" href="#flag-properties" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt>Name</dt>
<dd>This is the name of the flag. This will be displayed
to Bugzilla users who are looking at or setting the flag.
The name may contain any valid Unicode characters except commas
and spaces.</dd>
<dt>Description</dt>
<dd>The description describes the flag in more detail. It is visible
in a tooltip when hovering over a flag either in the <span class="guilabel">Show Bug</span>
or <span class="guilabel">Edit Attachment</span> pages. This field can be as
long as you like and can contain any character you want.</dd>
<dt>Category</dt>
<dd><p class="first">You can set a flag to be visible or not visible on any combination of
products and components.</p>
<p>Default behaviour for a newly created flag is to appear on all
products and all components, which is why <code class="docutils literal"><span class="pre">__Any__:__Any__</span></code>
is already entered in the <span class="guilabel">Inclusions</span> box.
If this is not your desired behaviour, you must either set some
exclusions (for products on which you don't want the flag to appear),
or you must remove <code class="docutils literal"><span class="pre">__Any__:__Any__</span></code> from the <span class="guilabel">Inclusions</span> box
and define products/components specifically for this flag.</p>
<p>To create an Inclusion, select a Product from the top drop-down box.
You may also select a specific component from the bottom drop-down box.
(Setting <code class="docutils literal"><span class="pre">__Any__</span></code> for Product translates to
"all the products in this Bugzilla".
Selecting <code class="docutils literal"><span class="pre">__Any__</span></code> in the Component field means
"all components in the selected product.")
Selections made, press <span class="guilabel">Include</span>, and your
Product/Component pairing will show up in the <span class="guilabel">Inclusions</span> box on the right.</p>
<p>To create an Exclusion, the process is the same: select a Product from the
top drop-down box, select a specific component if you want one, and press
<span class="guilabel">Exclude</span>. The Product/Component pairing will show up in the
<span class="guilabel">Exclusions</span> box on the right.</p>
<p>This flag <em>will</em> appear and <em>can</em> be set for any
products/components appearing in the <span class="guilabel">Inclusions</span> box
(or which fall under the appropriate <code class="docutils literal"><span class="pre">__Any__</span></code>).
This flag <em>will not</em> appear (and therefore <em>cannot</em> be set) on
any products appearing in the <span class="guilabel">Exclusions</span> box.
<em>IMPORTANT: Exclusions override inclusions.</em></p>
<p>You may select a Product without selecting a specific Component,
but you cannot select a Component without a Product. If you do so,
Bugzilla will display an error message, even if all your products
have a component by that name. You will also see an error if you
select a Component that does not belong to the selected Product.</p>
<p class="last"><em>Example:</em> Let's say you have a product called
<code class="docutils literal"><span class="pre">Jet</span> <span class="pre">Plane</span></code> that has thousands of components. You want
to be able to ask if a problem should be fixed in the next model of
plane you release. We'll call the flag <code class="docutils literal"><span class="pre">fixInNext</span></code>.
However, one component in <code class="docutils literal"><span class="pre">Jet</span> <span class="pre">Plane</span></code> is
called <code class="docutils literal"><span class="pre">Pilot</span></code>, and it doesn't make sense to release a
new pilot, so you don't want to have the flag show up in that component.
So, you include <code class="docutils literal"><span class="pre">Jet</span> <span class="pre">Plane:__Any__</span></code> and you exclude
<code class="docutils literal"><span class="pre">Jet</span> <span class="pre">Plane:Pilot</span></code>.</p>
</dd>
<dt>Sort Key</dt>
<dd>Flags normally show up in alphabetical order. If you want them to
show up in a different order, you can use this key set the order on each flag.
Flags with a lower sort key will appear before flags with a higher
sort key. Flags that have the same sort key will be sorted alphabetically.</dd>
<dt>Active</dt>
<dd>Sometimes you might want to keep old flag information in the
Bugzilla database but stop users from setting any new flags of this type.
To do this, uncheck <span class="guilabel">active</span>. Deactivated
flags will still show up in the UI if they are <code class="docutils literal"><span class="pre">?</span></code>, <code class="docutils literal"><span class="pre">+</span></code>, or <code class="docutils literal"><span class="pre">-</span></code>, but
they may only be cleared (unset) and cannot be changed to a new value.
Once a deactivated flag is cleared, it will completely disappear from a
bug/attachment and cannot be set again.</dd>
<dt>Requestable</dt>
<dd>New flags are, by default, "requestable", meaning that they
offer users the <code class="docutils literal"><span class="pre">?</span></code> option, as well as <code class="docutils literal"><span class="pre">+</span></code>
and <code class="docutils literal"><span class="pre">-</span></code>.
To remove the <code class="docutils literal"><span class="pre">?</span></code> option, uncheck "requestable".</dd>
<dt>Specifically Requestable</dt>
<dd>By default this box is checked for new flags, meaning that users may make
flag requests of specific individuals. Unchecking this box will remove the
text box next to a flag; if it is still requestable, then requests
cannot target specific users and are open to anyone (called a
request "to the wind" in Bugzilla). Removing this after specific
requests have been made will not remove those requests; that data will
stay in the database (though it will no longer appear to the user).</dd>
<dt>Multiplicable</dt>
<dd>Any flag with <span class="guilabel">Multiplicable:guilabel:</span> set (default for new flags
is 'on') may be set more than once. After being set once, an unset flag
of the same type will appear below it with "addl." (short for
"additional") before the name. There is no limit to the number of
times a Multiplicable flags may be set on the same bug/attachment.</dd>
<dt>CC List</dt>
<dd>If you want certain users to be notified every time this flag is
set to <code class="docutils literal"><span class="pre">?</span></code>, <code class="docutils literal"><span class="pre">-</span></code>, or <code class="docutils literal"><span class="pre">+</span></code>, or is unset, add them here. This is a comma-separated
list of email addresses that need not be restricted to Bugzilla usernames.</dd>
<dt>Grant Group</dt>
<dd>When this field is set to some given group, only users in the group
can set the flag to <code class="docutils literal"><span class="pre">+</span></code> and <code class="docutils literal"><span class="pre">-</span></code>. This
field does not affect who can request or cancel the flag. For that,
see the <span class="guilabel">Request Group</span> field below. If this field
is left blank, all users can set or delete this flag. This field is
useful for restricting which users can approve or reject requests.</dd>
<dt>Request Group</dt>
<dd>When this field is set to some given group, only users in the group
can request or cancel this flag. Note that this field has no effect
if the <span class="guilabel">Grant Group</span> field is empty. You can set the
value of this field to a different group, but both fields have to be
set to a group for this field to have an effect.</dd>
</dl>
</div>
<div class="section" id="deleting-a-flag">
<span id="flags-delete"></span><h2>4.5.2. Deleting a Flag<a class="headerlink" href="#deleting-a-flag" title="Permalink to this headline">¶</a></h2>
<p>When you are at the <span class="guilabel">Administer Flag Types</span> screen,
you will be presented with a list of Bug flags and a list of Attachment
Flags.</p>
<p>To delete a flag, click on the <span class="guilabel">Delete</span> link next to
the flag description.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Once you delete a flag, it is <em>gone</em> from
your Bugzilla. All the data for that flag will be deleted.
Everywhere that flag was set, it will disappear,
and you cannot get that data back. If you want to keep flag data,
but don't want anybody to set any new flags or change current flags,
unset <span class="guilabel">active</span> in the flag Edit form.</p>
</div>
<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.5. Flags</a><ul>
<li><a class="reference internal" href="#flag-properties">4.5.1. Flag Properties</a></li>
<li><a class="reference internal" href="#deleting-a-flag">4.5.2. Deleting a Flag</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="categorization.html"
title="previous chapter">4.4. Classifications, Products, Components, Versions, and Milestones</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="custom-fields.html"
title="next chapter">4.6. Custom Fields</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="custom-fields.html" title="4.6. Custom Fields"
>next</a></li>
<li class="right" >
<a href="categorization.html" title="4.4. Classifications, Products, Components, Versions, and Milestones"
>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>
