Appendix A: Release Notes

Version 20.8-1

August 5, 2020

Fixed

  • Accounts would expire even when set to No Expiration directly or via the product offering.

Upgrade Procedure Notes

  • After upgrade installation, you will need to run the following command on both NIUs:

    clear-web-cache cc

Note

This release includes an upgrade to xpressworkx_cdr_services, which must be restarted.

Version 20.7-2

July 22, 2020

Upgrade Procedure Notes

Note

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

Version 20.7-1

July 15, 2020

Improved

  • Upgraded the Database Access Component to version 2.0.20, the Web UI Component to version 1.10.36, and CDR Service to version 1.6.8.

  • To clean up any stuck sessions that may occur, the maximum time in a menu or time before a call is answered was set to 8 hours.

Fixed

  • Expiration cron task was unnecessarily updating all accounts.

  • Changing settings left active sessions.

Upgrade Procedure Notes

  • After upgrade installation, you will need to run the following command on both NIUs:

    clear-web-cache cc

Version 20.2-3

February 21, 2020

  • The If No Subrates Exist setting of Block Event resulted in calls briefly connecting before being blocked.

Version 20.2-2

February 17, 2020

Improved

  • Improvements to CSV file management, including a CSV Retention Time setting and a cc-clear-expired-jobs script to remove old files and jobs.

Fixed

  • String arguments were not decoded before maximum length validation, resulting in errors.

  • The Maximum Transfer PIN Retry Attempts setting did not work properly and was removed.

Version 20.2-1

February 3, 2020

Fixed

  • Some tasks were not running properly on the secondary NIU causing install time to greatly increase.

  • The If No Subrate Exist setting of Apply No Rate did not allow calls to connect.

  • Balance transferring did not work properly in the web UI.

  • Custom audio files were deleted after an upgrade.

Version 20.1-3

January 24, 2020

Fixed

  • Disabling a promotional period in a calling service did not disable the discount and it was still applied.

Version 20.1-2

January 23, 2020

Dependencies

  • Ansible must be version 2.4 or later.

Fixed

  • Creating a rate, account, or product offering with an expiration date and creating a calling service with promotion dates did not work properly. To address this issue, time of day information was omitted from dates.

  • A fresh installation failed on the task web-ui-db-init : Run init script(s).

  • Rates that include a rate plan modifier do not charge the modified rate.

  • Neither standard nor extended bong charges were applied to rates.

  • Connection fees were not being added to call rates.

  • The cc-sync-audio command did not run successfully. As a result, new custom audio files never synced.

Version 20.1-1

January 10, 2020

New

  • Rebranded the web UI to reflect Evolve branding.

Improved

  • Upgraded the Rating Engine to version 1.4.21, which includes single reservation and library changes for improved performance.

Fixed

  • When a caller cancels an INVITE, the CANCEL is not processed and the session is left active.

  • A Service Provider could be created without a display name, which is a required value.

  • Changes to a Subscriber account were not always saved.

  • Session.Maximum returned the incorrect maximum call length.

  • The rating engine failed when evaluating maximum call duration during call session initialization. The caller would hear an insufficient funds prompt and the call did not connect.

Version 1.7-12

November 11, 2019

Fixed

  • A call made with fast track to skip the IVR showed no rating information.

Version 1.7-11

October 31, 2019

Fixed

  • Addressed known issue poor performance on long calls in previous release.

  • If a rate was edited during a call, applied charges were not properly tracked.

Version 1.7-10

October 30, 2019

Fixed

  • The balance sent in RADIUS accounting update was incorrect because recurring charges were not tracked in the database and were being applied on every rate call.

Known Issue

  • The fix in this release could cause poor performance on long calls.

Version 1.7-9

October 28, 2019

Fixed

  • Accounting Stop message contains a balance of $0 instead of the balance used during the call. To address this issue, there is now an option for the balance to be returned when a call is completed.

Version 1.7-8

October 25, 2019

Fixed

  • With UCard calls, rateCall returned an incorrect balance. To address this issue, the balance is now received from the database.

Version 1.7-7

October 23, 2019

Fixed

  • Importing of rates, rate plans, calling services, and product offerings was unsuccessful.

