Appendix A: Release Notes

Version 22.10-0

October 4, 2022

Improved

  • The Strip Country Code setting was unused and therefore has been removed.

Fixed

  • There was a 404 Not Found error message if criteria matched a nested call plan rule.

  • Modifying existing call plans was sometimes unsuccessful.

  • There were issues with archiving subscribers with associated call plans.

  • Routes were not always saved properly, resulting in failed calls.

Known Issues

  • Routing Engine settings may not be updated until the restart-tomcat-instance icr command is run on the NIU.

Upgrade Procedure Notes

  • After upgrade installation, you will need to do the following:

    1. Run the following command on both NIUs:

    clear-web-cache icr

    1. Restart icr.xml in Console on each AS.

    2. Restart Platform on each AS.

    3. Restart Tomcat.

Version 22.9-0

September 12, 2022

Fixed

  • When a service provider was restored, archived, or purged, any associated labels were not also restored, archived, or purged.

  • When a subscriber was restored, archived, or purged, any associated call plans were not also restored, archived, or purged.

  • An INVITE containing multiple Diversion headers resulted in failed calls.

  • There was an issue with initialization retries.

Known Issues

  • Routing Engine settings may not be updated until the restart-tomcat-instance icr command is run on the NIU.

Upgrade Procedure Notes

  • After upgrade installation, you will need to do the following:

    1. Run the following command on both NIUs:

    clear-web-cache icr

    1. Restart icr.xml in Console on each AS.

    2. Restart Platform on each AS.

    3. Restart Tomcat.

Version 22.6-0

June 3, 2022

Improved

  • Additional application logging for errors during initialization has been added to the xpress.log.

Fixed

  • By default, the cron task xpressworkx-cdr-cleanup-database icr ran on both the primary and secondary NIU every night, resulting in errors on the standby NIU. To prevent these errors, this cron task is now run on the active NIU only.

  • When a subscriber was restored, any associated call plans were not also restored.

  • A Service Provider with custom audio could not be restored.

  • If an archived record had the same name as another active or archived record, it could not be restored.

  • There was a javascript error that prevented the egress route setting from being applied.

Known Issue

  • Routing Engine settings may not be updated until the restart-tomcat-instance icr command is run on the NIU.

Upgrade Procedure Notes

  • After upgrade installation, you will need to do the following:

    1. Run the following command on both NIUs:

    clear-web-cache icr

    1. Restart icr.xml in Console on each AS.

    2. Restart Platform on each AS.

    3. Restart Tomcat.

    4. Audit Calling Number Source configuration due to automated conversion of number normalization settings from versions earlier than 21.6-0.

    5. Configure rsyslog for TCP reception for application logging.

Version 21.10-0

October 14, 2021

Fixed

  • Sometimes, the temporary postgres database did not stop during an application install, resulting in the Service Delivery Platform on the secondary NIU not starting.

  • All destinations in a route advance list in a call plan were incorrectly sent to the first destination listed.

  • A subscriber or service provider with an associated number could not be restored.

  • When a service provider was archived, any associated labels were not also archived.

Known Issue

  • Routing Engine settings may not be updated until the restart-tomcat-instance icr command is run on the NIU.

Upgrade Procedure Notes

  • After upgrade installation, you will need to do the following:

    1. Run the following command on both NIUs:

    clear-web-cache icr

    1. Restart icr.xml in Console on each AS.

    2. Restart Tomcat.

Version 21.7-0

July 21, 2021

Improved

  • AS settings updates should now complete more quickly.

Fixed

  • The additional_data entry in route CDRs was not correctly populated. The URI that was identified as the calling source is now called Calling_URI in the additional_data entry.

  • The previous implementation for number normalization is now disabled on any API call that sets calling number extraction using a number extract configuration.

  • Changes to Called Source settings in the web UI had to be saved twice to apply to every AS.

  • The Routing Engine routeables table was never purged from the routing_engine_archive.

  • Call plans, Service Providers, and Subscribers could not be archived using the web UI.

