integration.rst 4.22 KB
Newer Older
1 2 3 4 5 6 7 8 9
.. _xivo-dird-integration:

**********************************************
Integration of XiVO dird with the rest of XiVO
**********************************************

Configuration values
====================

10 11
.. _dird-integration-views:

12 13 14
Views
-----

15
In the directory displays (also in the :ref:`main configuration file <dird-configuration-file>` of xivo-dird, in the ``views`` section), the
16 17 18 19 20 21
following keys are interpreted and displayed in xlet people of the XiVO Client:

``title``
   The ``title`` will be shown as a header for the column

``type``
Sebastien Duthil's avatar
Sebastien Duthil committed
22 23 24
   * ``agent``: the field value will be ignored and replaced by an icon showing the status of the
     agent assigned to the contact (e.g. green icon for logged agent, red icon for unlogged agent,
     ...)
25 26 27
   * ``callable``: a dropdown action on the ``number`` field will be added to call the field value.
   * ``email``: a dropdown action on the ``number`` field will be added to send an email to the
     field value.
28
   * ``favorite``: the boolean field value will be replaced by an icon showing if the status is
29
     favorite (yellow star filled) or not (yellow star empty).
30 31
   * ``name``: a decoration will be added to the field value (typically a color dot) showing the
     presence status of the contact (e.g. Disconnected, Available, Away, ...)
32
   * ``number``: only one number type can be defined per profile. The field value will be:
33 34 35 36

      * added a decoration (typically a color dot) showing the status of the phone of the contact
        (e.g. Offline, Ringing, Talking, ...)
      * replaced with a button to call the contact with your phone when using the mouse
37

38
   * ``personal``: the boolean field value will be used to show a deletion action for the contact
39
   * ``voicemail``: the voicemail number of the contact
40

41 42
See :ref:`15_19_people_xlet_upgrade_notes` for an example with screenshots.

43

44
.. _personal-contact-attributes:
45

46 47
Personal contacts
-----------------
48

49
Here are the list of available attributes of a personal contact:
50 51 52 53 54 55 56 57 58

* ``id``
* ``company``
* ``email``
* ``fax``
* ``firstname``
* ``lastname``
* ``mobile``
* ``number``
59 60


61 62 63 64 65 66 67 68 69 70 71
To be able to edit and delete personal contacts, you need a column of type `personal` in your display.

Adding the `personal` column to your display
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In the web interface under :menuselection:`Services --> CTI Server --> Directories --> Display filters`.

#. Edit the filter on which you which to enable favorites.
#. Add a column with the type `personal` and display format `personal`.


72
.. _dird-favorites-configuration:
73

74 75 76 77 78
Favorites
---------

Enabling favorites in the XiVO client.

Sebastien Duthil's avatar
Sebastien Duthil committed
79
* Add a `unique_column` to your sources.
80 81 82
* Add a `favorite` column to your display


Sebastien Duthil's avatar
Sebastien Duthil committed
83
Adding a `unique_column` to your sources
Gregory Eric Sanderson's avatar
Gregory Eric Sanderson committed
84
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
85

sduthil's avatar
sduthil committed
86 87 88
The web interface does not allow the administrator to specify the `unique_column` and
`unique_column_format`. To add these configuration options, add a file to `/etc/xivo-dird/sources.d`
containing *the same name* than the directory definition and all missing fields.
89 90 91

Example:

92 93 94 95
Given an :ref:`dird-backend-ldap` directory source using Active Directory named ``myactivedirectory``:

.. image:: images/active-directory-unique.png

sduthil's avatar
sduthil committed
96 97
Add a file :file:`/etc/xivo-dird/sources.d/myactivedirectory.yml` with the following content to
enable favorites on this source.
98 99 100

.. code-block:: yaml

101
    name: myactivedirectory  # the same name than the directory definition
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
    unique_column: objectGUID
    unique_column_format: binary_uuid


Adding the `favorite` column to your display
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In the web interface under :menuselection:`Services --> CTI Server --> Directories --> Display filters`.

#. Edit the filter on which you which to enable favorites.
#. Add a column with the type `favorite` and display format `favorite`.


Customizing sources
-------------------

sduthil's avatar
sduthil committed
118 119 120
Some configuration options are not available in the web interface. To add configuration to a source
that is configured in the web interface, create a file in `/etc/xivo-dird/sources.d/` with the key
`name` matching your web interface configuration and add all missing fields.
121 122 123 124 125 126 127 128 129

Example:

adding a timeout configuration to a CSV web service source

.. code-block:: yaml

    name: my_csv_web_service
    timeout: 16