Commit 1d54b51c authored by Etienne Allovon's avatar Etienne Allovon

Enhance sheet configuration section

parent ae5a1869
......@@ -4,10 +4,16 @@
Web / Desktop Application
*************************
.. contents::
Common features
===============
.. _webassistant_disable_webrtc:
Disabling WebRTC
================
----------------
WebRTC can be disabled globally by setting the ``DISABLE_WEBRTC`` environment varibale to ``true`` in :file:`/etc/docker/compose/custom.env` file.
......@@ -15,11 +21,11 @@ WebRTC can be disabled globally by setting the ``DISABLE_WEBRTC`` environment va
.. _screen_popup:
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:
......@@ -46,7 +52,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
......@@ -56,64 +62,62 @@ Example : Using the caller number to open a customer info web page
.. figure:: example_xivo_sheet.png
:scale: 90%
.. note::
.. _screen_popup_ucassistant:
Screen popup on UC Assistant
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
By default the sheet:
* The default behaviour for the client sheet is to automatically open on CCagent and to not open on the UCassistant.
You can manage it to obtain behaviours that are different from the default ones.
* 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:
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.
* ``popupUCActivated``:
* :menuselection:`Services > IPBX > IPBX Configuration > configuration files > xivo-extrafeatures.conf`: In the file content box, add a variable::
* 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
[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``:
* ``popupAgentActivated`` (OPTIONAL)
* field type = ``text``
* display value = ``{dp-popupagent}``
* 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
* ``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.
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`:
.. warning:: The variable can be added in a subroutine on users or/and on queues, it cannot be added in a subroutine on agents.
* Tab *Sheet* add the following definition:
* ``popupAgentActivated``
* field type = ``text``
* display value = ``false``
* ``popupUCActivated``
* field type = ``text``
* display value = ``true``
Example :
.. 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>`.
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.
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:: 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>`
.. 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).
* :menuselection:`Services > CTI Server > Sheets > Models`:
* 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:
......@@ -134,7 +138,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:
......
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