Release Notes

Maia

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

New Features

UC Assistant

  • Contact/Favorite display: the contact displayed in favorite or search results now contains 2 more fields - see Search.

  • Contact/Favorite details: the contact details now contains up to 14 information (including 5 phone numbers) - see Search.

    Important

    Information displayed depends on how the directories are configured.

  • Search: you can search on different information than just the firstname, lastname

  • UC App design was updated

XiVO PBX

  • Asterisk version upgraded to 20.6.0

  • Upgrade: enhancement in the upgrade process

    • deactivation of non-xivo apt sources list before the upgrade to Bookworm

    • add log prefixed with Upgrade: to follow the upgrade process

Auth delegation / OIDC

  • The OIDC_LOGOUT_ENABLE feature is now compatible with Keycloak higher than 18

  • We are now able to delegate authentication to Microsoft Entra ID.

System

  • new xivocc-upgrade script to upgrade the XiVO CC machine - see also Upgrade to another LTS version

  • Docker upgraded to 25.0.5

  • docker compose upgraded to v2 (using docker compose plugin now)

    Important

    • it’s a major change from docker-compose ‘v1’ (docker-compose)

    • it’s available on all machines from the XiVO cluster (PBX,UC,MeetingRooms,etc…)

    • the full changelog is available here : https://docs.docker.com/compose/migrate/#what-are-the-differences-between-compose-v1-and-compose-v2

    • accordingly, the container names have changed from xivo_db_1 to xivo-db-1 for the db container for instance.

    • the dcomp helpers (xivo-dcomp, xivocc-dcomp, etc…) have been updated so they can be used as before.

    • while compose files within XiVO have been updated, any additional custom compose file must be updated as well.

API

  • WebSocket API InviteToConference evolutions. New optionals parameters are available :

    • Put participant as marked in the meetme conference

    • Force the participant to leave the conference when the last marked user leaves

    • Customize the callerId of the participant

  • New Websocket API to be able to merge an audio call in an audio conference. The precondition to use this API is to have both calls up for the same user :

    • A call to an audio conference

    • A standard call

Behavior Changes

XiVO PBX

  • Upon upgrade a new Display filter (Services ‣ CTI Server ‣ Display filters) named Display is created. The previous Display display filter is renamed DisplayLegacy.

  • Upgrade: when switching to Bookworm, the upgrade will deactivate all apt sources list except those needed for xivo (xivo, debian, docker, postgres). After the upgrade you might need to reactivate some custom sources list.

API

  • Web Socket API: if you still use the deprecated Cti.directoryLookUp and Cti.getFavorites API (see Deprecation below), note that the headers field of the DirectoryResult message is now hardcoded with the value as shown below.

    {
        "msgType": "DirectoryResult",
        "ctiMessage": {
           "headers": ["name", "number", "mobile", "external_number", "favorite", "email"],
           "entries": [
               { "status": 0, "entry": [ "hawkeye", "1002", "0761187406", "", "false", ""]},
            ]
        }
    }
    

Deprecations

This release deprecates:

  • Web Socket API: new contact related APIs (search and favorites) were added. It deprecates directoryLookUp and getFavorites APIs. For detail see Contacts And Favorites:

    Deprecated

    New API

    directoryLookUp

    searchContacts

    getFavorites

    getFavoriteContacts

    Warning

    Deprecated APIs directoryLookUp and getFavorites will be removed in next LTS.

  • LTS Gaia (2021.17) : This version is no longer supported.

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:

Maia Bugfixes Versions

Components version table

Table listing the current version of the components.

Component

current ver.

XiVO

XiVO PBX

2024.05.04

config_mgt

2024.05.00

db

2024.05.04

outcall

2024.05.04

db_replic

2024.05.00

nginx

2024.05.00

webi

2024.05.04

switchboard_reports

2024.05.00

usage_writer

2024.05.00

usage_collector

2024.05.00

agid

2024.05.04

confgend

2024.05.04

asterisk

8:20.6.0-1

docker-ce

