rt4-doc-html 4.4.1-3+deb9u3 / usr / share / doc / rt4-doc-html / charts.html

<ul id="index">
  <li><a href="#RT-Charts">RT Charts</a></li>
  <li><a href="#Enabling-Charts">Enabling Charts</a>
    <ul>
      <li><a href="#Installing-GD">Installing GD</a></li>
      <li><a href="#Chart-Configuration-Options">Chart Configuration Options</a></li>
    </ul>
  </li>
  <li><a href="#Basic-Charting">Basic Charting</a>
    <ul>
      <li><a href="#Basic-Ticket-Search">Basic Ticket Search</a></li>
      <li><a href="#Ticket-Charts">Ticket Charts</a></li>
      <li><a href="#Using-Multiple-Group-Bys">Using Multiple Group Bys</a></li>
    </ul>
  </li>
  <li><a href="#Calculated-Values">Calculated Values</a>
    <ul>
      <li><a href="#Viewing-Ticket-Response-Times">Viewing Ticket Response Times</a></li>
    </ul>
  </li>
  <li><a href="#Chart-Style-and-Size">Chart Style and Size</a></li>
  <li><a href="#Saving-Charts">Saving Charts</a></li>
</ul>

<h1 id="RT-Charts"><a href="#___top">RT Charts</a></h1>

<p>RT has a built-in charting feature to allow you to create charts and graphs to visualize ticket data. Charts can be useful for anything from one-off reports (how many tickets did we process last year?) to regular status reports that you then include in shared dashboards that everyone can see.</p>

<p>RT has had charts for a long time, but many significant improvements came in RT 4.2. If you&#39;re running a version of RT earlier than 4.2 some options and features described here may not be available.</p>

<h1 id="Enabling-Charts"><a href="#___top">Enabling Charts</a></h1>

<h2 id="Installing-GD"><a href="#___top">Installing GD</a></h2>

<p>While charts is a core part of RT, you do need to enable it using the <code>--enable-gd</code> option and install the required dependencies when you install RT. If you didn&#39;t originally install with this flag, you can enable it by re-running the <a href="http://metacpan.org/module/configure"><code>configure</code></a> script from the RT distribution (including all previous options passed to it originally) or doing the following in your current install:</p>

<ol>

<li><p>In your <code>RT_SiteConfig.pm</code> set <code>$DisableGD</code> to 0:</p>

<pre><code>    Set($DisableGD, 0);</code></pre>

</li>
<li><p>Run the RT dependency checker:</p>

<pre><code>    $ /opt/rt4/sbin/rt-test-dependencies --with-gd --verbose</code></pre>

</li>
<li><p>Install GD libraries</p>

<p>GD is an open source graphics library and it is available as a package for most Linux systems. The package might be called <code>gd</code>, <code>gd2</code>, <code>libgd2</code>, or something similar. On some systems you will also need additional package required to compile code using the library. The package might be called <code>gd-devel</code>, <code>gd2-dev</code>, or something similar.</p>

</li>
<li><p>Install Perl GD modules:</p>

<pre><code>    $ /opt/rt4/sbin/rt-test-dependencies --with-gd --install --verbose</code></pre>

</li>
</ol>

<h2 id="Chart-Configuration-Options"><a href="#___top">Chart Configuration Options</a></h2>

<p>By default, RT is configured to use the &quot;Droid Sans&quot; font for Unicode support across English, many western european languages, Chinese (Traditional and Simplified), and Japanese. If you prefer to use a different font, you can change the <a href="../../rt/latest/RT_Config.html#ChartFont">&quot;<code>%ChartFont</code>&quot;</a> option.</p>

<p>There is also an option to use database timezone conversion for PostgreSQL and MySQL to enable timezone conversion for time-based reports. See <i><a href="../../rt/latest/customizing/timezones_in_charts.html">docs/customizing/timezones_in_charts.pod</a></i> for details.</p>

<p>Search for &quot;Chart&quot; entries in <a href="../../rt/latest/RT_Config.html"><code>RT_Config</code></a> for more information on these options.</p>

<h1 id="Basic-Charting"><a href="#___top">Basic Charting</a></h1>

<p>Charts are based on the set of tickets returned by a search, so every chart starts with a search of your RT tickets. When constructing your search, think about the report you need to generate and try to narrow the results to the set of tickets that will have the information you want.</p>

<h2 id="Basic-Ticket-Search"><a href="#___top">Basic Ticket Search</a></h2>

<p>As a basic example, assume you want to look at activity in July 2012 for the General queue. First use the Query Builder to build a query with something like:</p>

<pre><code>    Queue = &#39;General&#39;
    AND Created &gt;= &#39;2012-07-01&#39;
    AND Created &lt;= &#39;2012-07-31&#39;</code></pre>

<p>This search will give you tickets for July because the criteria uses before and after for the dates.</p>

<p>This search shows one of the initial things you&#39;ll want to consider, which is the element of ticket metadata you want to use as the basis for time. In the example we&#39;re using Created, but depending on what you are reporting on you might want Started, Resolved, or any of the other ticket time values.</p>

<p>When selecting the criteria for the time search, make sure it is appropriate to the report you want to see and be consistent so you are looking at the right set of tickets in the search and the resulting charts and reports.</p>

<p>For this example, we&#39;ll say the activity we want to look at is new tickets coming into the queue, and Created works well for that.</p>

<h2 id="Ticket-Charts"><a href="#___top">Ticket Charts</a></h2>

<p>If we run the search and look at the results, we get the standard RT search results page. From this page we can click on Chart in the submenu on the upper right of the page. This brings us to the Charts page with a default bar chart showing tickets by status in the General queue.</p>

