Skip to content

Commit 7a39742

Browse files
authored
Fixes #455 - Add reporting to user docs
1 parent d878da2 commit 7a39742

File tree

5 files changed

+86
-1
lines changed

5 files changed

+86
-1
lines changed

extras/reporting.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Reporting
2+
=========
3+
4+
The reporting is useful to view statistics, get an overview of the number of
5+
tickets (e.g. tickets of a specific customer) and to download ticket data from
6+
Zammad. You can find the reporting section in the bottom left corner in Zammad
7+
next to the avatar icon or your initials:
8+
9+
.. figure:: /images/extras/reporting/menu-bar-reporting.png
10+
:alt: Menu bar with highlighted reporting
11+
12+
If you can't see the reporting button, you have no permission for it.
13+
14+
The reporting screen consists of various sections:
15+
16+
.. figure:: /images/extras/reporting/reporting-sections.png
17+
:alt: Screenshot showing different sections in the reporting screen
18+
:scale: 80%
19+
20+
1. **Additional filtering** based on the selected profile (see 2). You can
21+
filter by status ("Ticket Count"), "Creation Channels" and "Communication"
22+
types based on your channels.
23+
2. **Profile switcher**: here you can easily switch between the different
24+
profiles, which were created in the admin panel under "Report Profiles".
25+
The shown tickets and numbers are always limited to the current profile
26+
you have selected here.
27+
3. **Time interval/period switcher** and **graph** area: here you can define
28+
the interval you want to see (e.g. "Month") as well as the time period (e.g.
29+
"Jul").
30+
4. **Preview and download** section: here you can find a preview of tickets and
31+
a download button based on the report profile and your filtering. The
32+
download feature provides the tickets in a ``.xlsx`` spreadsheet.
33+
34+
.. note:: The ticket preview and download button are only displayed if you
35+
selected a filter based on "Ticket Count" (see 1).
36+
37+
Due to technical reasons, the download is limited to 6.000 entries.
38+
39+
.. https://github.com/zammad/zammad/issues/2433
5.55 KB
Loading
102 KB
Loading

index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Zammad User Documentation
5151
/extras/mobile-view
5252
/extras/organizations
5353
/extras/profile-and-settings
54+
/extras/reporting
5455
/extras/secure-email
5556
/extras/shared-drafts
5657
/extras/two-factor-authentication

locale/user-docs.pot

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: Zammad User Documentation pre-release\n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2025-09-04 10:31+0200\n"
11+
"POT-Creation-Date: 2025-09-09 08:29+0200\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language-Team: LANGUAGE <[email protected]>\n"
@@ -3262,6 +3262,7 @@ msgstr ""
32623262

32633263
#: ../basics/zammad-glossary.rst:580
32643264
#: ../basics/zammad-glossary.rst:621
3265+
#: ../extras/reporting.rst:2
32653266
msgid "Reporting"
32663267
msgstr ""
32673268

@@ -5276,6 +5277,50 @@ msgstr ""
52765277
msgid "See a list of third party services (*e.g.,* Facebook or Twitter) linked to your Zammad account."
52775278
msgstr ""
52785279

5280+
#: ../extras/reporting.rst:4
5281+
msgid "The reporting is useful to view statistics, get an overview of the number of tickets (e.g. tickets of a specific customer) and to download ticket data from Zammad. You can find the reporting section in the bottom left corner in Zammad next to the avatar icon or your initials:"
5282+
msgstr ""
5283+
5284+
#: ../extras/reporting.rst:None
5285+
msgid "Menu bar with highlighted reporting"
5286+
msgstr ""
5287+
5288+
#: ../extras/reporting.rst:12
5289+
msgid "If you can't see the reporting button, you have no permission for it."
5290+
msgstr ""
5291+
5292+
#: ../extras/reporting.rst:14
5293+
msgid "The reporting screen consists of various sections:"
5294+
msgstr ""
5295+
5296+
#: ../extras/reporting.rst:None
5297+
msgid "Screenshot showing different sections in the reporting screen"
5298+
msgstr ""
5299+
5300+
#: ../extras/reporting.rst:20
5301+
msgid "**Additional filtering** based on the selected profile (see 2). You can filter by status (\"Ticket Count\"), \"Creation Channels\" and \"Communication\" types based on your channels."
5302+
msgstr ""
5303+
5304+
#: ../extras/reporting.rst:23
5305+
msgid "**Profile switcher**: here you can easily switch between the different profiles, which were created in the admin panel under \"Report Profiles\". The shown tickets and numbers are always limited to the current profile you have selected here."
5306+
msgstr ""
5307+
5308+
#: ../extras/reporting.rst:27
5309+
msgid "**Time interval/period switcher** and **graph** area: here you can define the interval you want to see (e.g. \"Month\") as well as the time period (e.g. \"Jul\")."
5310+
msgstr ""
5311+
5312+
#: ../extras/reporting.rst:30
5313+
msgid "**Preview and download** section: here you can find a preview of tickets and a download button based on the report profile and your filtering. The download feature provides the tickets in a ``.xlsx`` spreadsheet."
5314+
msgstr ""
5315+
5316+
#: ../extras/reporting.rst:34
5317+
msgid "The ticket preview and download button are only displayed if you selected a filter based on \"Ticket Count\" (see 1)."
5318+
msgstr ""
5319+
5320+
#: ../extras/reporting.rst:37
5321+
msgid "Due to technical reasons, the download is limited to 6.000 entries."
5322+
msgstr ""
5323+
52795324
#: ../extras/secure-email.rst:2
52805325
msgid "Secure Email"
52815326
msgstr ""

0 commit comments

Comments
 (0)