Version 1.7-6

October 8, 2019

Fixed

  • Calls were connecting but not appearing in the card history and CDR did not contain a rate.

  • On a clustered pair system, a fresh installation failed on the task cc-webserver : create CDR Materialized View on the secondary NIU.

  • Not all bong rates were being charged correctly.

Version 1.7-5

October 3, 2019

Fixed

  • The SSL configuration script did not work properly. To address this issue, the Web UI Component was upgraded to version 1.10.22.

Version 1.7-4

October 2, 2019

Fixed

  • Changes made to product offerings and calling service were not saved. To address this issue, the previous version of auth-component had to be used.

Version 1.7-3

October 1, 2019

Improved

  • Upgraded CDR Service to version 1.6.7 and the Web UI Component to version 1.10.20 for general improvements.

Version 1.7-2

October 1, 2019

Fixed

  • Adding a rate in the web UI and API was unsuccessful and resulted in an error message.

Version 1.7-0

July 19, 2019

Fixed

  • The prompt to enter the PIN continued to play even after the maximum attempt limit was reached and the account should have been locked out.

Version 1.6-28

July 19, 2019

  • This release is identical to 1.6-27 but built using RESTWorkX 2.8.22 instead of 2.8.23.

Version 1.6-27

July 12, 2019

Fixed

  • When creating or importing calling services and product offerings, associated data would be lost.

Version 1.6-26

July 9, 2019

New

  • Added a Login Behavior field to Platform Owner settings. This option will enabled or disable bypassing the requirement to re-enter account numbers after a failed PIN entry when logging in.

Fixed

  • Extended Bong Rate did not show the correct value for number of bong charges.

  • Prompts in one-step dialing IVR menu had unclear instructions.

  • Accessing a menu option from a different access number resulted in a system error.

  • The lockout setting with hours would unlock too soon due to differing time zones. Accounts are now unlocked based on database time instead of system time.

  • The Maximum IVR PIN Retry Attempts and Maximum Transfer PIN Retry Attempts fields could not be set to less than the default values. Accepted ranges for these fields are now clearly indicated.

Version 1.6-25

May 28, 2019

Improved

  • Upgraded Database Access Component to version 1.1.8, which no longer overwrites all configuration files on every installation.

Version 1.6-24

May 22, 2019

Improved

  • Improvements to functionality of account page when viewing and sorting without search parameters.

Version 1.6-23

May 20, 2019

  • Upgrading from 1.6-20 did not work if the pg_tgrm extension was already created.

Version 1.6-22

May 20, 2019

Fixed

  • There was an issue with balance transfer through the web UI with a large number of accounts.

Version 1.6-21

May 14, 2019

Improved

  • All operations on a product offering or calling service are now done as a job to provide status and error reporting.

  • Upgraded CDR Service to version 1.6.5.

  • Upgraded RESTWorkX to version 2.8.22.

Fixed

  • There were issues with CDR syncing and exporting.

  • Changes to an existing access number were not saved.

Version 1.6-20

May 8, 2019

Improved

  • Improvements to account search performance and load time of page.

  • Decreased time before first prompt is played for IVR.

  • When an existing product offering or calling service is saved, a job will appear in the jobs table when changes have completed saving.

  • Upgraded RESTWorkX to version 2.8.19.

Version 1.6-19

May 3, 2019

Fixed

  • The cc-sync-audio command produced an error. As a result, new custom audio files never synced.

  • With Expiration Sweep enabled, accounts did not expire when they should have.

Version 1.6-18

April 26, 2019

Improved

  • Improved account filtering and sorting functionality.

  • Upgraded the Rating Engine to version 1.4.3.

  • Upgraded the Static Web Component to version 1.11.29.

Fixed

  • Card history entries would disappear after hitting refreshing the page.

  • Accounts did not always expire in extremely large databases.

  • Periodic Weekly Recharge did not always recharge the account correctly.

  • Filtering the CDR table by Start Time resulted in an error message.

Version 1.6-17

April 17, 2019

