[Rt-commit] rt branch, 5.0/document-self-service-dashboards, created. rt-5.0.0-35-g54345edfd2

Dianne Skoll dianne at bestpractical.com
Wed Oct 7 09:52:11 EDT 2020


The branch, 5.0/document-self-service-dashboards has been created
        at  54345edfd2bb8b23653a372058b6fcb3dfd39443 (commit)

- Log -----------------------------------------------------------------
commit 54345edfd2bb8b23653a372058b6fcb3dfd39443
Author: Dianne Skoll <dianne at bestpractical.com>
Date:   Wed Oct 7 09:51:39 2020 -0400

    First draft of self-service dashboard documentation.

diff --git a/docs/self-service-dashboard.pod b/docs/self-service-dashboard.pod
new file mode 100644
index 0000000000..ab0d9f4e24
--- /dev/null
+++ b/docs/self-service-dashboard.pod
@@ -0,0 +1,46 @@
+=head1 The Self-Service Interface
+
+Unprivileged users do not have access to the normal RT interface; instead,
+they are restricted to a subset of the interface under the SelfService
+directory tree.
+
+By default, the self-service interface simply presents a "Tickets"
+menu that allows the user to see his or her open or closed tickets.
+(Additional menus may be enabled by giving unprivileged users
+additional rights.)
+
+It is possible to configure RT to present a self-service-specific dashboard
+to unprivileged users instead of just the default menu interface.
+Setting this up will be described in the rest of this document.
+
+=head2 Configuration Items
+
+The following configuration items control the self-service dashboard interface.
+
+=over 4
+
+=item * L<RT_Config/SelfServiceUseDashboard> enables the self-service
+dashboard iterface if set to 1, or disables it (defaulting to the
+simple menu interface) if set to 0.
+
+=item * L<RT_Config/SelfServicePageComponents> is a list of components
+that are allowed to be placed into the self-service dashboard.
+
+=back
+
+=head2 Creating the Self-Service Dashboard
+
+To create the self-service dashboard, the configuration item
+C<$SelfServiceUseDashboard> must be set to 1.  This enables
+a menu item Admin > Global > Self-Service Home Page.  Select
+this item to edit the self-service dashboard.
+
+The self-service dashboard interface is just like any other
+dashboard editor; see L<dashboards> for more details.
+
+Once you have created the self-service dashboard, self-service users
+will see the components on the dashboard when they log in.  Please note
+that you I<also> need to give self-service users the appropriate
+rights to be able to use the components you place on the self-service
+dashboard; these rights are not automatically granted simply by virtue
+of the components being placed on the dashboard.

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


More information about the rt-commit mailing list