5:25.0.5

docker-compose

2.26.1

XiVO CC

mattermost

2024.05.00

nginx

2024.05.00

pack-reporting

2024.05.00

pgxivocc

2024.05.00

recording-rsync

2024.05.00

recording-server

2024.05.00

spagobi

2024.05.00

xivo-full-stats

2024.05.00

xuc

2024.05.04

xucmgt

2024.05.04

Edge

edge

2024.05.02

nginx

2024.05.00

kamailio

2024.05.00

coturn

2024.05.04

Meeting Rooms

meetingroom

2024.05.02

web-jitsi

2024.05.00

jicofo-jitsi

2024.05.00

prosody-jitsi

2024.05.00

jvb-jitsi

2024.05.00

jigasi-jitsi

2024.05.00

IVR

ivr-editor

2024.05.02

2024.05.04 (Maia.04)

Consult the 2024.05.04 (Maia.04) Roadmap.

Components updated:

Docker: db-migration, edge-coturn, xivo-agid, xivo-confgend, xivo-db, xivo-outcall, xivo-web-interface, xucmgt, xucserver

Debian: xivo-config, xivo-dao, xivo-sysconfd, xivo-upgrade, xivocc-installer, xivo

Asterisk

  • #7212 - I want to be able to validate Edge for 250 simultaneous calls

  • #7698 - Prevent high CPU load (peak) when saving a user if there is a lot of file in /var/spool/asterisk/monitor

Mobile Application

  • #7776 - MobileApp user can not use group calls

Web Assistant

  • #7639 - Refactor contactsheet - contact folded code

  • #7703 - I cant use chat via the Chat action in the Contact sheet

  • #7705 - Update doc screenshot following UC App redesign and new contact display

  • #7801 - WebRTC audio conference calls should be hang up automatically when the assistant is closed

XUC Server

  • #7752 - Given I’m an audio conference admin, I want to include a mds user in the conference

  • #7777 - OIDC OIDC_ADDITIONAL_SERVERS_URL field is not used when verifying the token signature

  • #7783 - Add evolution for APIs conferences in maia high level features

XiVO PBX

  • #7634 - As an admin I want to be able to edit the directory definition more easily

  • #7706 - Possible delay in outcall due to subscription-timeout

  • #7771 - Can’t edit network interface from webi

  • #7773 - Upgrade from Izar fails on db upgrade

  • #7775 - Database uses wrong collation

  • #7786 - Agid dont start if you have a mobile app configured

  • #7802 - Python scripts (xivo-call-logs, xivo-create-config …) generates a lots of SqlAlchemy warning

XiVOCC Infra

  • #7760 - As an Admin I want to be able to use xivocc-upgrade on CC server

edge

  • #7774 - Coturn - allowed-peers syntax does not work anymore

2024.05.03 (Maia.03)

Warning

As of Maia.03 upgrade is only supported from Kuma

Consult the 2024.05.03 (Maia.03) Roadmap.

Components updated:

Docker: edge-coturn, ivr-editor, xivo-agid, xivo-confgend, xivo-db, xivo-edge, xivo-meetingrooms, xivo-web-interface, xucmgt, xucserver

Debian: xivo-agentd, xivo-agentd-cli, xivo-agentd-client, xivo-amid, xivo-amid-client, xivo-auth, xivo-auth-client, xivo-auth-keys, xivo-bus, xivo-call-logs, xivo-confd, xivo-confd-client, xivo-config, xivo-dao, xivo-dird, xivo-dird-client, xivo-dird-phoned, xivo-dist, xivo-dxtora, xivo-dxtorc, xivo-fetchfw, xivo-lib-python, xivo-lib-rest-client, xivo-manage-db, xivo-monitoring, xivo-provd-cli, xivo-provd-client, xivo-provisioning, xivo-purge-db, xivo-python-celery-packaging, xivo-python-dumbnet-packaging, xivo-service, xivo-sync, xivo-sysconfd, xivo-tools, xivo-upgrade, xivo-utils, xivocc-installer, xivo

