[Rt-commit] rt branch, 4.4/user-time-worked, created. rt-4.4.4-421-g621cf9d4bc
Craig Kaiser
craig at bestpractical.com
Thu May 6 17:10:52 EDT 2021
The branch, 4.4/user-time-worked has been created
at 621cf9d4bccdd4fa815c8758f3f8fbf7b329bc63 (commit)
- Log -----------------------------------------------------------------
commit dbeff4207477cf7c7aed043466f1c724a1d033f7
Author: Craig Kaiser <craig at bestpractical.com>
Date: Fri Jul 27 12:18:16 2018 -0400
Create a standard RT Time Worked report
diff --git a/share/html/Elements/Tabs b/share/html/Elements/Tabs
index 4d91c5b0df..07f8c2c087 100644
--- a/share/html/Elements/Tabs
+++ b/share/html/Elements/Tabs
@@ -648,6 +648,11 @@ my $build_main_nav = sub {
path => '/Reports/ResolvedByDates.html',
description => loc('Examine tickets resolved in a queue between two dates'),
);
+ $reports->child( user_time =>
+ title => loc('User time worked'),
+ description => loc('User time worked'),
+ path => '/Reports/TimeWorkedReport.html',
+ );
$reports->child( createdindaterange =>
title => loc('Created in a date range'),
path => '/Reports/CreatedByDates.html',
diff --git a/share/html/Reports/TimeWorkedReport.html b/share/html/Reports/TimeWorkedReport.html
new file mode 100644
index 0000000000..86046bbd15
--- /dev/null
+++ b/share/html/Reports/TimeWorkedReport.html
@@ -0,0 +1,225 @@
+%# BEGIN BPS TAGGED BLOCK {{{
+%#
+%# COPYRIGHT:
+%#
+%# This software is Copyright (c) 1996-2018 Best Practical Solutions, LLC
+%# <sales at bestpractical.com>
+%#
+%# (Except where explicitly superseded by other copyright notices)
+%#
+%#
+%# LICENSE:
+%#
+%# This work is made available to you under the terms of Version 2 of
+%# the GNU General Public License. A copy of that license should have
+%# been provided with this software, but in any event can be snarfed
+%# from www.gnu.org.
+%#
+%# This work is distributed in the hope that it will be useful, but
+%# WITHOUT ANY WARRANTY; without even the implied warranty of
+%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+%# General Public License for more details.
+%#
+%# You should have received a copy of the GNU General Public License
+%# along with this program; if not, write to the Free Software
+%# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+%# 02110-1301 or visit their web page on the internet at
+%# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+%#
+%#
+%# CONTRIBUTION SUBMISSION POLICY:
+%#
+%# (The following paragraph is not intended to limit the rights granted
+%# to you to modify and distribute this software under the terms of
+%# the GNU General Public License and is only of importance to you if
+%# you choose to contribute your changes and enhancements to the
+%# community by submitting them to Best Practical Solutions, LLC.)
+%#
+%# By intentionally submitting any modifications, corrections or
+%# derivatives to this work, or any other work intended for use with
+%# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+%# you are the copyright holder for those contributions and you grant
+%# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
+%# royalty-free, perpetual, license to use, copy, create derivative
+%# works based on those contributions, and sublicense and distribute
+%# those contributions and any derivatives thereof.
+%#
+%# END BPS TAGGED BLOCK }}}
+<& /Elements/Header, Title => loc("User Time Worked") &>
+<& /Elements/Tabs &>
+<& /Elements/ListActions, actions => \@results &>
+
+<div class="user-timeworked-form-content">
+ <form method="POST">
+ <div style="display: inline-block">
+ <div class="add-user">
+ <input style="width: 17em" class="user-time-worked-input" name="user_req"
+ data-autocomplete="Users"
+ data-autocomplete-return="Name"
+ placeholder="<% loc("Find a user...") %>" Value = <% $user_req %>
+ >
+ </div>
+ <div>
+ <& /Elements/SelectDate, ShowTime => 0, Name => 'startdate', Default => $startdate &>
+ </div>
+ <div>
+ <& /Elements/SelectDate, ShowTime => 0, Name => 'enddate', Default => $enddate &>
+ </div>
+ </div>
+ <div style="display: inline-block; vertical-align: top;">
+ <& /Elements/SelectQueue, Multiple => 1, Size => 4, Name => 'queue_limit', Id => 'queues', Default => ($queues||'') &>
+ </div>
+ <div>
+ <input <% $SortBy eq 'Date' ? 'checked="checked"' : '' |n%> checked="checked" type="radio" name="SortBy" id="DateWorked" value="Date">
+ <label for="DateWorked"><&|/l&>Date time worked</&></label>
+
+ <input <% $SortBy eq 'User' ? 'checked="checked"' : '' |n%> type="radio" name="SortBy" id="ByUser" value="User">
+ <label for="ByUser"><&|/l&>By User</&></label>
+
+ <input <% $SortBy eq 'Ticket' ? 'checked="checked"' : '' |n%> type="radio" name="SortBy" id="ByTicket" value="Ticket">
+ <label for="ByTicket"><&|/l&>By Ticket</&></label>
+
+ <input <% $SortBy eq 'Queue' ? 'checked="checked"' : '' |n%> type="radio" name="SortBy" id="ByQueue" value="Queue">
+ <label for="ByQueue"><&|/l&>By Queue</&></label>
+ </div>
+ <div>
+ <button type="submit">See Time</button>
+ </div>
+ </form>
+</div>
+
+% if ( $data ) {
+<div class="user-time-content">
+% foreach my $delimeter (sort keys %$data) {
+ <h3><% $delimeter %></h3>
+ <table class="ticket-list collection-as-table">
+ <tr class="collection-as-table">
+ <th class="collection-as-table">Id</th>
+ <th class="collection-as-table">Subject</th>
+ <th class="collection-as-table">Queue</th>
+ <th class="collection-as-table">Status</th>
+ <th class="collection-as-table">Owner</th>
+ <th class="collection-as-table">Time Worked</th>
+ <th class="collection-as-table">Worked By</th>
+ </tr>
+% my $line_type = "oddline";
+% my ($total_time_mins, $total_time_hours);
+% foreach my $time (@{$data->{$delimeter} }) {
+ <tr class="<% $line_type %>">
+ <td class="collection-as-table"><% $time->{Id} %></td>
+ <td class="collection-as-table"><% $time->{Subject} %></td>
+ <td class="collection-as-table"><% $time->{Queue} %></td>
+ <td class="collection-as-table"><% $time->{Status} %></td>
+ <td class="collection-as-table"><% $time->{Owner} %></td>
+ <td class="collection-as-table"><% $time->{Time} %></td>
+ <td class="collection-as-table"><% $time->{Worker} %></td>
+ </tr>
+% $line_type = $line_type eq "oddline" ? "evenline" : "oddline";
+% $total_time_mins += $time->{TimeMin};
+% $total_time_hours += $time->{TimeHours};
+% }
+ </table>
+ <label>Total: <% $total_time_hours %> hours (<% $total_time_mins %> minutes)</label>
+% }
+</div>
+% }
+
+<%INIT>
+my @results;
+
+# if we are just getting here and the form values are empty, we are done
+if ( $startdate && $enddate ) {
+
+ #### DATES ####
+ my $start_date = RT::Date->new( $session{'CurrentUser'} );
+ my $end_date = RT::Date->new( $session{'CurrentUser'} );
+
+ # If we have a value for start date, parse it into an RT::Date object
+ if ($startdate) {
+ $start_date->Set( Format => 'unknown', Value => $startdate );
+
+ # And then get it back as an ISO string for display purposes, in the form field and
+ # report header
+ $startdate = $start_date->AsString( Format => 'ISO', Timezone => 'UTC' );
+ }
+
+ # Same treatment for end date
+ if ($enddate) {
+ $end_date->Set( Format => 'unknown', Value => $enddate );
+ $enddate = $end_date->AsString( Format => 'ISO', Timezone => 'UTC' );
+ }
+
+ # Get a new transactions object to hold transaction search results for this ticket
+ my $trans = RT::Transactions->new( $session{'CurrentUser'} );
+
+ my $txns = RT::Transactions->new($session{CurrentUser});
+ $txns->Limit( FIELD => 'ObjectType', VALUE => 'RT::Ticket' );
+ if ( $user_req ) {
+ my $user = RT::User->new( $session{'CurrentUser'} );
+ my ($ret, $msg) = $user->Load( $user_req );
+ if ( $ret && $user->Id ) {
+ $txns->Limit( FIELD => 'Creator', VALUE => $user->id )
+ }
+ else {
+ push @results, "Could not load user, report not limited to user: $user_req";
+ }
+ }
+ $txns->Limit( FIELD => 'TimeTaken', VALUE => 0, OPERATOR => '!=' );
+ $txns->Limit( FIELD => 'Created', VALUE => $start_date->ISO(Timezone => 'user'), OPERATOR => '>=' );
+ $txns->Limit( FIELD => 'Created', VALUE => $end_date->ISO(Timezone => 'user'), OPERATOR => '<=', ENTRYAGGREGATOR => 'AND');
+
+ my $total_time_worked = 0;
+
+ my $see_group = 1;
+ $see_group = 0 unless $session{'CurrentUser'}->HasRight( Right => 'SeeGroup', Object => $RT::System );
+
+
+ while ( my $txn = $txns->Next ) {
+ my $ticket = $txn->TicketObj;
+
+ my $worker = RT::User->new($session{'CurrentUser'});
+ my ($ret, $msg) = $worker->Load( $txn->Creator );
+ push @results, $msg unless $ret;
+
+ if ( !$see_group ) {
+ next unless $worker->Name eq $session{'CurrentUser'}->Name;
+ }
+
+ if ( $queue_limit && $ticket->QueueObj ) {
+ $queue_limit = [$queue_limit] unless ref $queue_limit eq 'ARRAY';
+ next unless grep $_ eq $ticket->QueueObj->id, @{$queue_limit};
+ }
+
+ $total_time_worked = $total_time_worked + $txn->TimeTaken;
+
+ my $day_worked = $txn->CreatedObj->RFC2822( Time => 0, Timezone => 'user' );
+ my $time_hours = $txn->TimeTaken / 60;
+ $time_hours = int($time_hours * 10**2) / 10**2;
+
+ my $delimeter;
+ if ( $SortBy eq 'User' ) {
+ $delimeter = 'User: ' . $worker->Name;
+ } elsif ( $SortBy eq 'Ticket' ) {
+ $delimeter = $ticket->Id . ': ' . $ticket->Subject;
+ } elsif ( $SortBy eq 'Queue' ) {
+ $delimeter = 'Queue: ' . $ticket->QueueObj->Name;
+ } else {
+ $delimeter = $day_worked;
+ }
+
+ push @{$data->{$delimeter}}, {DayWorked => $day_worked, Id => $ticket->Id, Subject => $ticket->Subject, Queue => $ticket->QueueObj->Name,
+ Status => $ticket->Status, Owner => $ticket->OwnerObj->Name, Time => $time_hours > 1 ? $time_hours . ' hours (' . $txn->TimeTaken . ' minutes)' : $txn->TimeTaken . ' minutes',
+ TimeMin => $txn->TimeTaken, TimeHours => $time_hours, Worker => $worker->Name};
+ }
+}
+</%INIT>
+
+<%ARGS>
+$startdate => undef
+$enddate => undef
+$queues => undef
+$user_req => undef
+$SortBy => 'date'
+$data => undef
+$queue_limit => undef
+</%ARGS>
commit 621cf9d4bccdd4fa815c8758f3f8fbf7b329bc63
Author: Craig Kaiser <craig at bestpractical.com>
Date: Fri Jul 27 12:19:33 2018 -0400
Add docs for User Time Worked Report
diff --git a/docs/images/user-time-worked-report.png b/docs/images/user-time-worked-report.png
new file mode 100644
index 0000000000..208f225bfc
Binary files /dev/null and b/docs/images/user-time-worked-report.png differ
diff --git a/docs/reporting/user_time_worked.pod b/docs/reporting/user_time_worked.pod
new file mode 100644
index 0000000000..1c41723ac2
--- /dev/null
+++ b/docs/reporting/user_time_worked.pod
@@ -0,0 +1,17 @@
+=head1 Introduction
+
+The User Time Worked report allows for users to see time worked on tickets
+for an open ended date range. Users can limit the data returned by either
+User or Queue value. The data by default is organized by the date that the
+time was worked, but can also be sorted by User, Queue or Ticket.
+
+=cut
+
+=head2 Example
+
+=cut
+
+=for html <img alt="Example User Time Worked Report"
+src="images/user-time-worked-report.png">
+
+=cut
-----------------------------------------------------------------------
More information about the rt-commit
mailing list