Release Notes¶
Freya (2020.18)¶
Below is a list of New Features and Behavior Changes compared to the previous LTS version, Electra (2020.07).
Important
Upgrade to Freya will upgrade your system to Debian 10 (Buster). See Debian 10 (Buster) Upgrade Notes.
New Features¶
Assistants
- Common features
- Can call an user directly from the chat conversation - see Call from conversation
- Plantronics Integration (be able to answer and hangup calls) directly from your headset.
- CC Agent
- Added a keybinding list - see Keyboard shortcuts for call control section
- Successive calls from the same caller are aggregated. You can expand call entry to display more details.
- UC Assistant
- Logout button was moved in the parameter (hamburger) menu - see Logout from UC Assistant
- Desktop Assistant
- Can download the Desktop assistant from the login pages in browser (UC Assistant and CCAgent) - see Installation section
- Switchboard
- Added a keybinding list - see Keyboard Navigation section
- The switchboard history contains now 100 results
- Successive calls from the same caller are aggregated. You can expand call entry to display more details.
- WebRTC
- Can mute yourself in a call - see Mute your microphone section
- Can change your ringtone - see Ringing device and ringing tone section
- There is a new confirmation pop-up when trying to refresh the page while a call is ongoing
- Added Plantronics Devices Actions (Windows only) which allows supported plantronics devices to answer, hangup or unhold calls with their associated button
Contact Center
- Can configure the XiVO CC to warn agents when its conversation is listened by a supervisor with a beep and/or a light on the phone - see Warn agent when spied.
XiVO PBX
- Unique Account feature with Device selection - see Unique Account
- New WebRTC and Unique Account line types: WebRTC and Unique Account users can easily be configured from User form
- WebRTC, Unique Account and Phone users can easily have there line type edited from User form
- New User Labels menu to be able to organize users in labels
- CSV Import/Export/Update:
- Labels:
- users are exported with their associated labels in CSV export - see User Import, Export and Update
- associating Users to User Labels can be done during CSV import/update - see User Import, Export and Update
- Line type:
- Managing Unique Account and webrtc lines via CSV import/export/update - see User Import, Export and Update
- Labels:
- Incoming calls with a customized destination now have the destination command displayed in the listing page
XDS
- Added a global subroutine that is called when a call goes from one MDS to another MDS - Subroutine
- Voicemail notification by email from MDS
- MDS upgrade script
System
All services can be accessed over https using the fingerboard
Asterisk VoIP WS is now protected by Xuc token validation (as it was already the case for Cti).
XiVO PBX/MDS/CC/UC: System updated to Debian 10 (Buster) (see Debian 10 (Buster) Upgrade Notes)
Updated the Electron framework to 8.5.2 (Desktop assistant)
XiVO CC/UC: Postgres upgraded to version 11
DAHDI-linux upgraded to version 3.1.0
Warning
See associated drivers and cards deprecations below.
API
- New
labels
confd API - see xivo-confd REST API changelog- to list User Labels
- to add User Labels
- to edit User Labels
- to delete User Labels
Behavior Changes¶
Assistants
- WebRTC: for WebRTC you must use a version of Chrome >= 73.0.3683.121
- UC Assistant
- Logout button was moved in the parameter (hamburger) menu - see Logout from UC Assistant
- CC Agent
- New display of agent history which is now like UC assistant, i.e. grouped when having multiple times the same caller/callee during the day
- (since Freya.08) 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).
- Switchboard
- New display of agent history which is now like UC assistant, i.e. grouped when having multiple times the same caller/callee during the day
- Call history displays now the first 100 result
XiVO PBX
- New Line Type: Phone, WebRTC, Unique Account, SCCP and Custom.
- The old SIP protocol is replaced by the new Phone line type
- New line types WebRTC and Unique Account are here to more easily create
- The line type SCCP and Custom are identical to old SCCP and * Custom* protocol.
- CSV Import/Export/Update:
- Managing of WebRTC lines via CSV import/export/update was changed - see User Import, Export and Update
System
- Security:
- HTTP access of ucassistant/ccagent/ccmanager/recording/spagobi/kibana redirects now by default to HTTPS version of the page.
- The fingerboard was moved from http: / to https: /fingerboard, as the web assistant is the root in https.
API
- WebRTC: SIP websocket
/ws
is no longer available. You must now use the/wssip
endpoint and it needs a valid xuc token (see xc_webrtc.init(name, ssl, websocketPort, token, remoteAudio, ip)).
Deprecations¶
This release deprecates:
LTS Polaris (2017.11): after 3 years of support this version is no longer supported. No bug fixes, no security update will be provided for this release.
Upgrade to DAHDI 3.1.0 drops the supports for the following drivers (and associated cards):
- Deprecated digital drivers and associated cards:
- wcte12xp driver:
- Digium TE120P: PCI single-port T1/E1/J1
- Digium TE121: PCI-Express single-port T1/E1/J1
- Digium TE122: PCI single-port T1/E1/J1
- wcte11xp driver
- Digium TE110P: PCI single-port T1/E1/J1
- wct1xxp
- Digium T100P: PCI single-port T1
- Digium E100P: PCI single-port E1
- tor2: Tormenta quad-span T1/E1 card from the Zapata Telephony project
- wcte12xp driver:
- Deprecated analog drivers and associated cards:
- Card Digium TDM800P/AEX800 (up to 8 analog ports) from driver wctdm24xxp
- Card Digium TDM410P/AEX410 (up to 4 analog ports) from driver wctdm24xxp
- wctdm driver for card Digium TDM400P (up to 4 analog ports)
- wcfxo driver for card X100P, similar and clones (A simple single-port FXO card)
- Other deprecated driver:
- pciradio: Zapata Telephony PCI Quad Radio Interface
See the List of supported DAHDI hardware.
- Deprecated digital drivers and associated cards:
API: SIP websocket
/ws
is no longer available. You must now use the/wssip
endpoint and it needs a valid xuc token (see xc_webrtc.init(name, ssl, websocketPort, token, remoteAudio, ip)).
Upgrade¶
Important
Upgrade to Freya will upgrade your system to Debian 10 (Buster). See Debian 10 (Buster) Upgrade Notes.
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:
Freya Bugfixes Versions¶
Components version table¶
Table listing the current version of the components.
Component | current ver. |
---|---|
XiVO | |
XiVO PBX | 2020.18.15 |
config_mgt | 2020.18.15 |
db | 2020.18.08 |
outcall | 2020.18.08 |
db_replic | 2020.18.00 |
nginx | 2020.18.02 |
webi | 2020.18.12 |
switchboard_reports | 2020.18.00 |
XiVO CC | |
elasticsearch | 7.3.1 |
kibana | 7.3.1 |
logstash | 2020.18.15 |
mattermost | 2020.18.00 |
nginx | 2020.18.03 |
pack-reporting | 2020.18.08 |
pgxivocc | 1.3 |
recording-rsync | 1.0 |
recording-server | 2020.18.13 |
spagobi | 2020.18.00 |
xivo-full-stats | 2020.18.13 |
xuc | 2020.18.14 |
xucmgt | 2020.18.15 |
Freya.15¶
Consult the Freya.15 Roadmap.
Components updated: config-mgt, logstash, xivo-agentd, xivo-config, xucmgt
Config mgt
- #4738 - CC Manager lags when (de)activating recording for all queues
Reporting
- #4754 - Upgrade logstash to 7.16.2
Switchboard
- #4646 - [C] Switchboard : unable to retrieve user id when attempted blind tranfers
Web Assistant
- #4175 - Fix login timeout parameter for CC Agent and switchboard
- #4314 - [C] - As a phone user with an ongoing call, when I quit/refresh the Web Assistant it hangup my ongoing call
- #4319 - [C] - CAS_LOGOUT_ENABLE does not work
XUC Server
- #4649 - [C] - User receives ACD calls while on pause when he is added to a new queue [Freya]
Freya.14¶
Consult the Freya.14 Roadmap.
Components updated: xivocc-installer, xucmgt, xucserver
Desktop Assistant
#4159 - [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
WebRTC
#4220 - WebRTC Unified Plan Support - Freya
Important
Behavior change WebRTC requires now Chrome version >= 73.0.3683.121.
WebRTC now uses so-called Unified Plan for SDP (instead of Plan-B).
Freya.13¶
Consult the Freya.13 Roadmap.
Components updated: recording-server, xivo-config, xivo-full-stats, xivocc-installer, xucmgt, xucserver
CCAgent
- #4073 - Switchboard (CC Agent) history is wrong for call received from/emitted towards MDS user
Desktop Assistant
#3978 - [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.
Switchboard
- #4112 - [C] - POPC - Park call : caller’s number takes the agent’s number
Web Assistant
- #4117 - Expose login timeout parameter for CC/UC web applications
Freya.12¶
Consult the Freya.12 Roadmap.
Components updated: config-mgt, xivo-web-interface, xucserver
Chat
- #4055 - Cannot send a message to a newly created user
XiVO PBX
- #4011 - [C] - Can’t customize user’s callerid anymore
Freya.11¶
Consult the Freya.11 Roadmap.
Components updated: sipml5-xivo-mirror, xivo-dao, xivo-utils, xivocc-installer, xucmgt, xucserver
Chat
- #3971 - [C] - Chat : the answer to a text message won’t be received
Recording
- #4017 - Received calls missing in call history due to lowercase cel events
Switchboard
- #3977 - New message badge is sometimes missing for unread messages on logging
WebRTC
- #4008 - [C] - User with special characters in name can’t call a WebRTC user
XiVO PBX
Freya.10¶
Consult the Freya.10 Roadmap.
Components updated: xivo-web-interface, xivocc-installer, xucmgt
Switchboard
#3930 - Unable to hangup ringing call after re-logging for webrtc agent
Important
Behavior change The calls are not displayed when you come back, for they have been hanged up correctly.
XiVO PBX
- #3950 - UA - Editing user, selection Web RTC prior to Unique Account for line type breaks link between device & user
- #3980 - XiVO installation warnings about missing XIVO_UUID
XiVOCC Infra
- #3958 - [Doc] Provide HTTPS URL instead of http/xucmgt ip/port based ones fot Desktop Application
Freya.09¶
Consult the Freya.09 Roadmap.
Components updated: xucmgt, xucserver
WebRTC
- #3925 - [C] - Video of called party is seen before he answers
Freya.08¶
Consult the Freya.08 Roadmap.
Components updated: pack-reporting, recording-server, xivo-db, xivo-lib-python, xivo-monitoring, xivo-outcall, xivo-web-interface, xivocc-installer, xucmgt, xucserver, xivo
CCAgent
- #3838 - CC agent Ringtone choice is displayed even if we don’t have webrtc line
- #3926 - Agent unable to mute himself while in conference
- #3928 - Display issue when receiving call from external number in CCAgent
Chat
- #3359 - Call button in conversation disappears when sending first message
- #3382 - Badge with number of unread messages does not appear after login
- #3523 - UC Assistant - new messages don’t show after reload
- #3620 - Chat Refactor - 1 - ConversationController & XucDirectory
- #3621 - Chat Refactor - 2 - Call Remote Party directive & XucDirectory related function
- #3622 - Chat Refactor - 3 - Xuc API
- #3631 - Chat Refactor 4 - Display conversation directive and related XucChat functions
- #3644 - Chat Refactor 5 - sendMessage directive and XucChat related functions
- #3787 - Chat Refactor 6 - Display conversation history directive and controller view
- #3788 - Chat Refactor 7 - New message Badge notification
- #3789 - Chat Refactor 8 - CLeaning and removal of old implementation
Desktop Assistant
- #3804 - [C] - UC Assistant - callto tag with E164 numbers fails
- #3905 - Electron squirrel build issue
GCU
- #3861 - GCU - Can’t create freshly installed XiVO Freya
Recording
- #3709 - [C] - Recording server - purge don’t work when high number of file
- #3739 - As a recording user I want to be able to search a recording with part of the number
- #3832 - [C] - Recorded files are not seekable under Chrome browser
- #3854 - Purge date is wrong in logs
Reporting
#3746 - stats - hangup_time for an incoming call to a queue transferred to another queue is sometime missing in call_on_queue
#3806 - [C] - Lots of agent history request can load the reporting server
Important
Behavior change 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)
Web Assistant
#3199 - [C] - Forbid directory lookup with no value
Important
Behavior change When searching for a contact, the search has to be at least two characters
#3695 - Add the possibility to hide download Windows/Linux on UC Assistant/CCAgent
#3841 - Desktop assistant links are no more displayed
#3862 - Duplicate number on outgoing call
#3887 - Kerberos - authentication after standby or change of networks (cable / wifi)
XUC Server
- #3679 - Cannot use Cti.dial
XiVO PBX
#3669 - Outcall don’t keep “Internal” on upgrade
#3685 - As XiVO admin of entity B I see users of entity A in users list
#3687 - [C] - Outcall - nb of connection to the database
#3742 - Wizard error when domain begin by a number
Important
Behavior change Wizard is less strict on domain name check: particularly it now accepts a digit as the first letter of a domain part.
#3748 - Asterisk codec graphic doesn’t work anymore
#3829 - [C] - UA users are not listed in the function key menu
#3831 - [C] - UA users are not listed in the Call permission menu
#3876 - Fix jitter buffer implementation mis-spelling to be able to configure it as adaptive
Freya.07¶
Consult the Freya.07 Roadmap.
Components updated:
GCU
- #3912 - [GCU] Add “Delete message after notification” to voicemail template
- #3913 - [GCU] Force lower case in username input field to avoid discrepencies with XiVO
- #3914 - [GCU] Enhance error when duplicate username is submitted in form
- #3915 - [GCU] Forbid Webrtc user creation without credentials
- #3918 - [GCU] Allow to set empty credentials on cti login and pawwsord for SIP devices
- #3919 - [GCU] Missing error displayed when deleting non empty template
Freya.06¶
Consult the Freya.06 Roadmap.
Components updated: GCU
GCU
- #3765 - [C] - [GCU] Mode not routed should not be available anymore
- #3766 - [GCU] - Remove not routed mode [backend]
- #3767 - [GCU] - Remove not routed mode [frontend]
- #3768 - [C] - [GCU] Be able to select MDS when creating an entity
- #3769 - [GCU] - Add MDS select menu to the entity page [backend]
- #3770 - [GCU] - Add MDS select menu to the entity page [frontend]
- #3771 - [C] - [GCU] Be able to select WebRTC and UA as peer type in template
- #3772 - [GCU] - Add WebRTC and UA as peer type in the template [backend]
- #3773 - [GCU] - Add WebRTC and UA as peer type in the template [frontend]
- #3774 - [C] - [GCU] User creation page
- #3775 - [C] - [GCU] Be able to type a number with validation on user creation page
- #3776 - [GCU] Be able to type a number with validation on user creation page [frontend]
- #3777 - [GCU] Be able to type a number with validation on user creation page [backend]
- #3778 - [C] - [GCU] Be able to display user creation details and status
- #3779 - [GCU] Be able to display user creation details and status [frontend]
- #3808 - [GCU] - Add auth token to webservice request to configmgt
- #3836 - [GCU] Change nullable column in template table to not null
- #3858 - GCU - Can’t add a XiVO Freya
- #3859 - [GCU] Voice to mail is not disabled when voicemail is not checked
- #3860 - [GCU] Warn administrator that number, manually typed, in user creation can be unavailable
- #3863 - GCU - Timeout on gateway when adding XiVO
- #3864 - [GCU] Update dialplan to be compatible with Freya
Freya.04¶
Consult the Freya.04 Roadmap.
Components updated: xivo-config, xivo-web-interface
XiVO PBX
- #3639 - Queue exit context can’t be set if there is no Service type of context
- #3645 - [C] - Order function key listing in user form list
- #3667 - [Wizard] Default configuration for France creates outcall routes with context “to-extern”
- #3677 - Web interface - Protocol Type - Missing “n” to “Personalisé”
- #3706 - [C] - Updating the line template breaks the provd config (it removes the sip line info from the configs)
Freya.03¶
Consult the Freya.03 Roadmap.
Components updated: xivo-db, xivo-monitoring, xivo-web-interface, xivocc-installer, xivoxc-nginx, xucmgt
CCAgent
- #3574 - Customer call history does not disappear everytime
Desktop Assistant
- #3461 - Desktop Application callto and global shortcut key does not work until refreshing
Web Assistant
- #3483 - Presence is not seen unless user has a voicemail or connects to assistant
- #3602 - UC Assistant displays conference call when I click on voicemail button while in call
WebRTC
#3581 - Nginx proxy timeout should be decreased on SIP and CTI websockets
Important
Behavior change Proxy connection, read and send timeout on the XiVO CC nginx were updated. You need to update the XiVO CC nginx configuration for WebRTC on MDS if you had already followed the Enable WebRTC on MDS.
If so, change in file
/etc/docker/nginx/sip_proxy/sip_proxy.conf
:- the
proxy_connect_timeout
from 60m to 1m - the
proxy_read_timeout
from 60m to 5m - the
proxy_send_timeout
from 60m to 5m
- the
XiVO PBX
#3319 - Voicemail delete old messages in Deleted directories
Important
Behavior change Maximum number of deleted voicemail messages was set to 10. The original value will be printed in database log - you can search for “MIGRATE_BACKUPDELETED”. If there is more than 10 messages in the “Deleted” folder, the number of rotated messages will not be decreased.
#3567 - Munin graphics not generated on newly installed XiVO
#3612 - Given I edit user’s line type from Phone/UA to WebRTC, then the device selection should not be possible
Freya.02¶
Consult the Freya.02 Roadmap.
Components updated: config-mgt, xivo-auth, xivo-config, xivo-service, xivo-upgrade, xivo-web-interface, xivo-webi-nginx, xivocc-installer, xucmgt, xucserver
Config mgt
- #3551 - [UA] - Device choice - Persistence after xuc restart - Config Mgt
- #3557 - SCCP - Provisioning of a SCCP line on SCCP device from webi does not work
Desktop Assistant
- #3578 - WebRTC peer with ringing call is not unregistered when user exits its desktop assistant
- #3590 - Problème de CSS sur la nouvelle page Gestion d’Appels du DA en Freya
- #3594 - Language difference between desktop and web assistant
WebRTC
- #3563 - Web RTC - Define a new default sessionlimit for http.conf for new WebRTC based installations
- #3571 - WebRTC doesn’t work with UC Addon
XUC Server
- #3552 - [UA] - Device choice - Persistence after xuc restart - XUC
- #3576 - RabbitMQ connection is not retried if failed at xuc startup
XiVO PBX
#3499 - [UA] - Device choice - As a UA user I want that my device choice survive a xuc restart
Important
Behavior change Unique account latest device selected is now persisted to database. It will be restored upon xucserver restart.
#3535 - XDS - Document how to reset an mds (after installation cancellation or after a while)
#3555 - Missing provisioning number when editing a user
#3558 - Given I select WebRTC line type, then the device selection should not be possible
#3566 - As an admin user I want to be able to change the line type between phone / ua / webrtc
Important
Behavior change Now, an admin user can change a created user’s line type between Phone, WebRTC and Unique account.
#3570 - Changing the context of a user having an extension already used in context does not throw error
#3573 - Unable to add a new user to a queue or a group while creating it
#3579 - UCAddon - Upgrade procedure is incomplete
#3580 - Clean some uneeded calls during clean install
#3583 - User form and users list small glitches
#3605 - XDS - XiVO services are started by monit on mds after stopping all
Freya.00¶
Note
LTS Release. New features and behavior changes are listed above under the Freya (2020.18) section.
Consult the Freya (2020.08) Roadmap.
Components updated: config-mgt, xivo-auth, xivo-confd, xivo-dao, xivo-db, xivo-dist, xivo-web-interface, xivocc-installer, xivoxc-nginx, xucmgt, xucserver
Config mgt
- #3534 - Dynamic filter - Rename operator in to contains_all
- #3539 - [UA] - Line management - API - I want to be able to Update a line for a user
- #3548 - [UA] - Line management - API - Update provd line when creating/editing/deleting user line
Desktop Assistant
- #3553 - Missing tray icon after lock screen on linux
Fingerboard
#3538 - global nginx redirect to 443 from 80
Important
Behavior change HTTP access redirects now by default to HTTPS version of the page.
The fingerboard was moved from http: / to https: /fingerboard, as the web assistant is the root in https.
Security
- #3498 - [S] Remove useless exposed elasticsearch ports
Web Assistant
- #1943 - Remove answer button on second incoming call
WebRTC
- #3480 - Securing SIP Websocket
XiVO PBX
- #2965 - XDS - Reinstalling an MDS requires database replication to be reset manually at XiVO Main db side
- #3501 - [UA] - Line management - As a XiVO Admin I want to be able to select the UA mode from the Line menu
- #3503 - UA - I shouldn’t be able to link a UA account with a group/queue/agent/bossfilter
- #3528 - [UA] - Line management - FRONT END As a XiVO Admin I want to be able to select the UA mode from the Line menu
- #3532 - UA - remove UA users from users’ listing in group/queue/agent menu
- #3536 - [UA] - Line management - As a XiVO Admin I want to be able to see new protocols in user listing
- #3540 - [UA] - Line management - As a XiVO Admin I can associate a line to a device already provisioned
- #3541 - [UA] - Line management - As a XiVO Admin I can delete users from the user list menu
- #3547 - [UA] - Device choice - Persistence after xuc restart - Database
- #3549 - Display Custom command on Incall view
- #3556 - Set apt sources correctly for future LTS with xivo-dist