content/qa/ooQAReloaded/Docs/QA-Reloaded-ITquery.html - openoffice-org - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <html>
   <head>
   <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
   <meta http-equiv="Content-Style-Type" content="text/css" />
   <meta name="author" content="Wolfram Garten">
   <title>IssueTracker Query</title>
   <style type="text/css">
   /* <![CDATA[ */
   <!--
   @import "/branding/css/tigris.css";
   @import "/branding/css/inst.css";
   -->
   /* ]]> */
   </style>

  <link rel="stylesheet" type="text/css" href="/branding/css/print.css" media="print" />
  <link rel="shortcut icon" href="http://www.openoffice.org/favicon.ico" />
  <script src="/branding/scripts/tigris.js" type="text/javascript"></script>
 </head>


 <body class="docs" onload="self.focus()">
 <div class="docs" id="ddissuesquery">
 <h1>Issue Tracker Query</h1>
 <h2>How to query with the IssueTracker</h2>
 <br>
 <dd>This page contains extended information about how to make queries with the IssueTracker and work with them.</dd>
 <div id="toc">
 <ul>
 <li><a href="#aboutquery">About querying the issue database</a></li>
               <li><a href="#queryfields">Issue query selection fields</a></li>
               <li><a href="#queryresults">Sorting and customizing query results</a></li>
               <li><a href="#customqueries">Customizing and remembering queries</a></li>
               <li><a href="#trackissue">Tracking your own issues (or by assignee)</a></li>
               <li><a href="#otherqueries">Running other queries</a></li>
        <li><a href="#manageresults">Managing query results</a>
               <li><a href="#formatxml">Format results as XML</a></li>
 </ul>
 </li>
 </div>


 <h2 id="aboutquery"> About querying the issue database</h2>
    <p>The Issue Tracker query form allows you to call up a subset of issues from a project's issue database. If you do not select an option, the designated default values are included in the query. Submitting a query without setting any options at all, for example, returns <em>all</em> project issues with a status of NEW, STARTED, or REOPENED. You can narrow query results by selecting options and/or entering information in the query form fields. You can save your results list in your bookmark file. You can also save your query configuration to reuse later.</p>


    <h2 id="queryfields">Issue query selection fields</h2>
   <p>The following fields are available for narrowing the query results.</p>
     <dl>
     <dt><i>Issue type</i></dt>
     <dd>the classification of issues as either <a href="http://qa.openoffice.org/ooQAReloaded/Docs/QA-Reloaded-ITguide.html#types">tasks, defects, features, or enhancements</a>.</dd>
     <dt><i>Component</i></dt>
     <dd>the part of the project associated with the issue you are querying to find. If you don't choose a component or subcomponent, the query addresses all issues for the <em>project</em>.</dd>
     <dt><i>Subcomponent</i></dt>
     <dd>a subset of the component you selected in the previous field. If you don't choose a sub component, the query includes all issues for the component.</dd>
     <dt><i>Status</i></dt>
     <dd>default values for this fields are NEW, STARTED and REOPENED. When searching for issues that are UNCONFIRMED, RESOLVED, VERIFIED, or CLOSED, remember to change this status field appropriately.</dd>
     <dt><i>Resolution</i></dt>
     <dd>the qualification of issues with a status of RESOLVED, VERIFIED, OR CLOSED. All resolved issues must be assigned one of these values.</dd>
     <dt><i>Priority</i></dt>
     <dd>queries for issues by their rank of importance using the following scale: P1 is highest priority, given to issues that should be addressed as soon as possible; P5 is the lowest priority.</dd>
     <dt><i>Platform</i></dt>
     <dd>is the type of computer the issues is associated with. This field is most critical when searching for defects. When querying for other types of issues, it may not be necessary to make a selection in this field.</dd>
     <dt><i>OS</i></dt>
     <dd>is the type of operating system the issue is associated with. Again, when querying for other types of issues, it may not be necessary to make a selection in this field.</dd>
     <dt><i>Version</i></dt>
     <dd>The release of the software associated with this issue. Leaving this field unselected queries all versions of the selected project or component.</dd>
     <dt><i>Target milestone</i></dt>
     <dd>queries for issues associated with different project milestones, if your project has these. Milestones typically are dates when certain features or overall versions are expected to be completed.</dd>
     <dt><i>Username</i></dt>
     <dd>
      lets you query for issues by the username of assignee, reporter, QA contact, cc list, or added comments. A duplicate field lets you further refine queries based on this criteria. To search for issues associated with a username:
      <ul>
       <li>Type a portion of a username into the text field.</li>
       <li>Select fields to query for association with that username.</li>
      </ul>
      <p>The second field enables you to look for two different usernames. If you specify both, then only issues matching both are returned in your query results. For example, this is useful to find issues "created by Ralph" and "assigned to Fred."</p>
      <p>You can also use the drop down menus to specify whether you want to match username by doing a substring match or exact match of a fully specified username.</p>
    </dd>
    <br>
     <dt><b>Miscellaneous query fields</b></dt>
   <dd>
    <p>Additional input fields let you further qualify queries by issue number(s), date changes, number of votes, and changes in field values.</p>
    <dl>
       <dt><i>Summary</i></dt>
         <dd>allows you to query on the one-line abbreviated description of the issue used by default in reports and query results.</dd>
       <dt><i>Description</i></dt>
         <dd>allows you to query by text string from the longer, detailed issue description.</dd>
       <dt><i>URL</i></dt>
         <dd>allows you to query by the web page location associated with issues, when applicable.</dd>
       <dt><i>Status Whiteboard</i></dt>
         <dd>allows you to query on the field defined by the project owner (or users with Issue Tracker administrative permissions). Input values to query by this field thus depend upon how it is being used in a particular project. </dd>
       <dt><i>Keywords</i></dt>
         <dd>allows you to query on the keywords defined for the project. If the project administrator has not defined any keywords, this field will not appear on the <strong>Query</strong> page. To view a list of the keywords defined for this project, click the <strong>Keyword</strong> link next to this field.</dd>
      </dl>
     <p>Those who prefer to devise their own query schemes beyond options provided in these from fields provided can <a href="/nonav/scdocs/booleanchart.html">set up Boolean chart queries</a>.</p>
         </dd>
       </dl>


    <h2 id="queryresults">Sorting and customizing query results</h2>
    <p>Before submitting a query, you can select to sort by issue number, importance, or assignee. After you submitted a query during an Issue Tracker login session, you have the option to "Reuse the same sort as last time."</p>
    <p>Once you view the query results, clicking on any of the column headings will sort the displayed results within that column.</p>
    <p>Using the links at the bottom of the query results page, you can also:</p>
    <ul>
    <li>Switch to "long format" view of results to display complete contents of issues.</li>
     <li>Load a new query form.</li>
     <li>Enter a new issue.</li>
     <li>Change which columns appear in query results.</li>
     <li>Change several issues at once. (This option displays a page that lets you select issues from your query results list and modify specific fields in all of these simultaneously.)</li>
     <li>Send e-mail to owners of issues listed.</li>
     <li>Edit the configuration of the last query.</li>
     <li>View XML representations of all issues returned</li>
     <li>Download the query results in different formats (Excel, CSV, tab-delimited)</li>
    </ul>
    <p>To add the target milestone for each issue to your query results -- and you should do so when a particular issue is slated for release --</p>
    <ol>
     <li>Do a query (or click "view assigned issues").</li>
     <li>Click the "change columns" link at the bottom.</li>
     <li>Click the "target milestone" check box.</li>
     <li>Submit.</li>
    </ol>
    <p>The target milestone column will now included for all your subsequent queries because login sessions are cookie-based. You can unmark this checkbox or mark others at any time to change your customized query results.</p>


    <h2 id="customqueries">Customizing and remembering queries</h2>
    <p>Once you've set up a fairly complex query to ferret out certain issues, you can tell the Issue Tracker to "remember" your custom queries as a time saver. Using the options just above the <em>Submit query</em> button, you can save your most recent query under a unique name and reuse it anytime you are logged in to the Issue Tracker. You can also change and reset the default query that the query page loads during your login sessions.</p>
    <p>To include your custom, named queries in the footer of the query page, click on the "Edit prefs" link on any of the Issue Tracker pages and select the "Page footer link". All of your named queries have the option to be included on every page or only on the query page.</p>


    <h2 id="trackissue">Tracking your own issues (or by assignee)</h2>
    <p><strong>To view a list of project issues assigned to you</strong>, click the <em>My Issues</em> link in the Issue Tracking page.</p>
    <p>Once you have invoked the Issue Tracker, you can also click the <em>My issues</em> link in the secondary Issue Tracking tool bar.</p>
    <p><strong>You have two options for viewing other project members' assigned issues</strong>:</p>
    <ul>
     <li>Create an Issue Tracker query using the "search the issue database" link and search by the "assigned to" field with the person's name entered. (The default setting for the "status" in the query screen includes NEW, STARTED, and REOPENED.)</li>
     <li>Select the "Members" link in the left navigation bar to view a list of project members by name, each with a link to their assigned project issues.</li>
    </ul>
    <p>You can copy the URL of a query's result and paste it into an HTML file to help you create quick access tools for the project. For example, you could create a page listing project members by name with links to their specific list of issues by querying on the assigned to field for each user and pasting the resultant URL into an HTML page listing the project members. This page could then be added to the Documents and files section of the project to give members a quick and easy way of viewing the lists of issues assigned to themselves and other project members.</p>


    <h2 id="otherqueries">Running queries not supported by the query fields</h2>
    <p>You can perform some searches that are not supported by the query form by using the issue list script to build queries based on the URL. You can add other criteria to these queries.</p>
    <p>For example, if you wanted to see all issues reported against the X platform and assigned to user "jwz," you could ask for all issues assign to jwz, then edit the URL in the "Location" box, adding the clause "&amp;rep_platform=X-Windows" to the URL.</p>
    <p>Here is a list of some of the field names you could use for additional unsupported searches ...</p>
   <ul>
     <li>version</li>
     <li>rep_platform</li>
     <li>op_sys</li>
     <li>reporter area</li>
     <li>issue_file_loc</li>
     <li>short_desc</li>
   </ul>


   <h2 id="manageresults">Managing query results</h2>
   <p>After running an Issue Tracker query, you can view or download the query
     results in several different formats by clicking one of the buttons below
     the query results table.</p>
   <ul>
     <li><strong>Long format:</strong> Query results are presented in the browser window
       in detail. This format includes all data fields containing values in the
       issue and field name labels.</li>
     <li><strong>Format as XML: </strong>Query results are saved to a file on your local
       drive in XML format. Clicking this button takes you to the <strong>Format as
       XML</strong> page where you can define your export parameters before saving the
       file.</li>
     <li><strong>Excel format: </strong>Query results are saved to your local drive in an
       Excel (.xls) file.</li>
     <li><strong>Comma-delimited: </strong>Query results are presented in a comma-delimited
       (.csv) file. You can open this file or save it to your local drive.</li>
     <li><strong>Tab-delimited: </strong>Query results are presented in a tab-delimited test
       (.txt) file. You can view the results in your browser or save them to your
       local drive.</li>
   </ul>


   <h2 id="formatxml">Format results as XML</h2>
   <p>The <strong>Format as XML</strong> page allows you to define the file containing the
     XML representation of your query results. You can choose whether to include
     issue attachments or the DTD in your export file as well as whether to display
     the file in the browser or download it to your local drive. You can also define
     the file name.</p>
   <p>Including the DTD in the export file is provided as a convenience for those
     who may be unable to reference the DTD across a network. Under most circumstances,
     doing so is unnecessary.</p>


   </div>
   <br>
     <div align=right>Reworked by Wolfram Garten</div>
  </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
	<html>
	<head>
	<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
	<meta http-equiv="Content-Style-Type" content="text/css" />
	<meta name="author" content="Wolfram Garten">
	<title>IssueTracker Query</title>
	<style type="text/css">
	/* <![CDATA[ */
	<!--
	@import "/branding/css/tigris.css";
	@import "/branding/css/inst.css";
	-->
	/* ]]> */
	</style>

	<link rel="stylesheet" type="text/css" href="/branding/css/print.css" media="print" />
	<link rel="shortcut icon" href="http://www.openoffice.org/favicon.ico" />
	<script src="/branding/scripts/tigris.js" type="text/javascript"></script>
	</head>


	<body class="docs" onload="self.focus()">
	<div class="docs" id="ddissuesquery">
	<h1>Issue Tracker Query</h1>
	<h2>How to query with the IssueTracker</h2>
	<br>
	<dd>This page contains extended information about how to make queries with the IssueTracker and work with them.</dd>
	<div id="toc">
	<ul>
	<li><a href="#aboutquery">About querying the issue database</a></li>
	<li><a href="#queryfields">Issue query selection fields</a></li>
	<li><a href="#queryresults">Sorting and customizing query results</a></li>
	<li><a href="#customqueries">Customizing and remembering queries</a></li>
	<li><a href="#trackissue">Tracking your own issues (or by assignee)</a></li>
	<li><a href="#otherqueries">Running other queries</a></li>
	<li><a href="#manageresults">Managing query results</a>
	<li><a href="#formatxml">Format results as XML</a></li>
	</ul>
	</li>
	</div>


	<h2 id="aboutquery"> About querying the issue database</h2>
	<p>The Issue Tracker query form allows you to call up a subset of issues from a project's issue database. If you do not select an option, the designated default values are included in the query. Submitting a query without setting any options at all, for example, returns <em>all</em> project issues with a status of NEW, STARTED, or REOPENED. You can narrow query results by selecting options and/or entering information in the query form fields. You can save your results list in your bookmark file. You can also save your query configuration to reuse later.</p>


	<h2 id="queryfields">Issue query selection fields</h2>
	<p>The following fields are available for narrowing the query results.</p>
	<dl>
	<dt><i>Issue type</i></dt>
	<dd>the classification of issues as either <a href="http://qa.openoffice.org/ooQAReloaded/Docs/QA-Reloaded-ITguide.html#types">tasks, defects, features, or enhancements</a>.</dd>
	<dt><i>Component</i></dt>
	<dd>the part of the project associated with the issue you are querying to find. If you don't choose a component or subcomponent, the query addresses all issues for the <em>project</em>.</dd>
	<dt><i>Subcomponent</i></dt>
	<dd>a subset of the component you selected in the previous field. If you don't choose a sub component, the query includes all issues for the component.</dd>
	<dt><i>Status</i></dt>
	<dd>default values for this fields are NEW, STARTED and REOPENED. When searching for issues that are UNCONFIRMED, RESOLVED, VERIFIED, or CLOSED, remember to change this status field appropriately.</dd>
	<dt><i>Resolution</i></dt>
	<dd>the qualification of issues with a status of RESOLVED, VERIFIED, OR CLOSED. All resolved issues must be assigned one of these values.</dd>
	<dt><i>Priority</i></dt>
	<dd>queries for issues by their rank of importance using the following scale: P1 is highest priority, given to issues that should be addressed as soon as possible; P5 is the lowest priority.</dd>
	<dt><i>Platform</i></dt>
	<dd>is the type of computer the issues is associated with. This field is most critical when searching for defects. When querying for other types of issues, it may not be necessary to make a selection in this field.</dd>
	<dt><i>OS</i></dt>
	<dd>is the type of operating system the issue is associated with. Again, when querying for other types of issues, it may not be necessary to make a selection in this field.</dd>
	<dt><i>Version</i></dt>
	<dd>The release of the software associated with this issue. Leaving this field unselected queries all versions of the selected project or component.</dd>
	<dt><i>Target milestone</i></dt>
	<dd>queries for issues associated with different project milestones, if your project has these. Milestones typically are dates when certain features or overall versions are expected to be completed.</dd>
	<dt><i>Username</i></dt>
	<dd>
	lets you query for issues by the username of assignee, reporter, QA contact, cc list, or added comments. A duplicate field lets you further refine queries based on this criteria. To search for issues associated with a username:
	<ul>
	<li>Type a portion of a username into the text field.</li>
	<li>Select fields to query for association with that username.</li>
	</ul>
	<p>The second field enables you to look for two different usernames. If you specify both, then only issues matching both are returned in your query results. For example, this is useful to find issues "created by Ralph" and "assigned to Fred."</p>
	<p>You can also use the drop down menus to specify whether you want to match username by doing a substring match or exact match of a fully specified username.</p>
	</dd>
	<br>
	<dt><b>Miscellaneous query fields</b></dt>
	<dd>
	<p>Additional input fields let you further qualify queries by issue number(s), date changes, number of votes, and changes in field values.</p>
	<dl>
	<dt><i>Summary</i></dt>
	<dd>allows you to query on the one-line abbreviated description of the issue used by default in reports and query results.</dd>
	<dt><i>Description</i></dt>
	<dd>allows you to query by text string from the longer, detailed issue description.</dd>
	<dt><i>URL</i></dt>
	<dd>allows you to query by the web page location associated with issues, when applicable.</dd>
	<dt><i>Status Whiteboard</i></dt>
	<dd>allows you to query on the field defined by the project owner (or users with Issue Tracker administrative permissions). Input values to query by this field thus depend upon how it is being used in a particular project. </dd>
	<dt><i>Keywords</i></dt>
	<dd>allows you to query on the keywords defined for the project. If the project administrator has not defined any keywords, this field will not appear on the <strong>Query</strong> page. To view a list of the keywords defined for this project, click the <strong>Keyword</strong> link next to this field.</dd>
	</dl>
	<p>Those who prefer to devise their own query schemes beyond options provided in these from fields provided can <a href="/nonav/scdocs/booleanchart.html">set up Boolean chart queries</a>.</p>
	</dd>
	</dl>


	<h2 id="queryresults">Sorting and customizing query results</h2>
	<p>Before submitting a query, you can select to sort by issue number, importance, or assignee. After you submitted a query during an Issue Tracker login session, you have the option to "Reuse the same sort as last time."</p>
	<p>Once you view the query results, clicking on any of the column headings will sort the displayed results within that column.</p>
	<p>Using the links at the bottom of the query results page, you can also:</p>
	<ul>
	<li>Switch to "long format" view of results to display complete contents of issues.</li>
	<li>Load a new query form.</li>
	<li>Enter a new issue.</li>
	<li>Change which columns appear in query results.</li>
	<li>Change several issues at once. (This option displays a page that lets you select issues from your query results list and modify specific fields in all of these simultaneously.)</li>
	<li>Send e-mail to owners of issues listed.</li>
	<li>Edit the configuration of the last query.</li>
	<li>View XML representations of all issues returned</li>
	<li>Download the query results in different formats (Excel, CSV, tab-delimited)</li>
	</ul>
	<p>To add the target milestone for each issue to your query results -- and you should do so when a particular issue is slated for release --</p>
	<ol>
	<li>Do a query (or click "view assigned issues").</li>
	<li>Click the "change columns" link at the bottom.</li>
	<li>Click the "target milestone" check box.</li>
	<li>Submit.</li>
	</ol>
	<p>The target milestone column will now included for all your subsequent queries because login sessions are cookie-based. You can unmark this checkbox or mark others at any time to change your customized query results.</p>


	<h2 id="customqueries">Customizing and remembering queries</h2>
	<p>Once you've set up a fairly complex query to ferret out certain issues, you can tell the Issue Tracker to "remember" your custom queries as a time saver. Using the options just above the <em>Submit query</em> button, you can save your most recent query under a unique name and reuse it anytime you are logged in to the Issue Tracker. You can also change and reset the default query that the query page loads during your login sessions.</p>
	<p>To include your custom, named queries in the footer of the query page, click on the "Edit prefs" link on any of the Issue Tracker pages and select the "Page footer link". All of your named queries have the option to be included on every page or only on the query page.</p>


	<h2 id="trackissue">Tracking your own issues (or by assignee)</h2>
	<p><strong>To view a list of project issues assigned to you</strong>, click the <em>My Issues</em> link in the Issue Tracking page.</p>
	<p>Once you have invoked the Issue Tracker, you can also click the <em>My issues</em> link in the secondary Issue Tracking tool bar.</p>
	<p><strong>You have two options for viewing other project members' assigned issues</strong>:</p>
	<ul>
	<li>Create an Issue Tracker query using the "search the issue database" link and search by the "assigned to" field with the person's name entered. (The default setting for the "status" in the query screen includes NEW, STARTED, and REOPENED.)</li>
	<li>Select the "Members" link in the left navigation bar to view a list of project members by name, each with a link to their assigned project issues.</li>
	</ul>
	<p>You can copy the URL of a query's result and paste it into an HTML file to help you create quick access tools for the project. For example, you could create a page listing project members by name with links to their specific list of issues by querying on the assigned to field for each user and pasting the resultant URL into an HTML page listing the project members. This page could then be added to the Documents and files section of the project to give members a quick and easy way of viewing the lists of issues assigned to themselves and other project members.</p>


	<h2 id="otherqueries">Running queries not supported by the query fields</h2>
	<p>You can perform some searches that are not supported by the query form by using the issue list script to build queries based on the URL. You can add other criteria to these queries.</p>
	<p>For example, if you wanted to see all issues reported against the X platform and assigned to user "jwz," you could ask for all issues assign to jwz, then edit the URL in the "Location" box, adding the clause "&rep_platform=X-Windows" to the URL.</p>
	<p>Here is a list of some of the field names you could use for additional unsupported searches ...</p>
	<ul>
	<li>version</li>
	<li>rep_platform</li>
	<li>op_sys</li>
	<li>reporter area</li>
	<li>issue_file_loc</li>
	<li>short_desc</li>
	</ul>


	<h2 id="manageresults">Managing query results</h2>
	<p>After running an Issue Tracker query, you can view or download the query
	results in several different formats by clicking one of the buttons below
	the query results table.</p>
	<ul>
	<li><strong>Long format:</strong> Query results are presented in the browser window
	in detail. This format includes all data fields containing values in the
	issue and field name labels.</li>
	<li><strong>Format as XML: </strong>Query results are saved to a file on your local
	drive in XML format. Clicking this button takes you to the <strong>Format as
	XML</strong> page where you can define your export parameters before saving the
	file.</li>
	<li><strong>Excel format: </strong>Query results are saved to your local drive in an
	Excel (.xls) file.</li>
	<li><strong>Comma-delimited: </strong>Query results are presented in a comma-delimited
	(.csv) file. You can open this file or save it to your local drive.</li>
	<li><strong>Tab-delimited: </strong>Query results are presented in a tab-delimited test
	(.txt) file. You can view the results in your browser or save them to your
	local drive.</li>
	</ul>


	<h2 id="formatxml">Format results as XML</h2>
	<p>The <strong>Format as XML</strong> page allows you to define the file containing the
	XML representation of your query results. You can choose whether to include
	issue attachments or the DTD in your export file as well as whether to display
	the file in the browser or download it to your local drive. You can also define
	the file name.</p>
	<p>Including the DTD in the export file is provided as a convenience for those
	who may be unable to reference the DTD across a network. Under most circumstances,
	doing so is unnecessary.</p>


	</div>
	<br>
	<div align=right>Reworked by Wolfram Garten</div>
	</body>
	</html>