Commit d90d1907 authored by Laurent Meiller's avatar Laurent Meiller

Merge branch 'Callisto.06' into 2019.05

parents abc31fd4 802ffe5c
......@@ -50,15 +50,15 @@ Here is the list of folders and files that are backed-up:
* :file:`/etc/consul/`
* :file:`/etc/crontab`
* :file:`/etc/dahdi/`
* :file:`/etc/dhcp/`
* :file:`/etc/hostname`
* :file:`/etc/hosts`
* :file:`/etc/dhcp/` 鈿狅笍锔 This will overwrite the network configuration when the backup is restored 鈿
* :file:`/etc/hostname` 鈿狅笍锔 This will overwrite the network configuration when the backup is restored 鈿
* :file:`/etc/hosts` 鈿狅笍锔 This will overwrite the network configuration when the backup is restored 鈿
* :file:`/etc/ldap/`
* :file:`/etc/network/if-up.d/xivo-routes`
* :file:`/etc/network/interfaces`
* :file:`/etc/network/interfaces` 鈿狅笍锔 This includes the host IP address / netmask and will overwrite the network configuration when the backup is restored 鈿 锔
* :file:`/etc/ntp.conf`
* :file:`/etc/profile.d/xivo_uuid.sh`
* :file:`/etc/resolv.conf`
* :file:`/etc/resolv.conf` 鈿狅笍锔 This will overwrite the network configuration when the backup is restored 鈿
* :file:`/etc/ssl/`
* :file:`/etc/systemd/`
* :file:`/etc/wanpipe/`
......@@ -164,6 +164,12 @@ A backup of both the configuration files and the database used by a XiVO install
automatically every day.
These backups are created in the :file:`/var/backups/xivo` directory and are kept for 7 days.
锔忥笍锔忊殸锔 Important Warning 鈿狅笍锔
============================
A XiVO backup includes the entirety of the original machine's network configuration : it WILL overwrite any present network settings when you restore it.
Remember to change those settings back if required before restarting network services or the machine itself, especially if you do not have physical or console access!
Limitations
===========
......@@ -288,4 +294,4 @@ Restart the services you stopped in the first step::
xivo-service start
You may also reboot the system.
You may also reboot the system. Remember that the network settings were overwritten by the backed up settings, check and fix if necessary before rebooting!
......@@ -28,3 +28,18 @@ Here is an example to increase the default number of concurrent connection to th
max_connections = 300
Files path summary table
========================
+------------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------+
| File | Path | Comment |
+========================+=====================================+=======================================================================================================+
| pg_hba.conf | /var/lib/postgresql/11/main/ | |
+------------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------+
| postgresql.conf | /var/lib/postgresql/11/main/ | Please, do not edit this file but use overriding mechanism explain in :ref:`database_configuration` |
+------------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------+
| conf.d files | /var/lib/postgresql/11/main/conf.d/ | Files are handled in Lexicographical order |
+------------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------+
| postgresql-11-main.log | /var/log/postgresql/ | Database log file. |
+------------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------+
......@@ -22,7 +22,15 @@ verbose debugging is required. Using this option in production would produce VER
* Number of archived files: 15
* Rotation frequence: Daily
postgresql
----------
* File location: :file:`/var/log/postgresql-11-main.log`
* Rotate configuration: :file:`/etc/logrotate.d/postgresql`
* Number of archived files: 15
* Rotation frequence: Daily
xivo-agentd
-----------
......
......@@ -120,6 +120,47 @@ Example : Using the caller number to open a customer info web page
.. figure:: example_xivo_sheet.png
:scale: 90%
.. _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.
* :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:
* ``popupUrl`` (MANDATORY)
* field type = ``text``
* It should contain an executable name accessible by the client user (where the desktop application is) or a full executable path.
* ``runAsExecutable`` (MANDATORY)
* field type = ``text``
* Display value ``true``
* ``executableArgs`` (OPTIONAL)
* field type = ``text``
* set the argument for the executable.
* :menuselection:`Services > CTI Server > Sheets > Events`: Choose the right events for starting the application.
Example : Run the ``notify-send`` command on linux:
* Define ``popupUrl`` with a display value of ``notify-send``
* Define ``runAsExecutable`` with a display value of ``true``
* Define ``executableArgs`` with a display value of ``caller:{xivo-calleridnum}`` where the variable ``xivo-calleridnum`` will be replaced by the caller phone number.
.. figure:: example_xivo_sheet_exe.png
:scale: 90%
.. _login_pause_funckeys:
Login and Pause management using function keys
......
......@@ -89,9 +89,11 @@ or::
- ``open``: Will open the given ``url`` inside the integration pane
- ``popup``: Will open the given ``url`` in a popup
- ``run``: Will run the given ``url`` as an executable, only works in desktop assistant.
- ``none``: No action will be performed
- ``event`` is one of ``EventRinging``, ``EventEstablished``, ``EventReleased``. The third party application will be opened when one the specified event occurs
- ``url`` should be the url to open inside the application. This url should point to a valid web application that can be specific for each call.
- ``executableArgs`` can contain an array of argument for the ``run`` action.
- ``autopause`` if set to true, the agent will be put on pause when the application pane is opened and back to ready when the application is completed.
- ``autopauseReason`` an optional field allowing to set the type of the pause used while setting the agent on pause (see the line above).
- ``multitab`` if set to true and ``action`` is set to ``popup``, then the integration will be opened a in new popup window (or tab) each time instead of reusing the same window (or tab).
......
......@@ -39,6 +39,7 @@ Received when you enter or leave a conference room.
"role": "User",
"isMuted": false,
"isMe": true,
"username": "jbond"
}
],
"since": 0
......@@ -74,7 +75,8 @@ Received when a participant enter, leave, or be updated in your conference room.
"isTalking": true,
"role": "Organizer",
"isMuted": false,
"isMe": false
"isMe": false,
"username": "jbond"
}
Fields description :
......@@ -91,6 +93,7 @@ Fields description :
* role: participant role, either "User" or "Organizer"
* isMuted: indicate if participant is muted
* isMe: indicate if participant is the current user
* username: username cti of the user, it's only defined for internal users
.. _conference_command_error:
......
......@@ -35,8 +35,16 @@ Received by the user when a message is sent
::
{"from":{"username":"bruce"},"sequence":145,"message":"How are you Alice ?",
"event":"FlashTextUserMessage"}
{
"from": {
"username": "bruce",
"displayName": "Bruce Willis"
},
"sequence": 145,
"message": "How are you Alice ?",
"date": "2019-05-28T14:55:08.628+02:00",
"event": "FlashTextUserMessage"
}
* FlashTextSendMessageAck
......
......@@ -96,14 +96,42 @@ Sheet
* Cti.MessageType.SHEET
::
{"msgType":"Sheet","ctiMessage":{"timenow":1425055334,"compressed":true,"serial":"xml",
"payload":{"profile":{"user":{"internal":[{"content":"xivo","name":"ipbxid"},
{"content":"link","name":"where"},{"content":"1425055330.23","name":"uid"},
{"content":"no","name":"focus"},{"content":"1","name":"zip"}],
"sheetQtui":null,"sheetInfo":[{"value":"http://www.google.fr/","name":"popupUrl","order":10,"type":"url"},
{"value":"&folder=1234","name":"folderNumber","order":30,"type":"text"},
{"value":"http://www.google.fr/","name":"popupUrl1","order":20,"type":"url"}],"systrayInfo":[]}}},"channel":"SIP/1k4yj2-00000013"}}
{
"msgType": "Sheet",
"ctiMessage": {
"timenow": 1425055334,
"compressed": true,
"serial": "xml",
"payload": {
"profile": {
"user": {
"sheetInfo": [
{
"value": "http://www.google.fr/",
"name": "popupUrl",
"order": 10,
"type": "url"
},
{
"value": "&folder=1234",
"name": "folderNumber",
"order": 30,
"type": "text"
},
{
"value": "http://www.google.fr/",
"name": "popupUrl1",
"order": 20,
"type": "url"
}
]
}
}
},
"channel": "SIP/1k4yj2-00000013"
}
}
User Statuses
-------------
......@@ -154,7 +182,8 @@ Format
"callDirection": "Incoming",
"userData":{
"XIVO_CONTEXT":"default","XIVO_USERID":"9","XIVO_SRCNUM":"1058","XIVO_DSTNUM":"3000"
}
},
username: "jblack"
}
}
......@@ -182,6 +211,10 @@ Format
| | system data XIVO\_ or data attached |
| | to the call key beginning by USR\_ |
+--------------+----------------------------------------+
|username | Can be the username cti of called |
| | number, it's only defined when the |
| | called user is an internal user |
+--------------+----------------------------------------+
If you use the following preprocess subroutine
......@@ -900,7 +933,8 @@ Request the list of conference rooms. Also receive event when the list is update
"joinTime": 1519659524032,
"muted": false,
"name": "James Bond",
"number": "1002"
"number": "1002",
"username": "jbond"
}
]
},
......
......@@ -73,5 +73,6 @@ XiVO Distributed System
:maxdepth: 1
Installation <xds/installation>
Architecture <xds/architecture>
Upgrade <xds/upgrade>
.. _xds_architecture:
****************
XDS Architecture
****************
The following diagram presents the XDS architecture with:
* one XiVO Main
* one CTI / Reporting Server (XiVO CC)
* and three MDS
.. figure:: xds-architecture.png
:scale: 100%
As you can see:
* each MDS and the Main are linked together via an internal SIP trunk (the yellow lines) - via the VoIP IP Address of the MDS
* the *xuc* components of the CTI / Reporting Server is connected to each MDS AMI - via the VoIP IP Address of the MDS
......@@ -2,6 +2,8 @@
Installing XDS
**************
.. important:: Before installing, make sure you understand the :ref:`xds_architecture` and links between components.
The XDS architecture has the following components:
* XiVO
......
......@@ -45,8 +45,8 @@ Configuration
Basic configuration
#. Enter the hostname (Allowed characters are : ``A-Z a-z 0-9 -``)
#. Enter the domain name (Allowed characters are : ``A-Z a-z 0-9 - .``)
#. Enter the hostname (Allowed characters are : ``a-z 0-9 -``, do not user uppercase letter)
#. Enter the domain name (Allowed characters are : ``a-z 0-9 - .``, do not user uppercase letter)
#. Enter the password for the ``root`` user of the web interface,
#. Configure the IP address and gateway used by the VoIP interface
#. Modify the DNS server information if needed
......
......@@ -27,6 +27,7 @@ A route can define
* **Media server**: define the route only for specific media server.
* **Context**: define the route only for specific context.
* **Internal**: set the route to forward the internal caller鈥檚 caller ID to the trunk. This option is useful when the other side of the trunk can reach the user with it鈥檚 caller ID number.
Here some examples of how you can take advantage of **RegExp** and **Target**:
......
This diff is collapsed.
......@@ -95,6 +95,21 @@ It is supported on both Windows and Linux Debian based distributions (with a des
.. _dapp_protocol_url_app:
.. _desktop_assistant_inifile:
Config file
-----------
You can specify your UC assistant parameters by providing a **xivoconfig.ini** file or by editing the one that gets created automatically
on first launch. This file **must be located in the same folder as your UC assistant executable**.
The xivoconfig.ini file template is as follows :
* **APP_PROTOCOL= HTTPS** (by default) or **HTTP** (*Defines if the connection is secured or not*)
* **APP_DOMAIN= URL** or **IP:PORT** (*Defines the URL or ip used by the UC assistant*)
* **APP_STARTUP= true** or **false** (*Defines if the UC assistant opens on operating system startup*)
* **APP_CLOSE= true** or **false** (*Defines if the UC assistant will be minimized in the taskbar instead of closed*)
Update
======
......
......@@ -26,7 +26,6 @@ The *XiVO UC Assistant* is a Web application that enables a user to:
* enable call forwarding and *Do Not Disturb* (aka DND)
* show history of calls
Login
=====
......@@ -260,6 +259,47 @@ Organizer can also:
* Mute and unmute any attendee
* Kick out an attendee. A message will be played to the kicked out attendee before leaving the conference.
Flashtext
=========
.. figure:: flashtext.png
:scale: 80%
You are able to send a `Flashtext` to a user of your choice.
This is an *instant message* that can be sent to another user logged in. Flashtexts are not saved.
When you send a Flashtext, you are notified with a toast if the message was sent successfully or
if the message was not sent because the recipient is not logged in.
When you receive a Flashtext, you are notified with a orange badge on the call tabs.
If you are using the desktop application, the electron tray icon also shows an orange badge.
You will also have a notification from your web browser or a system notification if you are using the desktop application.
You can send links in Flashtext, they will be clickable.
You can also write emojis from your keyboard (e.g., `:smile:`). You can find here some `emojis exemple`_.
.. _emojis exemple: https://www.webfx.com/tools/emoji-cheat-sheet/
You can send a Flashtext from different places in the application :
- From the contact line :
.. figure:: flashtext_from_contact_line.png
:scale: 80%
- From an ongoing call, by placing your mouse over the call line:
.. figure:: flashtext_from_ongoing_call.png
:scale: 80%
- from a conference call, by placing your mouse over a participant :
.. figure:: flashtext_in_conferences.png
:scale: 80%
WebRTC integration
==================
......
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