Improved

  • The following improvements were made to bulk importing:
    • A CSV file is uploaded directly to the server.

    • Decreased time to import large files.

    • The ability to edit a table for import is retained for non-CSV imports. For CSV imports, the first 10 accounts are shown but not editable.

  • Upgraded RESTWorkX to version 2.8.16.

Fixed

  • A single call would generate more than one CDR entry.

  • Edits to View Only administrator user permission did not show in the web UI.

Version 1.6-16

April 12, 2019

Improved

  • The following improvements were made to bulk importing:
    • If more than 100 accounts are imported, only the first 100 are shown.

    • There is no longer a separate postgres connection for each account that is imported.

  • Upgraded RESTWorkX to version 2.8.15.

Fixed

  • Card history did not always update correctly.

  • Edits to administrator user permissions did not show in the web UI.

Version 1.6-15

April 9, 2019

Improved

  • General improvements to display and sorting of CDR table.

  • General improvements to exporting.

  • The balance and currency type can now be set for accounts when bulk provisioning.

Fixed

  • The Last Modified and Last Modified By fields did not always update after certain changes were made and saved.

  • There were issues with handling SDP reINVITEs.

  • Creating an administrator user in the web UI did not submit data to API, so user was not actually created.

  • Funds could not be transferred after reaching insufficient funds.

Version 1.6-11

November 12, 2018

Fixed

  • There was an issue with Balance Sweep expiration.

  • Weekly Postpaid Periodic Balance recharged the incorrect amount.

  • The Days From First Use expiration type did not work properly.

Version 1.6-10

November 12, 2018

Fixed

  • The EvaluateExpiration command did not work.

  • With Balance Extension set, the insufficient funds prompt was incorrectly played when an account reached its minimum balance.

Version 1.6-9

November 9, 2018

Fixed

  • Current account balances displayed in the web UI was not rounded to the nearest hundredth.

Version 1.6-8

November 7, 2018

Improved

  • General improvements to cron tasks created during installation.

Fixed

  • The Require PIN When Authenticated setting in the web UI did not correlate correctly to the same setting in IVR.

  • The event timestamp and rate call time were not the same in CDRs.

Version 1.6-7

November 5, 2018

Fixed

  • A fixed expiration for a product offering was not applied to the account or displayed in the Expiration Date column on the account page. This resulted in a system error from IVR.

  • The CDR directory did not exist on the secondary NIU.

  • Card history only showed the first 10 calls on an account.

  • Unanswered calls left active sessions.

Note

Run the restworkx-cc clean command to remove any existing stale sessions prior to starting.

Version 1.6-6

October 10, 2018

Fixed

  • Rating did not begin until 30 seconds after a call connected.

Version 1.6-5

October 5, 2018

Improved

  • Added periodic tasks to remove stale sessions.

Fixed

  • An Expiration Sweep would cause an account to expire even before the account balance was below the set threshold.

  • A negative in-session balance extension would not work.

  • Sometimes, when a caller returned to a menu from an outbound call, no media was heard.

  • Incorrect account balances were showing in the web UI.

  • On the Product Offering page, the Second Greeting field showed the path to the audio file instead of the prompt text.

Version 1.6-4

September 26, 2018

Fixed

  • Calls did not successfully connect when using redial.

  • Using the IVR option to hear the current balance resulted in a system error.

  • Multiple accounts could not be successfully archived at once.

  • The user would be randomly returned to the Main Menu during a call.

  • Archived product offerings could not be restored.

  • Transferring funds did not work properly from IVR or web UI.

Version 1.6-3

September 23, 2018

Fixed

  • Archived accounts could not be restored.

Version 1.6-2

September 23, 2018

Fixed

  • Upgrading from 1.6-0 to 1.6-1 would sometimes result in an error.

  • After upgrading, product offerings could not be created using the web UI.

  • Card history would not load after calls were made.

  • Entering an account number to make a call would result in an error message in the log even though the call was successful.

  • Calls made with a destination Rate Type showed the incorrect rated cost in CDRs.

Version 1.6-1

September 19, 2018

Fixed

  • A Service Provider received errors when attempting to add new product offerings or view existing product offerings.

Version 1.6-0

September 14, 2018

