Skip to content

Commit

Permalink
Fixes #409 - Cleanup of overview section
Browse files Browse the repository at this point in the history
  • Loading branch information
@ralf401
ralf401 authored Dec 5, 2023
1 parent d0d74ba commit 7f397a7
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 104 deletions.
Binary file removed images/manage/overviews/restrict-overview-to-sharing-organizations.png
View file
Binary file not shown.
100 changes: 40 additions & 60 deletions locale/admin-docs.pot
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Zammad Admin Documentation pre-release\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-12-01 10:26+0000\n"
"POT-Creation-Date: 2023-12-05 14:37+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand Down Expand Up @@ -6124,90 +6124,70 @@ msgid "Overviews"
msgstr ""

#: ../manage/overviews.rst:4
msgid "You can provide overviews to your agents and customers. They can be used as a kind of worklist of tasks that the agent is supposed to work off. You can also create individual overviews for individual agents or agent groups."
msgstr ""

#: ../manage/overviews.rst:8
msgid "In the overview management area you can add new overviews, edit or delete them."
msgid "You can provide overviews to your agents and customers. They can be used as a kind of worklist of tasks that the agent is supposed to work on. You can add new overviews, edit or delete them. They can be used for individual agents or agent groups. Overviews only show tickets for which the user has permissions (group or role based)."
msgstr ""

#: ../manage/overviews.rst:12
msgid "Please note that overviews can cause performance issues leading to no longer or less often refreshing overviews!"
msgstr ""

#: ../manage/overviews.rst:15
msgid "Whenever possible, try to use the same overviews for as many agents and groups as possible to keep the number of overviews low. For best results, you might want to use between 15-20 overviews maximum. Also, any overview will only show a total of 2100 elements."
msgstr ""

#: ../manage/overviews.rst:22
msgid "Overviews will only show tickets to your users, that the user have rights on (group or role based)."
msgid "Whenever possible, try to use the same overviews for as many agents and groups as possible to keep the number of overviews low. For best results, you should use a maximum of 15-20 overviews. Please note that any overview will only show a maximum of 2100 elements."
msgstr ""

#: ../manage/overviews.rst:25
msgid "The following attributes can be set when creating an overview:"
msgstr ""

#: ../manage/overviews.rst:31
msgid "Available for the following roles / Restrict to only the following users"
#: ../manage/overviews.rst:20
msgid "The following attributes can be set when creating or editing overviews. Have a look under the screenshot where you can find an explanation for each field."
msgstr ""

#: ../manage/overviews.rst:35
msgid "Roles are assigned to users, per default there are agents, admins and customers. Further information about :doc:`roles/index`."
msgstr ""

#: ../manage/overviews.rst:38
msgid "The setting \"available for the following roles\" is mandatory."
msgid "Available for the following roles / Restrict to only the following users"
msgstr ""

#: ../manage/overviews.rst:40
msgid "Define roles that are supposed to see and use the overview in question."
#: ../manage/overviews.rst:28
msgid "Define :doc:`roles <roles/index>` that are supposed to see and use the overview in question."
msgstr ""

#: ../manage/overviews.rst:42
#: ../manage/overviews.rst:31
msgid "If your overview is rather specific for a sub group of users of your role, use the *\"Restrict to only the following users\"* option to further restrict the visibility of the overview to defined users."
msgstr ""

#: ../manage/overviews.rst:48
msgid "You will still have to provide a role!"
#: ../manage/overviews.rst:35
msgid "The setting \"available for the following roles\" is mandatory."
msgstr ""

#: ../manage/overviews.rst:50
#: ../manage/overviews.rst:47
msgid "Only available for users with shared organization"
msgstr ""

#: ../manage/overviews.rst:56
msgid "Shared organization is a setting in the organization management. See :doc:`/manage/organizations/index` for more information."
#: ../manage/overviews.rst:38
msgid "This is important if the available role is a customer. Whether you select \"Yes\" or \"No\" depends on whether you want one of your customer's contacts to see all of their organization's tickets."
msgstr ""

#: ../manage/overviews.rst:59
msgid "This is only important if the available role is a customer. Whether you select Yes or No depends on whether you want one of your customer's contacts to see all of their organization's tickets."
#: ../manage/overviews.rst:44
msgid "Shared organization is a setting in the organization management. See :doc:`/manage/organizations/index` for more information."
msgstr ""

