rt-extension-queuecategories/README at main · NETWAYS/rt-extension-queuecategories · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
NAME
    RT::Extension::QueueCategories

DESCRIPTION
    Allows you to categorize queues by a specific custom field.

    In addition to the default functionality of custom fields, this
    extension utilizes the values of this custom field to group queues in
    the following areas:

    Queue Selection Dropdowns
        All dropdowns rendered through "/Elements/SelectQueue" show the
        queues grouped by category: ticket creation, ticket modify, bulk
        update, the query builder and the quick ticket creation dropdown.

    Queue List Dashboard Portlets
        All portlets based on "/Elements/QueueSummaryByStatus" and
        "/Elements/QueueSummaryByLifecycle" show a heading row per category:
        QueueList, QueueListAllStatuses, MyAdminQueues and MySupportQueues.

    Queues without a category are listed first, without a group.

RT VERSION
    Works with RT 6. For RT 4.4 use version 2.x of this extension.

INSTALLATION
    "perl Makefile.PL"
    "make"
    "make install"
        May need root permissions

    Edit your /opt/rt6/etc/RT_SiteConfig.pm
        Add this line:

            Plugin('RT::Extension::QueueCategories');

    Clear your mason cache
            rm -rf /opt/rt6/var/mason_data/obj

    Restart your webserver

CONFIGURATION
    In order to enable this extension's functionality it is required to
    create a custom field first. This custom field needs to be of the type
    "Select one value" and have the name "QueueCategory". (Although the name
    is configurable, see below)

    Once the custom field has been created, define the categories you want
    to use as values for the field. Remember to apply the field to those
    queues you want to categorize and to manage authorization before
    continuing.

    Now edit each queue you want to categorize and choose a value for the
    custom field. That's it.

  Order of Categories
    It's possible to adjust the order of categories by defining a sort order
    for each value of the custom field. If no custom sort order is provided,
    categories are sorted alphabetically by default.

  $QueueCategories_CFName
    An alternative custom field name to use.

   Example
    "Set($QueueCategories_CFName, 'Queue Group');"

LIMITATIONS
    If $AutocompleteQueues is enabled, RT replaces the queue dropdowns with
    an autocomplete input. Queue categories are not displayed there.

AUTHOR
    NETWAYS GmbH <support@netways.de>

BUGS
    All bugs should be reported on GitHub
    <https://github.com/NETWAYS/rt-extension-queuecategories>.

LICENSE AND COPYRIGHT
    This software is Copyright (c) 2018 by NETWAYS GmbH

    This is free software, licensed under:

      The GNU General Public License, Version 2, June 1991