New

  • EasyPIN can be reset from the One Step Dial menu.

  • Redial functionality support across IVR sessions.

Improved

  • The status can now be specified for accounts when bulk provisioning.

  • Balances were separated for session establishment and persistent sessions.

  • Enhanced greeting control, which consists of the First Greeting and Language Selection prompts being available from the access number and the Second Greeting being available from the product offering.

Version 1.5-11

August 10, 2018

Improved

  • Decreased the processing time for large rate plans.

Fixed

  • The routing prefix was not being applied on UCard calls.

  • UCard calls were using the incorrect rounding threshold and rounding interval.

Version 1.5-9

August 3, 2018

Fixed

  • Incorrect product offerings were added bulk provisioning accounts.

  • After making a call to an account, the status changed from Generated to Activated, but the Activation Date remained empty.

  • Balance transfer could not be used when the user is searching for an account in the web UI.

  • A system error occurred when attempting to transfer less than one dollar through IVR.

Version 1.5-8

August 2, 2018

Fixed

  • The Edit Account page in the web UI did not display properly.

  • The IVR did not play the prompts to lock/unlock an account.

Version 1.5-7

August 1, 2018

Improved

  • For a user with one-step dialing, added the ability in IVR to enable or disable PIN requirement.

  • The PIN can now be set for accounts when bulk provisioning.

Fixed

  • Balance transfer would not be allowed through the IVR when the account from which balance was to be transferred did not allow inbound transfers.

  • After bulk provisioning, charge numbers and serial numbers were swapped.

  • Timed PIN unlock did not work properly.

Version 1.5-6

July 20, 2018

Improved

  • Leading zeros were previously stripped for all outbound calls. Now, they will only be stripped when a routing prefix is defined and non-empty.

Version 1.5-5

July 18, 2018

Improved

  • Increased timeout for the language selection prompt.

  • Multiple accounts can now be provisioned at the same time.

Note

Most settings are shared between accounts. Only the number, charge_number, serial_number, and identity can be configured per account when provisioning more than one at a time.

Fixed

  • UCard product offering settings were inconsistently populated in the web UI.

Version 1.5-4

July 10, 2018

Fixed

  • Editing UCard settings in the web UI did not work properly. To fix this, a migration was added to make the extension fuzzystrmatch public.

  • The DAYS_FROM_FIRST_USE expiration type was not properly applied and would fail when logging in to the IVR for the first time and when transferring funds.

  • During fund transfer, a drop-to-Java call would time out when one or both accounts changed status as a result of the transfer.

Version 1.5-3

July 9, 2018

Fixed

  • Routing Prefix was not working properly.

  • Errors with certain periodic tasks would prevent other tasks from running.

  • Periodic recharge did not work with certain account types.

  • The account unlock periodic task failed when an account had a status of BLOCKED with no login attempts.

Version 1.5-2

July 5, 2018

Fixed

  • Using Chrome as a web browser, certain table columns could not be used for filtering.

  • Using Chrome as a web browser, users could not enter negative balances.

  • Removing a one-step dialing number from the IVR would format the updated one-step dialing list incorrectly.

  • Filtering on some columns in the CDR view would result in errors.

Version 1.5-1

July 5, 2018

Fixed

  • The maximum simultaneous calls count was incorrect.

  • Balance transfer through the web UI did not work properly.

  • Serial numbers were not showing in the web UI CDR table.

  • The Subscriber web UI was not properly displaying charge number and identity override capabilities.

  • Account lockout was being incorrectly evaluated based on last login attempt instead of the time of lockout.

  • Account lockout configuration could not be overridden by Service Providers.

Version 1.5-0

July 3, 2018

New

  • Added an option to remove one-step binding number via IVR.

  • Added an announcement for when a user cannot make a call due to too many simultaneous sessions.

  • Accounts are automatically unlocked after a period of time, configured by a Platform Owner or Service Provider, from lockout has elapsed.

  • Added a Search by Bound Number field in the web UI for account filtering.

  • Added a serial_number field to API responses and the web UI table view. This field is visible only to Platform Owners.

  • Added a post-login greeting for access numbers. This greeting can be configured per access number, and the product offering can override whether it is played.