Known Issue

  • Routing Engine settings may not be updated until the restart-tomcat-instance icr command is run on the NIU.

Upgrade Procedure Notes

  • After upgrade installation, you will need to do the following:

    1. Run the following command on both NIUs:

    clear-web-cache icr

    1. Restart icr.xml in Console on each AS.

    2. Restart Tomcat.

Version 21.6-1

June 29, 2021

Fixed

  • Updated internal components to address issues with cron tasks.

  • Settings could not be saved when Use Contact Header was enabled.

  • A Calling Source was not processed when no P-Asserted-Identity existed.

  • The egress route template in a call plan incorrectly used the contact header.

  • With a menu call plan containing route advance, calls would incorrectly terminate if the first destination did not connect.

Upgrade Procedure Notes

  • After upgrade installation, you will need to do the following:

    1. Run the following command on both NIUs:

    clear-web-cache icr

    1. Restart icr.xml in Console on each AS.

Version 21.6-0

June 9, 2021

New

  • Support for configuration of Calling Sources.

  • Both Calling Sources and Called Sources support a new post-processing parse_cc​ rule. This new rule examines the remaining digits for a leading plus (+), and then removes it along with the country code from the digit string.

  • Support for app-based Number Extract implementation.

Improved

  • General improvements to the web UI for consistency of information.

  • There is now a “Reset to Default” option for both Calling Sources and Called Sources.

Fixed

  • WARNING messages for undefined values were being generated in the log for every call.

  • On the Settings page, it was unclear which check box would enable or disable each custom criteria type.

  • Time-of-day rules would always perform matching based on the system time zone instead of the specified time zone for the rule.

  • Purging a Service Provider account did not also purge the numbers and call plans owned by that account.

  • Call routing was timing out and calls were unable to connect.

  • Holiday/Event rule start time and end time were incorrectly displaying seconds in the timestamp.

  • With an INVITE including visual separators, the separators were not stripped from the extracted called number.

  • After changing settings multiple times, the web UI no longer worked properly.

  • There was an error with loading Called Source post-processing rules on the Settings page.

Upgrade Procedure Notes

  • After upgrade installation, you will need to do the following:

    1. Run the following command on both NIUs:

    clear-web-cache icr

    1. Restart Platform on each AS.

    2. Restart Tomcat.

Version 20.11-1

November 5, 2020

Improved

  • General improvements to the web UI for Called Number Source configuration.

Known Issue

  • Restarting Tomcat on the NIU is necessary to apply new settings.

Upgrade Procedure Notes

  • After upgrade installation, you will need to do the following:

    1. Run the following command on both NIUs:

    clear-web-cache icr

    1. Restart icr.xml in Console on each AS.

Version 20.10-3

November 3, 2020

New

  • Number normalization configuration can now be done through the web UI using the new Called Number Source settings.

Known Issue

  • Restarting Tomcat on the NIU is necessary to apply new settings.

Upgrade Procedure Notes

  • After upgrade installation, you will need to do the following:

    1. Run the following command on both NIUs:

    clear-web-cache icr

    1. Restart Platform on each AS.

Version 20.10-2

October 28, 2020

New

  • Initial implementation of number normalization configuration. This configuration can be done only by using database commands.

Fixed

  • Changes to certain settings required ICR to be restarted. Now, the settings cache on the AS is properly cleared and restarts are no longer needed.

Known Issue

  • Restarting Tomcat on the NIU is necessary to apply new settings.

Upgrade Procedure Notes

  • After upgrade installation, you will need to do the following:

    1. Run the following command on both NIUs:

    clear-web-cache icr

    1. Restart icr.xml in Console on each AS.

Version 20.10-1

October 14, 2020

Fixed

  • Routing Engine did not check for validity of P-Asserted-Identity in caller number processing.

  • The start and end times for the Holiday/Event Rule did not load correctly in the web UI.

Upgrade Procedure Notes

  • After upgrade installation, you will need to do the following:

    1. Run the following command on both NIUs:

    clear-web-cache icr

    1. Restart icr.xml in Console on each AS.

