Commit 515afc9c authored by Etienne Allovon's avatar Etienne Allovon

Enhance sheet configuration section

parent 698395e2
......@@ -4,32 +4,37 @@
Web / Desktop Application
*************************
.. contents::
Common features
===============
.. _webassistant_disable_webrtc:
Disabling WebRTC
================
----------------
WebRTC can be disabled globally by setting the ``DISABLE_WEBRTC`` environment variable to ``true`` in :file:`/etc/docker/compose/custom.env` file.
WebRTC can be disabled globally by setting the ``DISABLE_WEBRTC`` environment varibale to ``true`` in :file:`/etc/docker/compose/custom.env` file.
.. _webassistant_history_nbdays:
Call History Number of Days
===========================
---------------------------
Call history by default shows the last 7 days. You can change it by setting the ``CALL_HISTORY_NB_OF_DAYS`` environment variable to a specific number of days in the :file:`/etc/docker/compose/custom.env` file.
.. warning:: Note that setting this to a large number of days may slow down the solution.
.. _screen_popup:
ScreenPopup
============
Screen Popup
------------
It is possible to display customer information in an external web application using Xivo :ref:`sheet <custom-call-form>` mecanism.
* :menuselection:`Services > CTI Server > Sheets > Models`:
* Go to :menuselection:`Services > CTI Server > Sheets > Models` to configure a sheet:
* Tab *General Settings*: Give a name
* Tab *Sheet*: You must define a sheet with at least ``folderNumber`` and ``popupUrl`` fields set:
......@@ -56,7 +61,7 @@ It is possible to display customer information in an external web application us
* set to the text ``true`` to open each popup in a new window.
* :menuselection:`Services > CTI Server > Sheets > Events`: Choose the right events for opening the URL (if you choose two events, url will opened twice etc.)
* Then go to :menuselection:`Services > CTI Server > Sheets > Events` and choose the right events for opening the URL (if you choose two events, url will opened twice etc.)
Example : Using the caller number to open a customer info web page
......@@ -64,66 +69,64 @@ Example : Using the caller number to open a customer info web page
* Define ``popupUrl`` with a display value of http://mycrm.com/customerInfo?nb={xivo-calleridnum}&fn= when call arrives web page http://mycrm.com/customerInfo?nb=1050&fn=123456 will be displayed
.. figure:: example_xivo_sheet.png
:scale: 90%
.. note::
* The default behaviour for the client sheet is to open automatically on CCagent and to not open on UCAssistant. You can manage it to obtain behaviours that are different from the default ones.
To manage the client sheet on the CCagent and UCassistant, you can configure a variable in the webi and then add it on users or queues via a subroutine.
* :menuselection:`Services > IPBX > IPBX Configuration > configuration files > xivo-extrafeatures.conf`: in the file content box, add a variable::
[add-variable]
exten聽=聽s,1,NoOp(*******************聽Add聽variable聽*******************)
same聽聽=聽聽聽n,UserEvent(dialplan2cti,UNIQUEID:聽${UNIQUEID},CHANNEL:聽${CHANNEL},VARIABLE:聽popupagent,VALUE:聽"false")
same聽聽=聽聽聽n,UserEvent(dialplan2cti,UNIQUEID:聽${UNIQUEID},CHANNEL:聽${CHANNEL},聽VARIABLE:聽popupassistant,VALUE:聽"true")
same聽聽=聽聽聽n,DumpChan()
same聽聽=聽聽聽n(return),Return()聽聽聽聽聽聽
* :menuselection:`Services > CTI Server > Sheets > Models`:
聽聽聽聽
*Tab *Sheet* : You can add the following fields :
* ``popupAgentActivated`` (OPTIONAL)
* Field type =``text``
* Display value = ``{dp-popupagent}``
* ``popupUCActivated`` (OPTIONAL)
* Field type = ``text``
* Display value =``{dp-popupassistant}``
* Add聽the聽variable聽on聽a聽user聽or聽a聽queue聽via聽a聽subroutine聽:聽in聽the聽subroutine聽field聽type聽"add-variable"聽which聽is聽the聽name聽of聽the聽variable聽we聽set聽in聽the聽configuration.
.. warning::
The variable can be added in a subroutine on users and/or queues, it cannot be added in a subroutine on agents.
Example聽:聽
I聽want聽my聽user聽U1聽to聽have聽access聽to聽the聽client聽sheet聽when聽a聽customer聽calls聽on聽the聽UCassistant.
:menuselection:`Services聽>聽IPBX聽>聽User聽>聽Edit聽user`:聽In聽the聽General聽tab,聽write聽"add-variable"聽in聽the聽subroutine聽field.聽
聽聽
The聽popupUCActivated聽field聽is聽set聽to聽"true"聽in聽the聽configuration,聽so聽user聽U1聽will聽receive聽the聽client聽sheet.聽
:scale: 90%
.. _screen_popup_ucassistant:
.. _run_executable_sheet:
Screen popup on UC Assistant
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Run executable
==============
By default the sheet:
It is also possible to run an executable using Xivo :ref:`sheet <custom-call-form>` mecanism. This is only available in the desktop agent and desktop assistant.
* on *CC Agent* application the sheet is opened by default,
* on *UC Assistant* application the sheet is **not** opened by default.
You can change the behavior with the following sheet variables:
* ``popupUCActivated``:
.. warning::
* if set to ``true`` the sheet will be opened on *UC Assistant* application
* if set to ``false`` (default) the sheet won't be opened on *UC Assistant* application
The聽executable聽will聽be聽run聽by聽default聽on聽the聽desktop聽Agent聽but聽not聽on聽the聽desktop聽Assistant.聽
To run an executable on the Desktop Assistant, you need to set the popupassistant variable to true and add it in a subroutine on a user.
For聽more聽details聽about聽the聽configuration,聽see聽:ref:`configuration聽section聽<screen_popup>`
* ``popupAgentActivated``:
* if set to ``true`` (default) the sheet will be opened on *CC Agent* application
* if set to ``false`` the sheet won't be opened on *CC Agent* application
* :menuselection:`Services > CTI Server > Sheets > Models`:
For example, if you want the sheet to **only** open on UC Assistant application you should add in your sheet configuration:
* in :menuselection:`Services > CTI Server > Sheets > Models`:
* Tab *Sheet* add the following definition:
* ``popupAgentActivated``
* field type = ``text``
* display value = ``false``
* ``popupUCActivated``
* field type = ``text``
* display value = ``true``
.. note:: These variables can also be filled via a dialplan variable value with the ``UserEvent`` application and the ``{dp-...}`` syntax mechanism.
See the XiVO PBX :ref:`sheet description <custom-call-form>`.
Desktop Assistant Specific Features
===================================
.. _run_executable_sheet:
Run executable
--------------
It is also possible to run an executable using Xivo :ref:`sheet <custom-call-form>` mecanism. This is only available in the desktop agent and desktop assistant.
.. warning:: For the executable to be run on a Desktop Assistant in **UC mode**, you need to activate the :ref:`screen_popup_ucassistant`
(in **CC Agent mode** the screen popup doesn't need to be activated and therefore the executable will be run out-of-the-box).
* Go to :menuselection:`Services > CTI Server > Sheets > Models`:
* Tab *General Settings*: Give a name
* Tab *Sheet*: You must define a sheet with at least ``runAsExecutable`` and ``popupUrl`` fields set:
......@@ -144,7 +147,7 @@ It is also possible to run an executable using Xivo :ref:`sheet <custom-call-for
* set the argument for the executable.
* :menuselection:`Services > CTI Server > Sheets > Events`: Choose the right events for starting the application.
* Then go to :menuselection:`Services > CTI Server > Sheets > Events` and choose the right events for starting the application.
Example : Run the ``notify-send`` command on linux:
......@@ -154,4 +157,3 @@ Example : Run the ``notify-send`` command on linux:
.. figure:: example_xivo_sheet_exe.png
:scale: 90%
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment