Release Notes

Gaia (2021.07)

Below is a list of New Features and Behavior Changes compared to the previous LTS version, Freya (2020.18).

New Features

Assistants

  • Common features
  • UC Assistant
    • When in conference, organizer can invite a user by typing its name or phone number in the search bar - see invite to conference in Attendee actions.
    • In the web assistant, you can now disable the download buttons from the login page - see disable download buttons.
    • If the call takes some time to start, the assistant displays a ‘dialing’ message on the call line.
    • It is now possible to hang up a ringing second call.
  • WebRTC
    • If user’s microphone seems to be turned off during the beginning of the call, a message appears to inform him (so he can fix his setup) - see Sound detection.
    • There is live feedbacks of the ongoing call audio quality in the form of a blinking color on the call line - see Call quality detection.
    • If a network or server issue can cause the ongoing call audio to be impacted, a message appears to inform the user - see Call quality detection.
    • There is also live feedbacks straight into the xuc server log files, including ongoing call quality issues, as well as an end-of-call quality report - see Call quality server-side feedbacks.
    • When you are on call and receive a second call: if you ignore it, the double call signalisation tone will be stopped also.

Recording

  • The search for a recording can be done by typing only a part of the number - see search for recordings.

API

  • New conference API - see detail in Conference Methods:
    • to Close a conference,
    • to Deafen/Undeafen a given participant,
    • to Invite someone (a xivo user or an extension) to the current conference

XiVO PBX

  • Users:

    • In the list of users, the display name of the media server is displayed, instead of its technical name.

    • New CTI password policy: a CTI password should be at least 8 characters long and contains letters and digits.

      Note

      when creating/editing a user, a warning is displayed if the cti password does not respect this new password policy. But you can still save it.

    • CTI password is not displayed anymore to the admin. Only dots are shown like on a normal password input field.

    • User CSV import/update: there is a new warning displayed in the webi (and confd logs) if the CTI password does not respect the new password policy - see CTI Profile.

  • WebRTC Line:

    • WebRTC line are now configured by default to use opus,alaw,vp8 codecs
    • Admin can customize codecs for WebRTC line (previously it was not taken into account)

  • In IPBX ‣ General ‣ SIP Protocol, there is a new field XiVO Edge FQDN to configure the link to XiVO Edge.

    Warning

    If this field is not empty, the XiVO Edge server must be running otherwise it will break all WebRTC communications

  • When you edit and save IPBX ‣ General ‣ SIP Protocol menu, it now reloads also RTP configuration (in addition to SIP configuration).

Asterisk

  • Version was upgraded to Asterisk 18.3.0
  • Added support for opus codec

XDS

  • BLF for DND and forward functions keys on phones on MDS (other than Main works)
  • File synchronization of custom dialplans, music on hold and custom sounds from XiVO Main to all media servers - see File Synchronization page.

System

  • Support OpenID Connect SSO Authentication - see OpenID Connect (OIDC) SSO Authentication
  • You can now disable the XiVO based authentication to enforce another authentication mechanism.
  • Upgrade docker-ce to 19.03.13
  • Upgrade docker-compose to 1.27.4
  • Upgrade ELK stack (Elastic, Logstash and Kibana) to 7.10.0
  • Upgrade nginx to 1.20.0
  • Upgrade electron to 11.0.2
  • Update Java openjdk docker images

Behavior Changes