Version 20.7-1

July 7, 2020

New

  • Detection for corrupt python-virtualenv installation, resulting in an automatic fix in an online installation or an error message output in an offline installation.

Improved

  • Automatically re-replication to improve behavior when the replication slot is missing.

Note

xpressworkx_data_services must be restarted to see this change.

  • Global yum cache is no longer updated during install.

  • Installation tasks have been streamlined.

Version 20.5-3

May 19, 2020

New

  • Initial implementation of number normalization callflow.

Upgrade Procedure Notes

  • After upgrade installation, you will need to do the following:

    1. Run the following command on both NIUs:

    clear-web-cache icr

    1. Restart Platform on each AS.

Version 20.5-2

Fixed

  • Database was not replicating after upgrading from ICR 2.2-14 to ICR 20.4-1.

  • There were issues with certain yum repositories, which were addressed by an internal database component upgrade.

Upgrade Procedure Notes

Note

This release includes an upgrade to xpressworkx_data_services, which will not be reverted if an application is downgraded.

Version 20.5-1

May 5, 2020

Improved

  • Route performance with HTTPS enabled.

Known Issue

  • The installer runs the command yum -y reinstall python-virtualenv. Do the following:

  1. Ensure this command runs without error before starting the install.

  2. For an online install, install the latest version from the repository.

  3. For an offline install, create an offline repository.
    • Place the package python-virtualenv in /root/rpm_dependencies.

    • Create repo /root/rpm_dependencies/.

    • Create a file with the following contents:

      [dependencies] name=Local Dependencies baseurl=file:///root/rpm_dependencies gpgcheck=0 enabled=1

  4. Run the command yum clean all.

Upgrade Procedure Notes

Note

This release includes an upgrade to xpressworkx_data_services, which will not be reverted if an application is downgraded.

  • After upgrade installation, you will need to restart icr.xml in Console on each AS.

Version 20.4-1

April 14, 2020

Dependencies

  • Ansible must be version 2.4 or later.

  • XpressWorkx Application Manager must be version 1.4.0 or later.

  • Manually installing python-requests with yum is not required.

New

  • Added indices to the rating engine to improve performance.

Improved

  • Cleaned up unused replication slots that were left after DBC 2.x was installed.

  • Numbers and routes with wildcard digits can now be edited.

Fixed

  • B2BUA reINVITEs were addressing to the far end instead of the near end.

  • Fix for configure-ssl on fresh installs.

Upgrade Procedure Notes

Note

This release includes an upgrade to xpressworkx_data_services, which will not be reverted if an application is downgraded.

  1. On each NIU, update ps_master_config.xml to add or change the following lines to the xpressworkx_data_services process:

  • run-as=”postgres”

  • wait-to-start-=”120”

  1. On each AS, update ps_master_config.xml to add the following line to ps_httpd and ps_eventdispatcher processes:

  • wait-to-start=”10”

  1. Restart each NIU.

  2. Run configure-ssl icr.

  3. Restart each AS.

  4. Run clear-web-cache-icr.

Version 20.3-0

March 5, 2020

Fixed

  • In version 2.2-19, the install did not complete without passwordless SSH on the secondary NIU.

  • When closing and reopening a call plan, the audio prompts for “nine” and “ten” were changed to the incorrect audio.

Version 20.3-0

March 3, 2020

New

  • The Routing Engine supports templated SIP URI fields.

Fixed

  • After a failover, the secondary NIU failed update to routing_engine.periodic.

  • Some of the rebranding in the web IU had been reverted.

Version 20.2-2

February 7, 2020

New

  • Numbers archived before this release need to be resaved after being restored.

Fixed

  • The CSV Retention Time setting did not remove any files when it was configured to do so.

  • Calls did not connect after restoring the Subscriber, call plan, number, and route.

  • Service Provider Override did not override the Help setting or the Minimum Password Length setting.

Version 20.2-1

February 5, 2020

New

  • When restoring a Subscriber, each call plan, number, and route table entry must be restored separately.

