Release Notes

Helios (2021.15)

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

New Features

Meeting Rooms

  • Add the video conferencing with window sharing in XiVO application - see Meeting Rooms for a full description of the features:
    • Static Meeting Room,
    • Personal Meeting Room,
    • External Sharing Link,
    • Invite to Meeting Room

Assistants

  • Common features
    • (from Helios.03) Enhanced search for internal users. Search:
      • will work with or without diacritics
      • will work if you search part of the firstname and part of the lastname
      • and will try to find something even if your search term contains a typo (for example if you have a user with firstname Philipp it should find it if you search for Philpp)
    • Added message on the browser and the desktop application when the window is too small to properly use the application
    • Added the possibility to change the fallback lang for applications - see Change default fallback language
    • Search results shows Meeting Room (with an icon group of users)
  • Desktop Application
    • The Desktop assistant can be resized but still has a minimal size. It no longer automatically resize when you change the screen it is displayed on.
  • UC Assistant
    • Phone status for contacts coming from a different source than internal XiVO Users is displayed if its number matches a XiVO user number in the Favorites view. It was already the case for Search results view but it wasn’t working in the Favorites view if you selected as favorite the contact that was not coming from internal XiVO users source.

API

  • Added new meeting rooms API, see Meeting Rooms
  • (From Helios 0.3) Add number in LineConfig websocket event

Audio Conferences

  • When an organizer leaves a conference, the participant states are set to their default state. All muted or deaf participants are not muted or deaf anymore.

XiVO PBX

  • New menu Meeting rooms to create meeting room
  • (from Helios.01) Certificate used by Nginx and Backend services were split: this enables an admin to put a trusted certificate for nginx without the need to restart all services- see HTTPS certificate.

UC-Addon

  • (from Helios.01) Certificate used by Nginx and Backend services were split: this enables an admin to put a trusted certificate for nginx without the need to restart all services- see HTTPS certificate.

System

  • Added the reload action to xivo-dcomp and xivocc-dcomp utilities. It applies only to the following services:
    • on XiVO:
      • db: xivo-dcomp reload db
      • nginx: xivo-dcomp reload nginx
    • on MDS:
      • db: xivo-dcomp reload db
    • on XiVO CC
      • pgxivocc: xivocc-dcomp reload pgxivocc
      • nginx: xivocc-dcomp reload nginx
  • Upgrade electron to 13.1.0
  • Upgrade nginx to 1.21.0
  • Ugrade ELK stack from 7.10 to 7.14

Behavior Changes

Assistants

  • Desktop Application
    • The Desktop assistant no longer has a fixed size. It can be resized but still has a minimal size. It no longer automatically resize when you change the screen it is displayed on.
  • UC Assistant
    • Video experimental feature is removed. This feature is replaced by Meeting Rooms features.
    • Phone status for contacts coming from a different source than internal XiVO Users is displayed if its number matches a XiVO user number in the Favorites view. It was already the case for Search results view but it wasn’t working in the Favorites view if you selected as favorite the contact that was not coming from internal XiVO users source.

Audio Conferences

  • When an organizer leaves a conference, the participant states are set to their default state. All muted or deaf participants are not muted or deaf anymore.

Reporting

XiVO PBX

  • (from Helios.01) A new selfsigned certificate is generated for Nginx on XiVO. This enables an admin to put a trusted certificate for nginx without the need to restart all services- see HTTPS certificate.

UC-Addon

  • (from Helios.01) A new selfsigned certificate is generated for Nginx on XiVO. This enables an admin to put a trusted certificate for nginx without the need to restart all services- see HTTPS certificate.

API

  • Recording Server: Previously (before Gaia.10) 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.

  • XUC

    • Web Socket API now integrates a throttling mechanism to prevent flooding. If you exceed more than 15 request messages in 30 seconds (with a burst of 25), your messages will be throttled and you will receive an error {msgType: “Error”, ctiMessage: {Error: “Maximum throttle throughput exceeded.”}}

    • Old xuc 1.0 API is now deprecated. You can allow access per client by setting their IP in the DEPRECATED_API_HOST variable in custom.env - see Deprecated APIs.

      Warning

      In Gaia, you had to put the xivocc ip address in this field, you must replace it with the list of client ip address.

Deprecations

This release deprecates:

  • LTS Borealis (2018.16): after 3 years of support this version is no longer supported. No bug fixes, no security update will be provided for this release.
  • Video experimental feature is removed.
  • Deprecated API /ctichannel to access CTI WS was completely removed (it was deprecated since LTS XiVO Five) - see Login and Authentication for current way to open CTI WS.

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:

Helios Bugfixes Versions

Components version table

Table listing the current version of the components.