Assistants

  • Common features

    • Auto reconnect: the Auto reconnect feature is now activated by default (previously you had to activate it via the Remember me checkbox). Therefore Remember me checkbox was removed.

      Note

      The Auto reconnect (previously Remember me) works only for 1 hour after leaving the application (previously it was working uring 7 days). After having been disconnected from the application for more than 1 hour you will need to retype your password - see Credentials validity period.

  • UC Assistant

    • When in conference and typing a phone number in the searchbar, a dropdown menu will show with 3 options : Call, invite to conference or search.
    • In the web assistant, you can now disable the download buttons from the login page.
    • If the call takes some time to start, the assistant displays a ‘dialing’ message on the call line.
    • It is now possible to hang up a ringing second call.

  • WebRTC

    • When you are on call and receive a second call: if you ignore it, the double call signalisation tone will be stopped also.

  • CC Agent

    • (for version below Freya.05) History: Agent Call history is now limited to the last 7 days: it displays the last 20 calls for the last 7 days period (previously it was displaying the last 20 calls with no period limit - which could overload the Reporting Server).

  • WebRTC

    • Default codecs for WebRTC lines (also WebRTC line of UA user) was changed to opus,alaw,vp8 (beforehand it was a combination of the SIP codec defined in the General settings of the SIP protocol plus ulaw,vp8)
    • When leaving the web/desktop-assistant (or agent) while having an ongoing webrtc call, and if you confirm, the call will be hung up.
    • When ignoring a second call, the sound of the double call is stopped.

XiVO PBX

  • Users

    • In the list of users, the display name of the media server is displayed, instead of its technical name.

    • New CTI password policy: a CTI password should be at least 8 characters long and contains letters and digits.

      Note

      when creating/editing a user, a warning is displayed if the cti password does not respect this new password policy. But you can still save it.

    • CTI password is not displayed anymore to the admin. Only dots are shown like on a normal password input field.

    • User CSV import/update: there is a new warning displayed in the webi (and confd logs) if the CTI password does not respect the new password policy - see CTI Profile.

  • WebRTC Line: if you customize the line’s codec (while editing a line in the Services ‣ IPBX ‣ IPBX Settings ‣ Lines menu): * Phone and WebRTC lines will use only the chosen codecs * for Unique Account line, codec customization only applies to the WebRTC line

  • In IPBX ‣ General ‣ SIP Protocol, the STUN Address field has been renamed to XiVO Edge FQDN. When upgrading from a version prior to Gaia.00, this field will be cleared.

    Warning

    If this field is not empty, the XiVO Edge server must be running otherwise it will break all WebRTC communications.

  • The password for xuc technical user is now randomly generated to enforce security. Moreover this user cannot be used to login any application or use the xucserver API.

    Warning

    If you used this ‘xuc’ user in custom made projects, you must create an alternate user dedicated to your application. See Allowing xuc user to login to API or Applications to change this behavior.

API

Deprecations

This release deprecates:

  • LTS Aldebaran (2018.05): after 3 years of support this version is no longer supported. No bug fixes, no security update will be provided for this release.
  • Unified Communication REST API v1.0 are now deprecated - see Deprecated APIs.

Upgrade

Manual steps for LTS upgrade

Warning

Don’t forget to read carefully the specific steps to upgrade from another LTS version

Generic upgrade procedure

Then, follow the generic upgrade procedures:

Gaia Bugfixes Versions

Components version table

Table listing the current version of the components.

Component current ver.
XiVO
XiVO PBX 2021.07.11
config_mgt 2021.07.11
db 2021.07.01
outcall 2021.07.00
db_replic 2021.07.00
nginx 2021.07.11
webi 2021.07.03
switchboard_reports 2021.07.03
XiVO CC
elasticsearch 7.10.0
kibana 7.10.0
logstash 2021.07.11
mattermost 2021.07.00
nginx 2021.07.11
pack-reporting 2021.07.00
pgxivocc 2021.07.00
recording-rsync 1.0
recording-server 2021.07.08
spagobi 2021.07.00
xivo-full-stats 2021.07.11
xuc 2021.07.11
xucmgt 2021.07.12
Edge
nginx 2021.07.11
kamailio 2021.07.11
coturn 2021.07.00

Gaia.12

Consult the 2021.07.12 (Gaia.12) Roadmap.

Components updated: xucmgt

Desktop Assistant

  • #5824 - Desktop application event resize are not handled properly

Gaia.11

Consult the 2021.07.11 (Gaia.11) Roadmap.

Components updated: config-mgt, edge-kamailio, edge-nginx, logstash, xivo-config, xivo-full-stats, xivo-webi-nginx, xivocc-installer, xivoxc-nginx, xucmgt, xucserver