#: ../manage/overviews.rst:63
msgid "Users also refers to the customer role in this case."
#: ../manage/overviews.rst:47
msgid "\"Users\" also refers to the customer role in this case."
msgstr ""

#: ../manage/overviews.rst:65
msgid "Only available for users which are absence replacements for other users."
#: ../manage/overviews.rst:61
msgid "Only available for users which are absence replacements for other users"
msgstr ""

#: ../manage/overviews.rst:67
msgid "This selection refers to the setting in the user preferences (profile-picture / initials of agent in the left corner > profile > out of office). If this option is checked, this selection is only displayed if someone has been entered as a substitution."
#: ../manage/overviews.rst:50
msgid "This selection refers to the setting in the user preferences (profile-picture / initials of agent in the left corner > profile > out of office). If this option is checked, this overview is only displayed for users who have been set as a substitution. See \"Out of office function\" in the :user-docs:`user documentation </extras/profile-and-settings.html>` for more details."
msgstr ""

#: ../manage/overviews.rst:73
#: ../manage/overviews.rst:58
msgid "**For example:** Agent A is on vacation and Agent B will take care of his tickets. Then an overview can be set up, which only shows Agent B all new tickets from Agent A for this period of time, without having to search for them separately."
msgstr ""

#: ../manage/overviews.rst:80
msgid "Replacement users are part of our :user-docs:`Out of Office function </extras/profile-and-settings.html>`."
msgstr ""

#: ../manage/overviews.rst:91
#: ../manage/overviews.rst:71
msgid "Conditions for shown tickets"
msgstr ""

#: ../manage/overviews.rst:86
#: ../manage/overviews.rst:66
msgid "Which tickets should be shown in this overview? The conditions can be seen like a filter. You can add more than one condition. In the preview you have the possibility to double check if your entry of the conditions makes sense by directly displaying tickets that match your filtering."
msgstr ""

Expand Down Expand Up @@ -6244,72 +6224,72 @@ msgstr ""
msgid "Have a look at :doc:`/misc/object-conditions/index` to learn even more! 🎉"
msgstr ""

#: ../manage/overviews.rst:111
#: ../manage/overviews.rst:91
#: ../system/core-workflows/learn-by-example.rst:24
msgid "Attributes"
msgstr ""

#: ../manage/overviews.rst:96
#: ../manage/overviews.rst:76
msgid "Which attributes (column headers) shall be shown in the overview?"
msgstr ""

#: ../manage/overviews.rst:98
#: ../manage/overviews.rst:78
msgid "With this setting you can select the headlines of your overview. Depending on which information is important in this selection, it can be displayed individually. For this example \"Unassigned and open\", the overview would look like this:"
msgstr ""

#: ../manage/overviews.rst:105
#: ../manage/overviews.rst:85
msgid "These settings can also be adjusted individually by admins at a later time (in the overview, top right: Options)."
msgstr ""

#: ../manage/overviews.rst:110
#: ../manage/overviews.rst:90
msgid "Please note that overview column and sort settings are global settings which affect all users seeing those overviews."
msgstr ""

#: ../manage/overviews.rst:138
#: ../manage/overviews.rst:119
msgid "Sorting, Grouping and Active"
msgstr ""

#: ../manage/overviews.rst:0
msgid "Sorting by"
msgstr ""

#: ../manage/overviews.rst:117
msgid "In which order should the tickets be displayed? (Sorted by the attributes)"
#: ../manage/overviews.rst:97
msgid "In which order should the tickets be displayed? Choose the attribute you want to sort by."
msgstr ""

#: ../manage/overviews.rst:0
msgid "Sorting order"
msgstr ""

#: ../manage/overviews.rst:120
msgid "The direction of the sorting."
#: ../manage/overviews.rst:101
msgid "The direction of the sorting (ascending or descending)."
msgstr ""

#: ../manage/overviews.rst:0
msgid "Grouping by"
msgstr ""

#: ../manage/overviews.rst:123
#: ../manage/overviews.rst:104
msgid "Should the tickets be grouped by a specific attribute within the list?"
msgstr ""

#: ../manage/overviews.rst:0
msgid "Grouping order"
msgstr ""

#: ../manage/overviews.rst:126
#: ../manage/overviews.rst:107
msgid "The direction of the grouping."
msgstr ""

#: ../manage/overviews.rst:129
#: ../manage/overviews.rst:110
msgid "Should the overview be active or not? Rather than deleting an overview entirely, you can set it to inactive to make it unavailable to your users."
msgstr ""