Fixed

  • Archiving a Subscriber did not archive all the routing engine objects (call plans, etc.).

Version 20.1-3

January 29, 2020

Fixed

  • There where instances of package conflicts in the web UI component caused by a change to install virtualenv with yum instead of PIP. To fix this issue, the web UI component reverts this change.

Version 20.1-2

January 28, 2020

New

  • The requests Python package is required to be installed before running the installer.

Fixed

  • The Cron job run_cdr_archive is no longer installed. On existing installs, customers should remove this Cron job manually.

Version 20.1-1

January 24, 2020

Fixed

  • The routing prefix was not added to the destination number.

  • The Cron job icr-clear-expired jobs failed on the secondary NIU.

  • There were character encoding issues, which were fixed by a patch to RESTWorkX.

Version 19.12-3

December 20, 2019

Improved

  • Miscellaneous SSL improvements to the web UI component.

Fixed

  • There were issues with the web UI component regarding rebranding in the previous release.

  • There were items on the Settings page that did not work as expected. To fix this issue, constraints were implemented on Routing Table entries.

  • Deprecated PACs were used in the Routing Engine proxy flow.

  • There were references to old Routing Engine CDRs. These references were removed, and the Cron job now rotates CDRs properly.

Version 19.12-2

December 13, 2019

New

  • The app was rebranded with Evolve colors and logo.

Improved

  • SSL Configuration performs additional testing to ensure proper functionality and cleanup.

  • Custom Criteria can now be turned off. Previously, they were on by default and could not be turned off.

  • Route priority is always highlighted as necessary.

Fixed

  • PIP install no longer populates the global Python.

  • An Administrator with a single permission no longer shows as having View Only access.

Version 19.12-1

December 8, 2019

New

  • A new product numbering scheme was implemented.

  • The web UI was rebranded to Evolve colors.

Improved

  • The Database component has been modified to use fetch/copy tasks to sync the dbconfig files during install instead of synchronize tasks, which placed the files in the incorrect location.

  • ICR, the Database component, and the web UI component were all modified to enable/disable the database during install as needed.

Fixed

  • Routing Engine did not properly extract the calling number if ‘user=phone’ was not present in the calling URI.

  • The sudoers file was symlinked rather than copied, preventing audio manager uploads from working properly.

  • There was a typo in the CDR Materialized View script, causing it to not work properly if the Platform was not already running.

Version 2.2-25

November 25, 2019

Fixed

  • In some cases, the installation process would fail to complete. This was fixed by changes to ICR, the Database component, and the web UI to make the installer wait for postgres to close before continuing.

Version 2.2-24

November 25, 2019

Improved

  • Wrapped icr-db-init Ansible role in tasks to ensure the database is running correctly and turned it back off afterwards.

Fixed

  • In the Database component, the empty preun block was removed from xpressworkx-web-services spec so that it can be upgraded and uninstalled properly.

  • In the Routing Engine, the number piece (the longest contiguous string of digits, *, or #, with an optional leading +) of the called number in the SIP message was not parsed correctly.

Version 2.2-23

November 20, 2019

Fixed

  • setuptools install no longer populates the global Python.

  • There was a typo on the Settings page (avlue -> value).

  • There were the following issues with xpressworkx-data-services:
    • pg_hba.conf and postgresql.conf templates were incorrectly overwritten by new installs.

    • templating pg_hba.conf did not work with both previous and current versions of the template.

Version 2.2-22

November 19, 2019

New

  • Added a new database component that takes advantage of the High Availability (HA) improvements in Platform 4.5.35 or later.

  • Added a new web UI component that improves robustness of configure-ssl.

Note

configure-ssl is no longer run with the app name as an argument. After upgrade, configure-ssl is only required to run when certificates are updated.

Improved

  • Audio files now sync immediately after an upload, and only changed files are synced.

Version 2.2-191

February 16, 2020

Fixed

  • This release is identical to 2.2-19 except it includes a backported fix to remove a bad migration which broke fresh installs.