Asterisk

  • #5435 - XDS - prevent loops between MDS (dialplan)

CCAgent

  • #5151 - Cannot do attended transfer when agent takes control of phone without cti user
  • #5786 - Call qualification updates - 3rd party display

CCManager

  • #4739 - As a user I should be able to use all CC Manager menus in Edge environment through internal CC IP/FQDN

Reporting

  • #4755 - Upgrade logstash to 7.16.2

    Important

    Behavior change Logstash was upgraded from 7.10.0 to 7.16.2 to fully mitigate Log4j security flaw.

  • #4878 - [C] - Missing answer time for consultation call (queue call with transfer to another queue) in call_on_queue table

Web Assistant

  • #4767 - [C] - Periodic websocket disconnection on Chrome (using Web Assistant)
  • #4896 - Memory leak when plantronics device is failing to connect

WebRTC

  • #5370 - Cannot make webrtc audio calls with Chrome 103 - Gaia

XiVO PBX

  • #5706 - Outcall route in Webi are not displayed in order of select
  • #5726 - monit generate high disk latency and high cpu usage (Gaia)

edge

  • #4768 - Kamailio - SIP register may fail if asterisk stack is unresponsive for more than 3-5sec
  • #4967 - Check token while opening the SIP websocket

Gaia.10

Consult the Gaia.10 Roadmap.

Components updated: config-mgt, play-authentication, recording-server, xivo-agentd, xivo-config, xucmgt

CCAgent

  • #4219 - CCAgent - Remember the login after each disconnection

Config mgt

  • #4329 - Update play-auth dependency in configmgt

Desktop Assistant

  • #4481 - Connection between Plantronics and Xivo assistant only at startup

GCU

  • #4546 - Documentation - Deprecated XCU

Recording

  • #4263 - Token authentication to recording server api retrieves wrong user

    Important

    Behavior change Previously you had to add an Administrator profile to the “xuc technical” user via the Config Mgt profile management to be able to use the Recording Server API with the token. This is no longer needed.

    To use the Recording Server API you now only need to use the token - see Authentication section of Recording server REST API.

Switchboard

  • #4647 - [C] Switchboard : unable to retrieve user id when attempted blind tranfers

Web Assistant

  • #4021 - Cannot close the Third Party Application
  • #4206 - Kerberos/OpenID doesn’t retry autologin when losing xuc connection

WebRTC

  • #4244 - “Could not initialize call” error is misleading when desktop app cannot access mic

XUC Server

  • #4648 - [C] - User receives ACD calls while on pause when he is added to a new queue [Gaia]

XiVO PBX

  • #4248 - Recorded files from UC Assistant (via *9) are not displayed in the Webi

Gaia.09

Consult the Gaia.09 Roadmap.

Components updated: xivo-confgend, xucmgt

Web Assistant

  • #4313 - [C] - As a phone user with an ongoing call, when I quit/refresh the Web Assistant it hangup my ongoing call

XiVO PBX

  • #4326 - sip.conf generation too slow for edge endpoints

Gaia.08

Consult the Gaia.08 Roadmap.

Components updated: config-mgt, recording-server, xivoxc-nginx, xucmgt, xucserver

Desktop Assistant

  • #4142 - Dapp in CCAgent crashes when quitting

WebRTC

  • #4181 - WebRTC Unified Plan Support

    Important

    Behavior change WebRTC now uses so-called Unified Plan for SDP (instead of Plan-B).

  • #4187 - WebRTC Conferences are not working with Unified Plan

  • #4216 - WebRTC client continue to send RTP after having put call on hold

Gaia.06

Consult the Gaia.06 Roadmap.

Components updated: xivocc-installer, xucmgt, xucserver

Web Assistant

  • #4136 - CAS SSO - Automatic relogin does not work
  • #4157 - CAS_LOGOUT_ENABLE does not work
  • #4194 - CAS SSO - Authentification not available from CC Agent
  • #4204 - CAS_LOGOUT_ENABLE does not work with CC Agent if login failed with error
  • #4205 - Fix login timeout parameter for CC Agent and switchboard