#: ../manage/overviews.rst:135
#: ../manage/overviews.rst:116
msgid "Users can define their own overview order. Renaming or reordering overviews has no effect on custom orders!"
msgstr ""

#: ../manage/overviews.rst:138
#: ../manage/overviews.rst:119
msgid "You can learn more about this setting :user-docs:`in the user documentation </extras/profile-and-settings.html#user-profile-settings>`."
msgstr ""

Expand Down
69 changes: 25 additions & 44 deletions manage/overviews.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ Overviews
*********

You can provide overviews to your agents and customers. They can be used as a
kind of worklist of tasks that the agent is supposed to work off.
You can also create individual overviews for individual agents or agent groups.

In the overview management area you can add new overviews, edit or delete them.
kind of worklist of tasks that the agent is supposed to work on.
You can add new overviews, edit or delete them. They can be used for individual
agents or agent groups. Overviews only show tickets for which the user has
permissions (group or role based).

.. warning::

Expand All @@ -14,72 +14,52 @@ In the overview management area you can add new overviews, edit or delete them.

Whenever possible, try to use the same overviews for as many agents and
groups as possible to keep the number of overviews
low. For best results, you might want to use between 15-20 overviews maximum.
Also, any overview will only show a total of 2100 elements.

.. note::

Overviews will only show tickets to your users, that the user have rights on
(group or role based).
low. For best results, you should use a maximum of 15-20 overviews.
Please note that any overview will only show a maximum of 2100 elements.

The following attributes can be set when creating an overview:
The following attributes can be set when creating or editing overviews. Have a
look under the screenshot where you can find an explanation for each field.

.. figure:: /images/manage/overviews/restriction-and-availability-of-overviews-for-roles-and-users.png
:width: 80%
:align: center

Available for the following roles / Restrict to only the following users

.. hint::

Roles are assigned to users, per default there are agents, admins and
customers. Further information about :doc:`roles/index`.

.. note:: The setting "available for the following roles" is mandatory.

Define roles that are supposed to see and use the overview in question.
Define :doc:`roles <roles/index>` that are supposed to see and use the
overview in question.

If your overview is rather specific for a sub group of users of your role,
use the *"Restrict to only the following users"* option to further restrict
the visibility of the overview to defined users.

.. hint::

You will still have to provide a role!
The setting "available for the following roles" is mandatory.

Only available for users with shared organization

.. image:: /images/manage/overviews/restrict-overview-to-sharing-organizations.png
This is important if the available role is a customer.
Whether you select "Yes" or "No" depends on whether you want one of your
customer's contacts to see all of their organization's tickets.

.. hint::

Shared organization is a setting in the organization management.
See :doc:`/manage/organizations/index` for more information.

This is only important if the available role is a customer.
Whether you select Yes or No depends on whether you want one of your
customer's contacts to see all of their organization's tickets.

.. note:: Users also refers to the customer role in this case.

Only available for users which are absence replacements for other users.
"Users" also refers to the customer role in this case.

Only available for users which are absence replacements for other users
This selection refers to the setting in the user preferences
(profile-picture / initials of agent in the left corner >
profile > out of office).
If this option is checked, this selection is only displayed if someone
has been entered as a substitution.
(profile-picture / initials of agent in the left corner > profile > out of
office). If this option is checked, this overview is only
displayed for users who have been set as a substitution. See
"Out of office function" in the
:user-docs:`user documentation </extras/profile-and-settings.html>` for
more details.

**For example:** Agent A is on vacation and Agent B will take care of his
tickets. Then an overview can be set up, which only shows Agent B all
new tickets from Agent A for this period of time, without having to search
for them separately.

.. note::

Replacement users are part of our
:user-docs:`Out of Office function </extras/profile-and-settings.html>`.

Conditions for shown tickets
.. figure:: /images/manage/overviews/overview-conditions-for-to-be-shown-tickets.png

Expand Down Expand Up @@ -114,10 +94,11 @@ Sorting, Grouping and Active
.. figure:: /images/manage/overviews/ordering-and-grouping-of-overviews.png

:Sorting by:
In which order should the tickets be displayed? (Sorted by the attributes)
In which order should the tickets be displayed? Choose the attribute
you want to sort by.

:Sorting order:
The direction of the sorting.
The direction of the sorting (ascending or descending).

:Grouping by:
Should the tickets be grouped by a specific attribute within the list?
Expand Down

0 comments on commit 7f397a7

Please sign in to comment.