Skip to content

Commit

Permalink
Closes #40 - Rework caller log documentation (#71)
Browse files Browse the repository at this point in the history
* Maintenance: Replace lossy jpeg with current png version

* Closes #40 - Rework caller log documentation page

* Maintenance: Switch "see maybe entries" to clear jump reference

As per Gerrits QA.

* Maintenance: Fix wording

As per Gerrits QA

* Maintenance: Update translation pot
  • Loading branch information
MrGeneration committed Feb 24, 2022
1 parent e24f513 commit 25c22c0
Show file tree
Hide file tree
Showing 5 changed files with 137 additions and 13 deletions.
66 changes: 59 additions & 7 deletions extras/caller-log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

View and manage call logs from the **phone** panel.

.. figure:: /images/extras/phone.jpg
.. figure:: /images/extras/caller-log/call-entries.png
:alt: Sample view of Caller Log
:align: center

Expand All @@ -14,15 +14,67 @@ View and manage call logs from the **phone** panel.
This feature is **optional**;
if you don’t see it in the main menu,
that means your administrator hasn’t enabled it yet.
Administrators can learn more
`here <https://admin-docs.zammad.org/en/latest/system-integrations.html#integrations-for-phone-systems>`_.
Administrators can learn more on our `admin documentation`_.

.. _admin documentation:
https://admin-docs.zammad.org/en/latest/system/integrations.html#integrations-for-phone-systems

.. hint::
🏢 The caller log shows all incoming and outgoing calls **for the entire team**.
🏢 The caller log shows all incoming and outgoing calls
**for the entire instance**. The number of entries shown depends on the
configuration your admin chose.

The caller log offers a lot more than just the last call entries.
If your administrator configured "Phone Extension to Agent Mapping", Zammad
will also help you during answering calls.

New Ticket dialogue
Zammad will open a new ticket dialogue if:

* it's able to either guess a single user (see `maybe entries`_)
* the callers number belongs to a user known to Zammad
* the callers number is yet unknown

If the user is known to Zammad it will automatically set the ticket
customer for you. You can correct this at any time if needed.

User profile
Zammad will open the users profile if your user had a customer ticket that
has been updated within the last 30 days. This also applies for calling
users that Zammad guesses are a specific user
(only if it's one guessed user).

Quick dial
You can click on phone numbers (user profiles and caller log) to dial
the number in question quickly.

.. note::

This requires either a soft phone client or CTI client on your
computer that supports this action.

.. _maybe entries:

.. note:: **😕 What are these "maybe" entries?**

During your day by day communication you may also stumble over new customers.
Usually business users send their phone numbers in their signature.

Zammad collects and aggregates these information and tries to guess the
customer in case it receives a call from an unknown number.

.. figure:: /images/extras/caller-log/maybe-entries.png
:alt: Screenshot showing a caller log entry that's classified with "maybe:"

.. tip::

👤 Click on unrecognized numbers in the caller log to **create a new
customer and ticket**. (Unrecognized phone numbers cannot be added to
existing customers in this way.)
👤 Click on unrecognized numbers to **create a new customer** or maybe
entries to **update an existing customer**.

(Unrecognized phone numbers cannot be added to existing customers in
this way. Copy and pasting is required.)

.. note::

Existing caller log entries *are not* updated.

Binary file added images/extras/caller-log/call-entries.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/caller-log/maybe-entries.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/extras/phone.jpg
Binary file not shown.
84 changes: 78 additions & 6 deletions locale/user-docs.pot
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Zammad (for Agents) \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2022-01-13 23:13+0100\n"
"POT-Creation-Date: 2022-02-24 15:03+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
Expand Down Expand Up @@ -2734,15 +2734,87 @@ msgid "**🤔 Huh? I don’t see “Phone” in the menu...**"
msgstr ""

#: ../extras/caller-log.rst:14
msgid "This feature is **optional**; if you don’t see it in the main menu, that means your administrator hasn’t enabled it yet. Administrators can learn more `here <https://admin-docs.zammad.org/en/latest/system-integrations.html#integrations-for-phone-systems>`_."
msgid "This feature is **optional**; if you don’t see it in the main menu, that means your administrator hasn’t enabled it yet. Administrators can learn more on our `admin documentation`_."
msgstr ""

#: ../extras/caller-log.rst:21
msgid "🏢 The caller log shows all incoming and outgoing calls **for the entire team**."
#: ../extras/caller-log.rst:23
msgid "🏢 The caller log shows all incoming and outgoing calls **for the entire instance**. The number of entries shown depends on the configuration your admin chose."
msgstr ""

#: ../extras/caller-log.rst:25
msgid "👤 Click on unrecognized numbers in the caller log to **create a new customer and ticket**. (Unrecognized phone numbers cannot be added to existing customers in this way.)"
#: ../extras/caller-log.rst:27
msgid "The caller log offers a lot more than just the last call entries. If your administrator configured \"Phone Extension to Agent Mapping\", Zammad will also help you during answering calls."
msgstr ""

#: ../extras/caller-log.rst:39
msgid "New Ticket dialogue"
msgstr ""

#: ../extras/caller-log.rst:32
msgid "Zammad will open a new ticket dialogue if:"
msgstr ""

#: ../extras/caller-log.rst:34
msgid "it's able to either guess a single user (see `maybe entries`_)"
msgstr ""

#: ../extras/caller-log.rst:35
msgid "the callers number belongs to a user known to Zammad"
msgstr ""

#: ../extras/caller-log.rst:36
msgid "the callers number is yet unknown"
msgstr ""

#: ../extras/caller-log.rst:38
msgid "If the user is known to Zammad it will automatically set the ticket customer for you. You can correct this at any time if needed."
msgstr ""

#: ../extras/caller-log.rst:45
msgid "User profile"
msgstr ""

#: ../extras/caller-log.rst:42
msgid "Zammad will open the users profile if your user had a customer ticket that has been updated within the last 30 days. This also applies for calling users that Zammad guesses are a specific user (only if it's one guessed user)."
msgstr ""

#: ../extras/caller-log.rst:54
msgid "Quick dial"
msgstr ""

#: ../extras/caller-log.rst:48
msgid "You can click on phone numbers (user profiles and caller log) to dial the number in question quickly."
msgstr ""

#: ../extras/caller-log.rst:53
msgid "This requires either a soft phone client or CTI client on your computer that supports this action."
msgstr ""

#: ../extras/caller-log.rst:58
msgid "**😕 What are these \"maybe\" entries?**"
msgstr ""

#: ../extras/caller-log.rst:60
msgid "During your day by day communication you may also stumble over new customers. Usually business users send their phone numbers in their signature."
msgstr ""

#: ../extras/caller-log.rst:63
msgid "Zammad collects and aggregates these information and tries to guess the customer in case it receives a call from an unknown number."
msgstr ""

#: ../extras/caller-log.rst:0
msgid "Screenshot showing a caller log entry that's classified with \"maybe:\""
msgstr ""

#: ../extras/caller-log.rst:71
msgid "👤 Click on unrecognized numbers to **create a new customer** or maybe entries to **update an existing customer**."
msgstr ""

#: ../extras/caller-log.rst:74
msgid "(Unrecognized phone numbers cannot be added to existing customers in this way. Copy and pasting is required.)"
msgstr ""

#: ../extras/caller-log.rst:79
msgid "Existing caller log entries *are not* updated."
msgstr ""

#: ../extras/chat.rst:2
Expand Down

0 comments on commit 25c22c0

Please sign in to comment.