Note

After upgrade, existing product offerings will have all these prompts enabled.

Improved

  • All greetings can now be interrupted by dialing.

  • Accounts can now be provisioned with a negative balance if the product offering also has a negative minimum balance.

  • For easier access, Access Number provisioning was moved from the Service Provider Settings page to its own page.

  • Standardized possible login types based on account number and/or PIN entry.

  • Changed allow_balance_transfer to allow_inbound_balance_transfer and allow_outbound_balance_transfer for delineation of direction.

Note

After upgrade, existing product offerings that had allow_balance_transfer enabled will have both of these values enabled.

Version 1.4-6

June 5, 2018

New

  • Added support for unique UCard CDR table filtering.

  • Added support for retrieving the calling number from P-Asserted-Identity when the caller is anonymous.

Fixed

  • When setting a PIN through the web UI, the proper number of digits could not be entered in the field.

  • Changing Subscriber override settings for constraints resulted in the product offering not being able to be saved.

  • Logs would sometimes not be rotated due to encoding issues.

Version 1.4-4

April 16, 2018

New

  • Added a secondary binding to context menus. When viewed from a device capable of touch events, a “long-touch” (1000ms) will open the right-click menu on a row in a table view.

  • Run the following command for rate plan debugging information:

    rating-engine-cc describe -a cc -i < account_number>

Fixed

  • Certain rates were erroneously parsed out during pre-processing step.

Version 1.4-3

April 9, 2018

Fixed

  • When using a maximum duration, calls would not disconnect and would report incorrect duration.

  • Calls that were configured to not reserve any amount of time would be allowed to continue.

  • The units for subrate fields would sometimes default to seconds.

Version 1.4-2

April 8, 2018

Improved

  • Improvements to accuracy of session maximum duration approximation to be within 5 seconds of the actual maximum duration.

Fixed

  • Optional text fields could not be deleted after their initial value.

  • There was an issue with INTERNATIONAL_ORIGINATION rates.

Version 1.4-1

April 6, 2018

Fixed

  • Digit-mapped call sessions were unique to a single thread, resulting is most rate calls failing after the initial one.

Version 1.4-0

April 6, 2018

New

  • Added fast-track dialing, allowing a user to skip IVR by dialing star-delimited strings. The following are types of fast-track dialing:
    • Use <access-number>*<destination-number> if the calling number has one-step dialing enabled (full binding).

    • Use <access-number>*<account-number>*<destination-number> if the account does not require a PIN (partial binding).

    • Use <access-number>*<account-number>*<pin>*<destination-number> for all other account types.

  • Added a pre-processing step to rating to eliminate situations of never matching.

  • Full CDR details for UCard calls are displayed in the web UI and API.

  • Added a serial_number field to accounts for informational purposes

Fixed

  • Transferring funds would not complete if calls were debited/credited to the exact minimum or maximum value.

  • Call sessions could hang indefinitely.

  • There was an issue with functionality of product offerings import/export.

  • UCard calls would be presented with an IVR to top off their account when they ran out of funds.

  • Date range searching was not working as expected.

Version 1.3-11

March 21, 2018

  • Outbound calls responding with a 183 then a failure code would result in a nonfunctional menu.

  • Outbound calls that reached their funds limit would either disconnect abruptly or not disconnect at all.

  • UCard would not always charge the correct amount.

  • Previous iterations of the Web UI Component could leave the Apache user and group in a non-working state.

Version 1.3-10

March 20, 2018

Fixed

  • Authorization tokens could be expired during a long-running import job.

  • All UCard calls were being charged zero bhat.

  • Returning to the main menu after an outbound call could result in a nonfunctional menu and/or being disconnected.

  • Web services would not start on the secondary NIU if SELinux was enabled.

Version 1.3-7

March 14, 2018

Fixed

  • Fixed an issue where calls ended during a grace period would still be charged.

  • Password length was only enforced when changing from the account page and not when activating or recovering.

  • Minimum duration was being used to authorize calls, but the final duration was not compared against this value and thus calls could be charged for less.

  • Minimum duration was rounded to 1 second when a certain combination of rounding threshold and rounding interval was used.

  • Final duration was not being rounded based on the threshold and interval.

  • UCard settings were not always saved.

  • Maximum call duration was reported as a generic rating error instead of an explicit cutoff and was calculated incorrectly.