Component current ver.
XiVO
XiVO PBX 2021.15.04
config_mgt 2021.15.05
db 2021.15.05
outcall 2021.15.00
db_replic 2021.15.00
nginx 2021.15.01
webi 2021.15.05
switchboard_reports 2021.15.00
XiVO CC
elasticsearch 7.14.0
kibana 7.14.0
logstash 2021.15.00
mattermost 2021.15.00
nginx 2021.15.00
pack-reporting 2021.15.00
pgxivocc 2021.15.00
recording-rsync 1.0
recording-server 2021.15.01
spagobi 2021.15.00
xivo-full-stats 2021.15.00
xuc 2021.15.05
xucmgt 2021.15.05
Edge
edge 2021.15.01
nginx 2021.15.01
kamailio 2021.15.00
coturn 2021.15.00
Meeting Rooms
meetingroom 2021.15.00
web-jitsi 2021.15.03
jicofo-jitsi 2021.15.00
prosody-jitsi 2021.15.00
jvb-jitsi 2021.15.00
jigasi-jitsi 2021.15.00

Helios.05

Consult the Helios.05 Roadmap.

Components updated: config-mgt, xivo-config, xivo-dao, xivo-db, xivo-dird, xivo-lib-python, xivo-web-interface, xivo-webi-nginx, xivocc-installer, xucmgt, xucserver

Desktop Assistant

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

Visioconf

  • #4404 - Meeting Rooms Should be compatible with uc addon
  • #4507 - Given I am kicked out from conf, it should close meetingroom iframe
  • #4514 - Meeting Room - Search does not work with accents and diacritics
  • #4544 - Meeting Room - Manual window resize does not reset to original size in desktop
  • #4554 - [Meetingrooms] As an agent, I cannot answer a meetingroom invite while in small bar mod
  • #4555 - [Doc] As an agent, I still receive queue calls while in a meetingroom
  • #4556 - [Doc] As an agent, I can’t be invited to a meetingroom if I don’t control my own line
  • #4576 - Meeting Room - External link does not set room name with accents
  • #4587 - When I’m in a video call, when I answer an audio call, the video call should be muted
  • #4588 - When I’m on call (audio), when I answer a video call, the audio call should be put on hold audio if any

XUC Server

  • #4508 - Invitation to meeting room should be possible without having the chat enabled

XiVO PBX

  • #4504 - XiVO PBX - Define standard QoS DSCP values for SIP & RTP in XiVO

    Important

    Behavior change In Sip Protocol on the webi, tos_audio and tos_sip will take the values EF and AF31 by default respectively. If you provided values for those before, they won’t be overriden.

  • #4506 - Confd - endpoint for swagger api descriptor does not work

  • #4634 - IVR - Set ivr as incoming call destination

edge

  • #4621 - [Doc] Edge Documentation example is not correct for STUN/TURN configuration

Helios.04

Consult the Helios.04 Roadmap.

Components updated: xivo-dao, xivo-dird, xivo-web-interface

XiVO PBX

  • #4577 - Search does not work properly with empty last name
  • #4578 - Can’t display more than one favorite
  • #4581 - Replace dummy text at IVR page when ivr is not installed

Helios.03

Consult the Helios.03 Roadmap.

Components updated: config-mgt, xivo-confd, xivo-config, xivo-dao, xivo-db, xivo-dird, xivo-lib-python, xivo-web-interface, xivo-web-jitsi, xivo-webi-nginx, xivocc-installer, xucmgt, xucserver

Visioconf

  • #4427 - Meeting Room - Display room name instead of uuid when coming from the external link
  • #4470 - Webi - Incoming call menu should not propose personal meeting room
  • #4473 - Meeting Rooms - Invite someone in a conference
  • #4474 - Meeting rooms - Start an internal meeting room
  • #4478 - xucmgt : invite to meeting room
  • #4482 - XucMgt - You can receive and answer to an invitation to a conference
  • #4483 - Cti.js - Add new conferences APIs
  • #4484 - XucMgt - You can see you have conference invitation waiting for a response
  • #4485 - Xuc - Handle meetingRoom invitation messages
  • #4486 - Xucmgt - You can call a user in video
  • #4487 - Xuc - Add forward route to configmgt to temporary meeting room creation API
  • #4488 - Configmgt - Add API to create temporary meetingRoom
  • #4515 - Meeting rooms : button to hide the interfaces is not displayed anymore on ccagent and switchboard
  • #4516 - As a user I want to ear a ringtone I receive a video call
  • #4540 - Meeting Room - Enhance screen sharing quality
  • #4545 - Meeting Room - Maximize does not restore joined meeting room in desktop
  • #4566 - Video call button should only appear for internal users

Web Assistant

  • #4429 - CAS SSO - Automatic relogin does not work

XiVO PBX

  • #4436 - Enhance user search
  • #4563 - IVR - Database evolution
  • #4564 - Match CSS orange color for all pages of webi
  • #4568 - IVR - Set language in the cookie
  • #4569 - IVR - Integrate ivr editor into webi
  • #4570 - IVR - Add override file to xivo dcomp
  • #4571 - IVR - Add override file to nginx
  • #4572 - IVR - Add dialplan
  • #4573 - IVR - Create Jenkins build jobs
  • #4575 - IVR - Add menu in webi

XUC Server

  • #4243 - XuC - Add line number in lineconfig

XiVOCC Infra

  • #4513 - Can’t execute statistics reports from SpagoBI if Edge server is installed

