diff --git a/extras/reporting.rst b/extras/reporting.rst new file mode 100644 index 00000000..5a2544a5 --- /dev/null +++ b/extras/reporting.rst @@ -0,0 +1,39 @@ +Reporting +========= + +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: + +.. figure:: /images/extras/reporting/menu-bar-reporting.png + :alt: Menu bar with highlighted reporting + +If you can't see the reporting button, you have no permission for it. + +The reporting screen consists of various sections: + +.. figure:: /images/extras/reporting/reporting-sections.png + :alt: Screenshot showing different sections in the reporting screen + :scale: 80% + +1. **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. +2. **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. +3. **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"). +4. **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. + + .. note:: The ticket preview and download button are only displayed if you + selected a filter based on "Ticket Count" (see 1). + + Due to technical reasons, the download is limited to 6.000 entries. + +.. https://github.com/zammad/zammad/issues/2433 \ No newline at end of file diff --git a/images/extras/reporting/menu-bar-reporting.png b/images/extras/reporting/menu-bar-reporting.png new file mode 100644 index 00000000..c2c559fe Binary files /dev/null and b/images/extras/reporting/menu-bar-reporting.png differ diff --git a/images/extras/reporting/reporting-sections.png b/images/extras/reporting/reporting-sections.png new file mode 100644 index 00000000..104acc72 Binary files /dev/null and b/images/extras/reporting/reporting-sections.png differ diff --git a/index.rst b/index.rst index 809e77d0..09337e26 100644 --- a/index.rst +++ b/index.rst @@ -51,6 +51,7 @@ Zammad User Documentation /extras/mobile-view /extras/organizations /extras/profile-and-settings + /extras/reporting /extras/secure-email /extras/shared-drafts /extras/two-factor-authentication diff --git a/locale/user-docs.pot b/locale/user-docs.pot index a9cc8bed..d5761b36 100644 --- a/locale/user-docs.pot +++ b/locale/user-docs.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Zammad User Documentation pre-release\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-09-04 10:31+0200\n" +"POT-Creation-Date: 2025-09-09 08:29+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -3262,6 +3262,7 @@ msgstr "" #: ../basics/zammad-glossary.rst:580 #: ../basics/zammad-glossary.rst:621 +#: ../extras/reporting.rst:2 msgid "Reporting" msgstr "" @@ -5276,6 +5277,50 @@ msgstr "" msgid "See a list of third party services (*e.g.,* Facebook or Twitter) linked to your Zammad account." msgstr "" +#: ../extras/reporting.rst:4 +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:" +msgstr "" + +#: ../extras/reporting.rst:None +msgid "Menu bar with highlighted reporting" +msgstr "" + +#: ../extras/reporting.rst:12 +msgid "If you can't see the reporting button, you have no permission for it." +msgstr "" + +#: ../extras/reporting.rst:14 +msgid "The reporting screen consists of various sections:" +msgstr "" + +#: ../extras/reporting.rst:None +msgid "Screenshot showing different sections in the reporting screen" +msgstr "" + +#: ../extras/reporting.rst:20 +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." +msgstr "" + +#: ../extras/reporting.rst:23 +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." +msgstr "" + +#: ../extras/reporting.rst:27 +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\")." +msgstr "" + +#: ../extras/reporting.rst:30 +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." +msgstr "" + +#: ../extras/reporting.rst:34 +msgid "The ticket preview and download button are only displayed if you selected a filter based on \"Ticket Count\" (see 1)." +msgstr "" + +#: ../extras/reporting.rst:37 +msgid "Due to technical reasons, the download is limited to 6.000 entries." +msgstr "" + #: ../extras/secure-email.rst:2 msgid "Secure Email" msgstr ""