Version 1.3-6

March 8, 2018

Fixed

  • Intermittent call rates were not processed properly.

  • Disconnecting a call while an outbound call was being placed resulted in orphaned sessions.

  • There was no validation for PIN entry.

  • The web UI did not correctly display when accounts had negative balances or started with a 0.

  • The ‘apply no rate’ option caused an API error.

Version 1.3-5

March 8, 2018

New

  • Added CONNECTED event to CDRs after an outbound call has been connected.

Fixed

  • UCard sent a second STOP event after disconnecting from the IVR.

  • UCard outbound contact and from header was pulled from the account number instead of the calling number.

  • Outgoing UCard balances were not rounded to a configuration n-digit float.

Version 1.3-4

Improved

  • JTwig was reverted to be compatible with Java 1.6.

  • UCards can now work without the PIN input for accounts that are not part of the Calling Card service.

Version 1.3-3

March 2, 2018

Fixed

  • In the rating engine, initial bong time did not determine the number of bongs to charge over a rating interval.

Version 1.3-2

March 2, 2018

Fixed

  • Card history was not displayed correctly for zero-cost calls.

Version 1.3-1

March 1, 2018

Fixed

  • Accounts could not be edited using context menus.

  • Outbound calls randomly failed for various reasons.

  • One-step dialing did not work as expected.

  • UCard accounts were not properly setting data in memory.

  • UCard accounts were calculating duration incorrectly.

Version 1.3-0

February 28, 2018

New

  • Added UCard functionality.
    • Platform Owners are able to set the timeout for responses from the RADIUS server (default 5 seconds) from the Settings page.

    • Service Providers are able to set whether to use UCard, the IP address of the RADIUS server, two separate ports, and a mapping of access number to product offering.

Fixed

  • Rates were calculated incorrectly when a rating period overlapped two different tiered rates.

  • Minimum billing could be less than the rounding interval, resulting in immediate or recurring charges (bongs) not firing their first events. Warnings will now be stated in the log if this is attempted, and the more sensible value will be used.

  • Rating types would not be considered if the resulting amount fell below the minimum balance or above the maximum balance of an account. The following is now true:
    • When announcing the amount left on a call to the user, only announced rates are considered.

    • When making reservations throughout a call, announced and unannounced rates are considered.

    • When calculating the final amount of a call, announced, unannounced, and unreserved rates are considered.

  • Only ten records were shown in certain widgets.

Version 1.2-4

February 14, 2018

Fixed

  • Exported CSV files showed the date of export for expiration dates.

  • A product offering configured with an Expiration Extension Type interval in years did not work properly.

  • A product offering with Expire after Outbound Transfer enabled would result in the IVR reporting that the transfer was unsuccessful even though it was.

  • The confirmation dialog box shown when creating a product offering could not be closed.

  • After saving changes to a new or existing Administrator user, Service Providers were not redirected to the Administrator page.

  • When a Service Provider generated a random PIN, the PIN Length setting was not applied.

Upgrade Procedure Notes

  • After upgrade installation, you will need to restart platform on each AS.

Version 1.2-3

February 8, 2018

Improved

  • There is now an interface for copying fields from tables.

Fixed

  • There were several issues with the functionality of importing and exporting data.

  • Transferring funds in the web UI would sometimes incorrectly report insufficient funds.

  • The years unit was not evaluated correctly for expiration extension when transferring and for last activity date for expiration sweep.

  • Changes to some Service Provider settings were not saved.

  • The Block with Media setting did not work properly.

  • There were the following issues with IVR:
    • The announcement stating the amount of funds to be transferred would state the incorrect amount.

    • Transferring funds would report erroneous failures.

    • The language selection prompt would cut off before it was complete.

    • Initial greeting prompts would cut off before they were complete.

Version 1.2-2

December 6, 2017

Fixed

  • There was a callflow issue with SSL.

  • When using the IVR, dialing * did not return to the previous menu without committing changes as it should have.