Gaia.05

Consult the Gaia.05 Roadmap.

Components updated: edge-nginx, recording-server, xivocc-installer, xucmgt, xucserver

CCAgent

  • #4177 - Missing translation for CC Agent for UNABLE_TO_START_WEBRTC

Desktop Assistant

  • #4160 - [C] - Be able to configure the lang fallback

    Important

    Behavior change Added the possibility to change the fallback lang for applications - see Change default fallback language

  • #4172 - UC Assistant - Fix Call management window Close button translation in German

Recording

  • #4153 - Recording Server Auth for user xuc still possible with old unsecure password

XUC Server

  • #4141 - [C] - Fix Audience when using multiple client id with OpenID

Edge

  • #4107 - Edge - SSO (OpenID) does not work via Edge server

Gaia.04

Consult the Gaia.04 Roadmap.

Components updated: edge-nginx, xivo-webi-nginx, xivocc-installer, xivoxc-nginx, xucmgt, xucserver

CCAgent

  • #4129 - [C] - Agent custom pause reason is not shown in CCAgent and in CCManager

Recording

  • #4133 - Customer call history duplicated

Switchboard

  • #4111 - [C] - POPC - Park call : caller’s number takes the agent’s number

Web Assistant

  • #4120 - Expose login timeout parameter for CC/UC web applications

Edge

  • #4138 - [Security] Update Nginx - DNS Resolver Vulnerability - CVE-2021-23017

    Important

    Behavior change Nginx version was upgraded from 1.20.0 to 1.20.1 (in XiVO, XiVOCC and Edge project)

Gaia.03

Consult the Gaia.03 Roadmap.

Components updated: config-mgt, edge-kamailio, edge-nginx, recording-server, xivo-agid, xivo-config, xivo-full-stats, xivo-switchboard-reports, xivo-web-interface, xivo-webi-nginx, xivocc-installer, xivoxc-nginx, xucmgt, xucserver

CCAgent

  • #3818 - Switchboard (CC Agent) history is wrong for call received from/emitted towards MDS user

Desktop Assistant

  • #4092 - [C] - Close to tray cause application re-opening errors

    Important

    Behavior change Closing the Desktop Application from the Taskbar (Right-Clic -> Close Window) will now Quit the application. Beforehand the application would have been minimized in the Systray (if the option Minimize to tray option was checked) but then it couldn’t be re-opened from the Systray. Note that if you have an ongoing call you’ll be warned before the application is closed.

Security

  • #3992 - [Security] Disable the XUC REST API by default (allow by a config flag)

    Important

    Behavior change XUC APIs v1.0 are now deprecated and require a custom.env key to be used - see Deprecated APIs If you use Agent custom Login/Logout functions keys (Login or Pause management using function keys), then you need to re-enable these API.

  • #4099 - [Security] Update nginx to version 1.20.0

    Important

    Nginx version was upgraded from 1.19.10 to 1.20.0 (in XiVO, XiVOCC and Edge project)

  • #4101 - [Security] Update kamailio to version 5.5.0

    Important

    Kamailio version was upgraded from 5.4.4 to 5.5.0

Switchboard

  • #4037 - Switchboard report doesn’t work

Web Assistant

  • #4094 - User is not relogged automatically if an errors occurs

XUC Server

  • #4028 - OpenID - Authorize multiple client id
  • #4058 - When changing FWD destination in UC, previous FK is not updated on phone

XiVO PBX

  • #3994 - Schedule is not precise on closed hours

    Important

    Behavior change The upper limit is excluded from the defined period.

    i.e. if you define a schedule with a period between 08:00-14:00 the a call arriving at 14:00:00 will be outside the period (beforehand a call arriving between 14:00:00 and 14:00:59 was inside the period).

  • #4023 - When I change a user from a mds to another one I must save twice for the phone config to be correctly updated

  • #4064 - [C] - Can’t customize user’s callerid anymore

Edge

  • #4081 - Edge - Web proxy - Allow desktop assistant install and update path
  • #4104 - Edge proxy - Wrong include

