[Rt-commit] rt branch, 4.6/configurable-linked-queue-portlets, created. rt-4.4.3-64-g4293902e3
Maureen Mirville
maureen at bestpractical.com
Fri Nov 2 11:45:31 EDT 2018
The branch, 4.6/configurable-linked-queue-portlets has been created
at 4293902e364448d543678e7da989869457464568 (commit)
- Log -----------------------------------------------------------------
commit 0c9134a7c234cd242d33274e1f55f17a89feebb3
Author: Maureen E. Mirville <maureen at bestpractical.com>
Date: Tue Aug 14 23:02:03 2018 -0400
Add a configurable queue portlet to ticket display page
RTIR Incident page displays links portlets by queue. Isolating
these portlets allows a user to view linked tickets based on the
queue and their relation (supports: Depends on, Depended on by,
Parents, Children, Refers to, Referred to by, All) on any ticket
display page.
diff --git a/share/html/Elements/ShowLinksCollectionList b/share/html/Elements/ShowLinksCollectionList
new file mode 100644
index 000000000..f032f07a9
--- /dev/null
+++ b/share/html/Elements/ShowLinksCollectionList
@@ -0,0 +1,104 @@
+%# 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/CollectionList,
+ %ARGS,
+ Collection => $linked_tickets,
+ DisplayFormat => ($Delete? "__CheckBox__, $Format": $Format),
+ Format => $Format,
+ Rows => $Rows,
+ ShowHeader => $ShowHeader,
+ OrderBy => $OrderBy,
+ ShowNavigation => 0,
+ AllowSorting => $AllowSorting,
+ PassArguments => $PassArguments,
+&>
+% unless( $linked_tickets->Count ) {
+% if ( $NoTicketsCaption ) {
+ <i>(<% $NoTicketsCaption %>)</i>
+% }
+% }
+<br />
+
+% if( $FullList && $Rows > 0 && $linked_tickets->CountAll > $Rows ) {
+<a href="<% $FullList %>"><i><% loc("More... ([_1] total)", $linked_tickets->CountAll) %></i></a><br />
+% }
+
+<%INIT>
+my $linked_tickets = RT::Tickets->new( $session{'CurrentUser'} );
+my $ticket_id = $TicketObj->id;
+
+my $query = "Queue = '" . $QueueName . "' AND ". $ExtraQuery;
+
+if ( grep /All/, @LinkTypes ) {
+ $linked_tickets->FromSQL( "$query AND ( LinkedTo = $ticket_id OR LinkedFrom = $ticket_id )" );
+} else {
+ my @link_relations = map { $_ . " = $ticket_id" } @LinkTypes;
+ my $link_query = join ( ' OR ', @link_relations );
+ $query = $query . ' AND ( ' . $link_query . ' )' if $link_query;
+ $linked_tickets->FromSQL( $query );
+}
+
+$Format = RT->Config->Get( 'LinkedQueuesPortletFormat' );
+
+</%INIT>
+
+<%ARGS>
+$Format => undef
+$OrderBy => 'Due'
+$Rows => 0
+$Delete => 0
+$FullList => undef
+$NoTicketsCaption => undef,
+$ShowHeader => 0
+$AllowSorting => undef
+$PassArguments => undef
+$ExtraQuery
+ at LinkTypes
+$QueueName
+$TicketObj
+</%ARGS>
diff --git a/share/html/Ticket/Elements/ShowLinkedQueues b/share/html/Ticket/Elements/ShowLinkedQueues
new file mode 100644
index 000000000..168262cf1
--- /dev/null
+++ b/share/html/Ticket/Elements/ShowLinkedQueues
@@ -0,0 +1,95 @@
+%# 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 }}}
+<%PERL>
+foreach my $on_queue ( @show_portlet_on_queues ) {
+ if ( $on_queue eq $TicketObj->QueueObj->Name ) {
+ my %queues = %{ $portlet_config{ $on_queue } };
+ foreach my $queue_name ( keys %queues ) {
+ my $queue_obj = RT::Queue->new( $session{ CurrentUser } );
+ my ( $ret, $msg ) = $queue_obj->Load( $queue_name );
+ RT::Logger->error( $msg ) unless $ret;
+ next unless $ret;
+ my @link_types = @{ $queues{ $queue_name } };
+</%PERL>
+
+<&| /Widgets/TitleBox,
+ title => $queue_name,
+&>
+<& /Elements/ShowLinksCollectionList, %ARGS,
+ TicketObj => $TicketObj,
+ LinkTypes => @link_types,
+ QueueName => $queue_name,
+ Rows => $Rows,
+ ExtraQuery => "Status = '__Active__'",
+ NoTicketsCaption => loc('No active [_1] tickets', loc( $queue_name )),
+ FullList => "/Ticket/ModifyLinks.html?id=" . $TicketObj->id . "&Queue=" . $queue_obj->id,
+&>
+<& /Elements/ShowLinksCollectionList,
+ TicketObj => $TicketObj,
+ LinkTypes => @link_types,
+ QueueName => $queue_name,
+ Rows => $Rows,
+ ExtraQuery => "Status = '__Inactive__'",
+ NoTicketsCaption => loc('No inactive [_1] tickets', loc( $queue_name )),
+&>
+</&>
+% }
+% }
+%}
+<%INIT>
+my %portlet_config = RT->Config->Get( 'LinkedQueuePortlets' );
+return unless %portlet_config;
+my @show_portlet_on_queues = sort keys %portlet_config;
+</%INIT>
+
+
+<%ARGS>
+$TicketObj
+$OrderBy => 'Due'
+$Rows => 8
+</%ARGS>
diff --git a/share/html/Ticket/Elements/ShowSummary b/share/html/Ticket/Elements/ShowSummary
index 1233b90b9..9cfd633bf 100644
--- a/share/html/Ticket/Elements/ShowSummary
+++ b/share/html/Ticket/Elements/ShowSummary
@@ -91,6 +91,11 @@
% $m->callback( %ARGS, CallbackName => 'AfterDates' );
% my (@extra);
% push @extra, titleright_raw => '<a href="'. RT->Config->Get('WebPath'). '/Ticket/Graphs/index.html?id='.$Ticket->id.'">'.loc('Graph').'</a>' unless RT->Config->Get('DisableGraphViz');
+
+<& /Ticket/Elements/ShowLinkedQueues,
+ TicketObj => $Ticket,
+&>
+
<& /Ticket/Elements/ShowAssets, Ticket => $Ticket &>
% $m->callback( %ARGS, CallbackName => 'LinksExtra', extra => \@extra );
<&| /Widgets/TitleBox, title => loc('Links'),
commit 4293902e364448d543678e7da989869457464568
Author: Maureen E. Mirville <maureen at bestpractical.com>
Date: Fri Aug 24 14:06:59 2018 -0400
Add docs for the new Linked Queue Portlets configs
diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index f6e7273f0..14c114d0f 100644
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -1681,6 +1681,44 @@ to the Article with that name.
Set($WikiImplicitLinks, 0);
+=item C<%LinkedQueuePortlets>
+
+If %LinkedQueuePortlets is set, new portlets will display on the ticket
+display page of each specified queue. Each portlet lists all the linked
+tickets grouped by queue name, and based on the indicated link type.
+Acceptable link types include, 'DependsOn', 'DependedOnBy', 'HasMember'
+(children), 'MemberOf' (parents), 'RefersTo', and 'ReferredToBy'.
+Additionally, the type, 'All', which lists all linked tickets by queue,
+is accepted. See example below:
+
+Set( %LinkedQueuePortlets, (
+ General => {
+ General => [ 'All' ],
+ TestQueue => [ 'HasMember', 'MemberOf', 'RefersTo' ],
+ },
+ TestQueue => {
+ General => [ 'All' ],
+ },
+));
+
+=cut
+
+Set( %LinkedQueuePortlets, () );
+
+=item C<$LinkedQueuesPortletFormat>
+
+$LinkedQueuesPortletFormat is the default format for displaying the
+list of tickets in each linked queue portlet ( %LinkedQueuePortlets
+must be enabled ).
+
+=cut
+
+Set( $LinkedQueuesPortletFormat,
+ q{'<b><a href="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></b>/TITLE:#',}.
+ q{'<b><a href="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></b>/TITLE:Subject',}.
+ q{Status}
+);
+
=item C<$PreviewScripMessages>
Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
-----------------------------------------------------------------------
More information about the rt-commit
mailing list