[Rt-commit] rt branch, 5.0/configurable-linked-queue-portlets, updated. rt-5.0.0alpha1-34-g35790bc70e

Jim Brandt jbrandt at bestpractical.com
Thu Apr 2 14:23:23 EDT 2020


The branch, 5.0/configurable-linked-queue-portlets has been updated
       via  35790bc70eba9bb245dd01e0c497df017b283b1e (commit)
      from  ca34f59426a01f69e11485f048419e09b890b202 (commit)

Summary of changes:
 etc/RT_Config.pm.in | 49 +++++++++++++++++++++++++++++--------------------
 1 file changed, 29 insertions(+), 20 deletions(-)

- Log -----------------------------------------------------------------
commit 35790bc70eba9bb245dd01e0c497df017b283b1e
Author: Jim Brandt <jbrandt at bestpractical.com>
Date:   Thu Apr 2 14:23:04 2020 -0400

    Update queue portlets documentation

diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index 41d461fb58..96de9773cf 100644
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -2644,24 +2644,34 @@ 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'
+C<%LinkedQueuePortlets> allows you to display links to tickets in
+another queue in a stand-alone portlet on the ticket display page.
+This makes it easier to highlight specific ticket links separate from
+the standard Links portlet.
+
+For example, you might have a Sales queue that tracks incoming product
+requests, and for each ticket you create a linked ticket in the Shipping
+queue for each outgoing shipment. You could add the configuration below
+to create a stand-alone Shipping portlet on tickets in the Sales queue,
+making it easier to see those linked tickets. You might have a Returns
+queue to show as well.
+
+    Set( %LinkedQueuePortlets, (
+        'Sales' => [
+            { 'Shipping'   => [ 'All' ] },
+            { 'Returns'   => [ 'RefersTo' ] },
+        ],
+        'Shipping'   => [
+            { 'Postage' => [ 'DependsOn', 'HasMember' ] },
+        ],
+    ));
+
+You can include multiple linked queues in each ticket and they are
+displayed in the order you define them in the configuration. The values
+are RT link types: 'DependsOn', 'DependedOnBy', 'HasMember'
 (children), 'MemberOf' (parents), 'RefersTo', and 'ReferredToBy'.
-Additionally, the type, 'All', which lists all linked tickets by queue,
-is accepted. In the example below, portlets will be added to all tickets
-in both the General queue and the Support queue:
-
-Set( %LinkedQueuePortlets, (
-    General     => [
-        { General   => [ 'All' ] },
-        { Testing   => [ 'HasMember', 'MemberOf', 'RefersTo' ] },
-    ],
-    Support   => [
-        { General => [ 'All' ] },
-    ],
-));
+'All' lists all linked tickets. You can include multiple link types for
+each as shown above.
 
 =cut
 
@@ -2669,9 +2679,8 @@ Set( %LinkedQueuePortlets, () );
 
 =item C<$LinkedQueuePortletFormat>
 
-$LinkedQueuePortletFormat is the default format for displaying the
-list of tickets in each linked queue portlet ( %LinkedQueuePortlets
-must be enabled ).
+C<$LinkedQueuePortletFormat> defines the format for displaying
+linked tickets in each linked queue portlet defined by C<%LinkedQueuePortlets>.
 
 =cut
 

-----------------------------------------------------------------------


More information about the rt-commit mailing list