Others: xivo-desktop-assistant, xivo-install-script, xivo-test-helpers

Asterisk

  • #7707 - Build asterisk for Debian 12

  • #7708 - Build dahdi 3.3.0 for Debian 12

Desktop Assistant

  • #7627 - As a DApp user I want to be able to zoom the application

Directory

  • #7536 - SVI Graphic quick and partial rebuild to make it easy to use even for non specialist

Web Assistant

  • #7702 - If you can’t invite someone in the conference it should be obvious

  • #7741 - Contact search does not display result if a contact does not contain any name

  • #7750 - I should see the button include to conference with platic phones

  • #7762 - Make active call more visible in UC assistant

XUC Server

  • #7693 - Add arguments for conferenceInvite

  • #7748 - I should not have to enter the conference pin when I’m included in an audio conference

  • #7749 - I should be able to customize the participant callerId when I invite him in the conference without early join

  • #7751 - I should be able to include a user in the conference if I join the conference after calling the user

XiVO PBX

  • #7097 - Remove remaining Asterisk & Wisper logos / awkward mentioning in doc to follow trademark rules

  • #7515 - Evaluate if we can find a merge contact strategy that could be handled

  • #7529 - [IVR] Let user select as destination a group

  • #7552 - Rebuild SVI Graphic Nav in order to better highlight most needed functionalities.

  • #7554 - Voicemail as User destinations should benefit search assistance

  • #7555 - Make nodes title automatically explicit in both : Parameter window and Building area

  • #7756 - As an admin I can upgrade my XIVO PBX / MDS to a Debian 12 (Bookworm) version

XiVOCC Infra

  • #7465 - Update XiVO Solutions to Debian 12

  • #7518 - As an admin I can install XIVO CC on a Debian 12 (Bookworm)

  • #7564 - As an admin I can install XIVO PBX / MDS on a Debian 12 (Bookworm)

  • #7761 - As an Admin I can install/upgrade Edge/Meetingroom on Debian 12

edge

  • #7736 - Update coturn to 4.6.2

2024.05.01 (Maia.01)

Consult the 2024.05.01 (Maia.01) Roadmap.

Components updated:

Docker: xivo-confgend, xucmgt, xucserver

Asterisk

  • #7734 - Asterisk SIP to PJSIP - allow_unauthenticated_options is not generated in pjsip.conf

CCAgent

  • #7719 - Typo in stats on the CCAgent

Web Assistant

  • #7676 - Change actions in UC Assistant when you have one meet me call and one normal call

  • #7742 - Contactsheet tooltip, close on click, research break on empty name

XUC Server

  • #7655 - Remove dird log in xuc

  • #7675 - Add a new API to include ongoing call with ongoing conference

  • #7731 - Include to conf does not work for call passing by trunk

2024.05.00 (Maia.00)

Consult the 2024.05.00 (Maia.00) Roadmap.

Components updated:

Docker: edge-nginx, xivo-agid, xivo-web-interface, xivo-web-jitsi, xucmgt, xucserver

Directory

  • #7371 - Launch a research sorting it out by first + last name, position, department, company, location …

Web Assistant

  • #7635 - Fold Général and Lieu d’affectation group when fields are empty

  • #7636 - We want to always display all the action button

  • #7661 - Phone status of user displayed in favorite/search result is not updated (but works in history)

  • #7662 - Chat glitches - Emoji not displayed in the conversation list, ellipsis missing, no counter

  • #7663 - Small UI glitches

  • #7677 - Update Keycloak compatibility to allow logout to work with version 18+

XUC Server

  • #7497 - Make SSO process built on OpenID protocol fully functional on both Azure Ad and Keycloak

  • #7586 - As a remote audio conference user, I want to send command to the conference

XiVO PBX

  • #7328 - Make XiVO agnostic in its logo/description

  • #7683 - Mobile App AGI mobile_app_wake_up enhancements 2 (logs & mobile app contact duplicate detection)

Maia Intermediate Versions