Gaia.02

Consult the Gaia.02 Roadmap.

Components updated: xivo-bus, xivo-utils, xivo-web-interface, xivocc-installer, xucmgt, xucserver

Chat

  • #4047 - [C] - Chat : the answer to a text message won’t be received (Port to Gaia/master)

Config mgt

  • #4019 - Make xuc technical user not editable (and njot deletable) from the webi users list

Switchboard

  • #4050 - New message badge is sometimes missing for unread messages on logging

Web Assistant

  • #4020 - Assistant interface is reinitialized to a previous state

XUC Server

  • #4018 - Given I activate fwd towards destination, the key Enable/Disable forward unconditionnal should be lit accordingly
  • #4027 - OpenID - Accept OpenID token through HTTP Header

XiVO PBX

  • #3817 - confd - when updating user forwards & DND, replace event in RabbitMQ with new ones
  • #4032 - [C] XDS - As a user attached to a MDS (other that XiVO Main), then I cannot customize my Voicemail password by my own
  • #4036 - MDS - some logs are not rotated

Gaia.01

Consult the Gaia.01 Roadmap.

Components updated: asterisk, config-mgt, edge-kamailio, edge-nginx, sipml5-xivo-mirror, xivo-agid, xivo-confd, xivo-config, xivo-db, xivo-edge, xivo-web-interface, xivo-webi-nginx, xivocc-installer, xivoxc-nginx, xucmgt, xucserver

Asterisk

  • #3932 - Prepare Asterisk 18.3.0

CCAgent

  • #3984 - Phone number required message not displayed when login to ccagent
  • #3986 - On hold notification not working in ccagent

Recording

  • #3936 - [C] - Recorded files are not always downloadable under Chrome browser

Security

  • #3970 - [Security] xuc technical user should have a random generated password

    Important

    Behavior change Warning: The password for xuc technical user is now randomly generated to enforce security. Moreover this user cannot be used to login any application or use the xucserver API. If you used this user in custom made projects, you must create an alternate user dedicated to your application.

  • #3997 - [Security] Add HTTP only flag on the session cookies

  • #3998 - [Security] Add HSTS to HTTPS response

  • #4000 - [Security] Update nginx to latest version

  • #4001 - [Security] Enforce restrictions on nginx configuration

  • #4002 - [Security] Check log rotate configuration of xivo-edge

  • #4010 - [Security] Changes to be made for CSP headers support

Web Assistant

  • #3916 - Call init line is displayed when calling single digit number

  • #3976 - Cti ws should only break when we miss 3 heartbeat

  • #4013 - Remove the remember me option and activate the auto-reconnect by default

    Important

    Behavior change The remember me feature is now enabled by default until you force the logout, the checkbox has been therefore removed.

WebRTC

  • #3967 - Kamailio - Fix undefined routes and remove dead code
  • #3979 - [C] - User with special characters in name can’t call a WebRTC user
  • #3983 - Edge - Web proxy - Do not intercept errors for api calls
  • #3993 - Fix javascript specs breaking because of audio quality monitoring

XUC Server

  • #3760 - Move User forward & DND feature out of ctid
  • #3763 - XUC - Set Forward & DND for user using configmgt API
  • #3786 - Webi - Set Forward & DND for user using configmgt API

XiVO PBX

  • #2520 - XDS - On MDS (other than main), function keys state for dnd, fwd{unc, busy, noanswer} should be updated

  • #3764 - AGI - Set Forward & DND for user using configmgt API

  • #3985 - As an admin I want to see the files recorded from phoneset with *9 from an MDS user to be seen in XiVO

    Important

    Behavior change The /var/lib/xivo/sounds/recordings/ directory will be synchronized both ways between Main and MDS - see Synchronized dirs.

    It permits for example to retrieve on the Main the file recorded on MDS via the *9 extension.

XiVOCC Infra

  • #3963 - Monitor NVD security feed, search for Docker, Nginx, Kamailio, Coturn and Asterisk related posts