<img alt="General Queue Status Chart" src="images/general-status-chart.png">

<p>This chart gives us a nice view of tickets by status and the good news is most of the tickets in this time period have been resolved. Under the graph is a &quot;Group by&quot; section and we can see &quot;Status&quot; is selected as the criteria in the first dropdown in the first section. The second dropdown is also Status since status only has one representation.</p>

<p>Now let&#39;s assume we want to see who was working on those tickets. You can select Owner from the first &#39;Group tickets by&#39; dropdown and you&#39;ll see the second dropdown now has options to display labels based on RT user entries. Select an option and click &#39;Update Chart&#39; and now you&#39;ll see the tickets displayed by Owner.</p>

<img alt="General Owner Chart" src="images/general-owner-chart.png">

<p>In this case, we can see that although people are resolving tickets, they aren&#39;t Taking the tickets and Owner is not getting set. We may want to remind people to take tickets or even create a scrip to set Owner automatically on reply or resolve.</p>

<p>Before we do that, we can use more chart features to find out more about what&#39;s going on. The &quot;Group by&quot; portlet allows us to set multiple criteria, so in the second set of dropdowns we&#39;ll select LastUpdatedBy and Name and click &#39;Update Chart&#39;.</p>

<img alt="General Owner LastUpdatedBy Chart" src="images/general-owner-lastupdated-chart.png">

<p>Now we can see that our culprit seems to primarily be the root user, who is getting a bunch of work done but isn&#39;t taking tickets. Maybe we just need to remind root to take tickets.</p>

<h2 id="Using-Multiple-Group-Bys"><a href="#___top">Using Multiple Group Bys</a></h2>

<p>As you can see in the previous example, RT&#39;s charts allow you to define multiple criteria for grouping data from your search results. In many cases, grouping multiple levels of criteria can reveal interesting and useful graphs. To give you the greatest flexibility possible, the RT interface allows you to select from nearly all ticket values, but not all combinations of group by criteria will make sense or create a helpful chart. If you select some options and produce a chart that looks jumbled, consider again what you&#39;re trying to visualize from the data.</p>

<h1 id="Calculated-Values"><a href="#___top">Calculated Values</a></h1>

<p>The Calculate section of the RT charts interface allows you to generate charts with calculated time values. You can select time values used in time tracking (e.g., TimeWorked) and calculated values from the various timestamps on tickets like Created, Resolved, etc. Once you have selected the values or ranges you want to view, you can choose to see an Average, Total, Maximum, Minimum or a summary presenting them all.</p>

<h2 id="Viewing-Ticket-Response-Times"><a href="#___top">Viewing Ticket Response Times</a></h2>

<p>As described above, the Calculate section allows you to pull out durations like how long it took for tickets to be opened, which is the difference between Created and Started. To create a chart with this information, we first create a new search to return all resolved tickets for a select group of queues we&#39;re interested in. You could also add some date criteria to narrow the search to a range of time as in the previous example.</p>

<p>After getting our result set and clicking on Charts, we select Queue from the &quot;Group by&quot; section so we see data grouped by the queues we selected. In the Calculate section we select Created-Started from the first dropdown and the Summary option from the second dropdown and click &quot;Update Chart&quot;.</p>

<p>This generates a detailed chart with a bunch of time data for all of the queues we selected in our search. It&#39;s a little busy, so we might look at some of the other display options available in the second dropdown. What we&#39;re really interested in is the average time from Created to Started, since this will give us a general idea how long it&#39;s taking people to initially respond to requests.</p>

<p>The second dropdown in the Calculate section has an option for &quot;Average Created-Started&quot;. If we select that and update the chart, we see a nice graph of average time for tickets to be opened across all of the queues we selected.</p>

<img alt="Queue Created Started Chart" src="images/queue-created-started-chart.png">

<p>Now perhaps we also want to see how long tickets stay active. In the Calculate section you can add Started-Resolved to the first &quot;and then&quot; and select &quot;Average Started-Resolved&quot; from the second dropdown. Click &quot;Update Chart&quot; and you&#39;ve now got a graphical view of how long, on average, tickets are waiting to be opened and how long people are working on them.</p>

<p>If you use RT for time tracking, you can create similar useful charts using TimeEstimated, TimeWorked, and TimeLeft.</p>

<h1 id="Chart-Style-and-Size"><a href="#___top">Chart Style and Size</a></h1>

<p>Charts default to a bar style, but you can display data as a pie chart by selecting pie in the &quot;Picture&quot; portlet. You can also adjust the width height of the generated chart by entering a size in pixels. These width and height values are saved if you save the chart and are used if you include the chart on a Dashboard as well.</p>

<h1 id="Saving-Charts"><a href="#___top">Saving Charts</a></h1>

<p>Much like searches, you can save charts once you get them configured the way you want. The Privacy setting determines who else on the RT system will be able to see your saved charts. Note that this setting applies only to the chart itself and not necessarily the data included which may still be blocked from other users.</p>

<p>To save a chart, select a Privacy setting, give it a Description and click Save. Once saved, you can retrieve the chart later by coming to the chart page and selecting it from the &quot;Load saved search&quot; dropdown and clicking Load.</p>

<p>When you save a chart, it also becomes available to the Dashboard interface. This allows you to go to Home &gt; New Dashboard and create a Dashboard that shows the chart you have created. This can be very useful for charts you want to monitor frequently or create for others.</p>

<p>If you need to change a chart, load it, make your changes, then click Update. Delete deletes the saved chart and will also remove it from all Dashboards that are using it.</p>

<a href="./">&larr; Back to index</a>