GCU

  • #3736 - Documentation - Deprecated XCU

Helios.02

Consult the Helios.02 Roadmap.

Components updated: xucmgt, xucserver

Web Assistant

  • #4459 - Add the deaf / undeaf API to the UC Assistant

XUC Server

  • #4379 - Return Error when Cti.dial cannot be completed

Helios.01

Consult the Helios.01 Roadmap.

Components updated: config-mgt, edge-nginx, recording-server, xivo-agid, xivo-config, xivo-dao, xivo-db, xivo-dird, xivo-edge, xivo-web-interface, xivo-web-jitsi, xivo-webi-nginx, xivocc-installer, xucmgt, xucserver

Desktop Assistant

  • #4456 - Allow Desktop application to be able to share screen

Recording

  • #4453 - Weeks to keep in recording server is always default value

Security

  • #4122 - [Security] As an Admin I can define the list of authorized clients authorized to use the XUC REST API

    Important

    Behavior change Old xuc 1.0 API is now deprecated. You can allow access per client by setting their IP in the DEPRECATED_API_HOST variable in custom.env. Warning, it used to be the xivocc ip address in this field, you must replace it with the list of client ip address.

Switchboard

  • #4435 - Switchboard UI glitches

    Important

    Behavior change When using a third-party-sample page on a switchboard, if you put a call on the hold queue, then you see the sample page. If you receive another call meanwhile, you won’t be able to retrieve it unless you close the sample page or you change your status.

Visioconf

  • #4201 - Meeting Room - As a user I want the number of the conference room to be displayed when in a conference
  • #4415 - Meeting Room - UC Assistant - User Experience
  • #4420 - Remove column name from meeting room table
  • #4428 - There is no more error message when you try to start two jitsi conference
  • #4430 - Put personal conf creation just behind user contact creation
  • #4431 - User status color is incorrect when user is in a meeting room
  • #4432 - Show conference number when joined visio by desktop
  • #4434 - You should not access jitsi home page
  • #4437 - If I add a PIN to a room after having shared the link, the pin should be asked to people having the old share link
  • #4445 - Redirection when an external user leave the meeting room
  • #4446 - Meeting Rooms - Verify CC agent & switchboard usage
  • #4447 - Meeting rooms : (Webi Admin) MR Number taken
  • #4463 - MR name with accents should be correclty displayed in video panel
  • #4465 - Display a toast message when sharing link is copied
  • #4469 - Meeting rooms : enhance ui for pin code modal
  • #4472 - Meeting room - Enhance joining room from mobile phone

Web Assistant

  • #4433 - Token renewal failed
  • #4457 - favicon was not updated for the web assistant on Helios
  • #4466 - [Meeting Rooms] I can create and try to join a personnal meeting room even when Meeting Room server is not installed

XUC Server

  • #4441 - Cti.toggleMicrophone does not work

XiVO PBX

  • #3890 - Dissociate Nginx and xivo-services certificates on xivo

    Important

    A new certificate was intalled for XiVO Nginx in /etc/docker/nginx/ssl/. This certificate will be used by the Webi. See HTTPS certificate for more information explanation.

    If you had installed, on the XiVO PBX, a trusted certificate you must replace this new generated certificate by the one you installed previously. Normally this means that you should copy /usr/share/xivo-certs/server.{crt,key} files into /etc/docker/nginx/ssl/xivoxc.{crt,key} files:

    cp /usr/share/xivo-certs/server.crt /etc/docker/nginx/ssl/xivoxc.crt
    cp /usr/share/xivo-certs/server.key /etc/docker/nginx/ssl/xivoxc.key
    

    And then reload Nginx:

    xivo-dcomp reload nginx
    

    See Install Trusted Certificate for Nginx (and UC app in UC Addon mode) for generic explanation.

  • #4411 - Enhance meeting room research

  • #4438 - [Web-i] Add a restart xivo-dird to CTI configuration Page

  • #4449 - [Doc] Update XiVO CC Apps URI

  • #4450 - [Doc] WebRTC part in Doc is really old …

  • #4462 - Webi - I should not need to click twice on the save button to create a MR

  • #4464 - Generate 64 chars long password for xuc and configmgt auth secret

    Important

    Behavior change This only applies if you upgrade from Helios.00: CONFIGMGT_AUTH_SECRET value in the /etc/docker/xivo/custom.env file was regenerated. This key was added during Helios.00 install/upgrade with a 16 chars length value and was replaced by a longer one (64 chars). If you have the Meeting Room server, you MUST update accordingly the value of the key JWT_APP_SECRET in the Meeting Room server configuration.

Edge

  • #4455 - [S] Configure coturn to only proxify to allowed peers (xivo, mds, meetingroom)

    Important

    Behavior change If you already had a Edge server installed and configured in Helios.00. Then you need to:

    1. add and fill the XIVO_HOST var in the .env file of the Edge Web Server
    2. add and fill the TURN_ALLOWED_PEERS var in the .env file of the Edge TURN Server - follow TURN Server Relay Authorization

Helios Intermediate Versions