Billing Data Service Release Notes

From Genesys Documentation
Jump to: navigation, search

Not all releases or changes listed below may pertain to your deployment. Check the table below to see which releases apply to you.

The Release table lists the initial availability date for each release and the deployment environments for which a release is made available. Except when otherwise stated in the description for a specific release, each release includes all of the features and resolved issues that were introduced on earlier dates, regardless of the deployment environment. The features and resolved issues that apply only to a specific deployment environment are noted as such.
Available Genesys CX on Private edition Highlights Release
AWS Azure
August 2, 2022 PrivateEdition.png Support for Genesys Multicloud CX private edition deployments on Azure Kubernetes Service (AKS).

New reports for GVP-specific metrics and deprecation of the file.
May 24, 2022 PrivateEdition.png Generally Available release for Genesys Multicloud CX private edition deployments on the officially supported Kubernetes platforms.

Supports masking of Personally Identifiable Information (PII).
March 31, 2022 PrivateEdition.png Beta Program support for Genesys Multicloud CX private edition deployments on GKE.

Support for Elasticsearch v7.0 to support Genesys Interaction Recording (GIR) metrics and other improvements.
November 23, 2021 PrivateEdition.png New hostkey configuration parameter and other improvements.

Support for deploying all private edition services in a single namespace.
September 2, 2021 PrivateEdition.png Support for arbitrary UIDs in private edition deployments on OpenShift.
June 30, 2021 PrivateEdition.png Early Adopter Program support for Genesys Multicloud CX private edition deployments on OpenShift.

August 02, 2022PrivateEdition.png

Resolved Issues

  • To improve performance in the transformation process, Billing Data Service (BDS) now uses the spawn multiprocessing method instead of the fork method. (CBILL-5681)

  • BDS now validates the duplication of switches and notifies the user with appropriate duplication messages. (CBILL-5575)

For private edition

  • Billing Data Service (BDS) supports deployments on Azure Kubernetes Service (AKS) in Genesys Multicloud CX private edition. (CPE-3600)

  • The watermarks file now contains a new parameter, source_extract, that includes the information about the last successful extract of data from different sources (for example, GIM and GVP RS databases). (CBILL-5925)

  • The -fe and -fd options in the decrypt command now support decrypting a batch of extract or transform files and placing them in the configured resulting folder. (CBILL-5791)

  • The Named user metrics calculation and its corresponding detailed reports are now available for resellers. (CBILL-5627)

  • The Tenant configuration section contains a new optional parameter, Vendor rules, that you can use to define the ASR vendor rule such that the GVP report outputs are processed based on the rule. The default vendor rule is set to "nuance". (CBILL-5556)

  • The global variables file ( is now deprecated. The variables configured using are modified as environment variables and are now part of the envvars section in the values.yaml file. In addition, the values.yaml file includes the following changes:

    • DETAILED_REPORT_DIR is introduced which stores the report outputs such as Concurrent users detailed reports, GVP detailed reports, and Named users detailed reports. The default path is DETAILED_REPORT_DIR = /genesys/data/reports, however, customers can configure this path. (CBILL-5442)

  • The following reports are introduced to calculate GVP specific consumption in terms of milliseconds:

    • gvp_minutes
    • gvp_asr_minutes
    • gvp_tts_minutes
    The report outputs are stored in the path configured in the BDS_OVERRIDE_DETAILED_REPORT_DIR variable in the values.yaml file. (CBILL-5407)

  • The envvars section of the values.yaml file contains a new environment variable, DR_location, that you can use to manage disaster recovery (DR) situations. During DR, BDS verifies the existence of DR_location. If it exists, BDS verifies the existence of primary_location configuration at the tenant-level. In a DR scenario, all aliases and switches from the primary location are used even if the primary location is disabled. (CBILL-5233)

May 24, 2022PrivateEdition.png

Resolved Issues

  • BDS no longer displays an IndexError while processing the empty field remote_uri in the gvp_cdr_db dataset. (CBILL-5893)

  • BDS now correctly inserts new regions in the GCXI tables in the Postgres database. (CBILL-5880)

  • An input-output error (I/O) no longer occurs while writing the extracted files. (CBILL-5871)

  • BDS now correctly updates the watermark dates in the watermark file located on the shared volume. The watermark dates are updated after every successful extract, transform, and load stages for each of the target date. (CBILL-5786)

  • BDS no longer displays an error when connecting to the Postgres database, required for the Genesys CX Insights (GCXI) reports. (CBILL-5737)

For private edition

  • As of July 13, 2022, Billing Data Service (BDS) is Generally Available for deployment in Genesys Multicloud CX private edition on the Kubernetes platforms officially supported by Genesys.

  • The following changes have been made to improve the performance:

    • Queries extracting the metrics data have been optimized.
    • The ORDER BY step is now removed from all the datasets. (CBILL-5833)

  • The Kubernetes batch API group version in helm charts is updated to v1, which is available from Kubernetes 1.21 and later. If you are using Kubernetes version 1.20 or earlier, either upgrade to 1.21 or change the Kubernetes batch API group version parameter (apiVersion) to v1beta1 in bds-cronjob/run-bds.yml file. (CBILL-5586)

  • BDS now masks Personally Identifiable Information (PII) stored in the extract, transform, and final BDS reports. The PII data such as phone number, agent’s name, agent’s email ID, and so on are masked. A new parameter named anonymizer_salt is added to the file to anonymize the PII data such as name, email ID, and so on in the extracted data. (CBILL-5432)

March 31, 2022PrivateEdition.png

Resolved Issues

  • The script no longer gives an error when encryption is enabled. Previously, an error occurred when the transform files were encrypted.
    To resolve this issue, a new option -decrypt has been added to the script to decrypt the encrypted transform files. (CBILL-5303)

For private edition

  • As of March 31, 2022, Billing Data Service (BDS) supports deployments on Google Kubernetes Engine (GKE) in Genesys Multicloud CX private edition, as part of the Beta Program (formerly referred to as EAP). (CPE-2682)

  • The rounding algorithm in Billing Data Server (BDS) is improved to group the events by Source Unique ID before summarizing the duration in ASR/TTR minutes. (CBILL-5366)

  • BDS now supports Elasticsearch v7.0 for Genesys Interaction Recording (GIR) metrics.  (CBILL-5355)

  • A new parameter MULTICLOUD_EXTRACT_IVR_FILTER is added to the file, which when enabled extracts records based on ivr_usage_profiles. By default, the MULTICLOUD_EXTRACT_IVR_FILTER parameter is set to false. (CBILL-5256)

  • BDS now updates the BDS_REGION table in Genesys Info Mart (GIM) with the new regions added to the configuration file (Config.json). The region values from the BDS_REGION table are displayed in the Genesys CX Insights (GCXI) reports. (CBILL-5238)

  • To improve performance, BDS now implements multithreading capability while extracting data from sources such as Genesys Voice Platform (GVP), GIM, and so on. In the single tenant configuration for BDS, multithreading allows to have one thread for one data source which significantly reduces the data extraction time. (CBILL-5156)

  • Performance improvements have been made in the transformation process of GVP ASR/TTS metrics. (CBILL-5155)

  • During the Transform stage, BDS now applies a dedicated process for each metric instead of applying a single process for all metrics in order to improve the performance.  (CBILL-5108)

  • A new metric bds_extract_\{name}_rows_amount is added to show the number of rows extracted for the dataset from their data source such as GIM, GVP, and GIR. In the parameter name, \{name} indicates the name of the dataset, for example, sm_fact. The resulting value can be sent to Prometheus (for example, through Pushgateway) for further monitoring purposes.

    An example output looks like the following:
    The "bds_extract_sm_fact_rows_amount" has been added to the PushGateway with value "1124" (CBILL-5077)

  • BDS provides values for specific metrics and attributes to the Genesys CX Insights Reporting (GCXI) tool to generate the following reports in the GCXI > Billing Data folder:

    The metrics shared are:

    • Seats Voice Concurrent
    • Seats Voice
    • GVP Minutes
    • GVP Ports

    The attributes shared are:

    • Business Unit
    • Metric
    • Region
    • Start Date Time Key (CBILL-4585)

November 23, 2021PrivateEdition.png

Resolved Issues

  • An incorrect calculation, which was caused by a false expectation of the incoming media type values, is now resolved in the following metrics: chatbot_interactions, voicebot_minutes, and voicebot_interactions. (CBILL-5314)

  • In the Multicloud_PE mode, the SourceID value is by default set as MultiCloudPE in the globals section for BDS configuration. (CBILL-5292)

  • A runtime error no longer occurs in BDS when there is no data for one of the GVP regions in the gvp_cdrs_db_asr_tts dataset. (CBILL-5240)

  • The script now correctly generates the Daily summary report. Previously, an error similar to the following appeared:

    TypeError: '<=' not supported between instances of 'NoneType' and 'NoneType'. (CBILL-5159)

  • The date field in the TerminatedTS field in the sm_fact dataset has been modified to apply the end of transformation date as its value. Previously, a future date was set by default in the date field in TerminatedTS. (CBILL-5097)

  • BDS now correctly extracts the user properties received from GWS, for example, if voicemail properties exist for an Agent Group. (CBILL-5074)

  • The gtr_interactions metric is now updated to support the Business Unit attribute. Previously, an error similar to the following appeared while running the metric.

    AttributeError: 'GTRTransformer' object has no attribute 'folder_df'. (CBILL-5048)

For private edition

  • Support for deploying the Billing Data service in a single namespace with other private edition services has been implemented. No configuration changes are required to enable this alternative deployment scenario. (CBILL-5207)

  • BDS uses code checksum to protect the code from ineligible changes. (CBILL-5081)

  • In the Multicloud and Multicloud_PE modes, the GVP transform obtains IVR usage app dbid (ivr_app_dbid) from the Consul Key-value store at kv/tenants/<tenant-id>/gvp - {"ivr_app_dbid:"105"}.

    The following example shows the changes in the tenant object value:

    {"gvp_config_dbid":"105", "ivr_app_dbid":"135"} (CBILL-5067)

  • In the Multicloud_PE mode, encryption is enabled by default. You no longer have to set gvars.is_fedramp=True to enable encryption. (CBILL-5008)

  • Datasets are removed from the configuration file, and are now read directly from the template files.

  • A new validation ensures the availability of watermarks.json file and its watermark values. If the watermarks.json is unavailable, or contains invalid values, BDS creates the watermark file and updates all the following watermark related fields with the production date:

    • extract_watermark
    • transform_watermark
    • load_watermark
    • sbc_validate_watermark
    • audit_watermark (CBILL-4971)

  • The BDS Control utility ( now prints the actual BDS version when the following command is executed: -v


  • A new configuration parameter (optional) hostkey is introduced in the loader_sftp section to specify a public key available for the SFTP server. The public key provides extra authorization for the SFTP server. The public keys are available in the SFTP server in the following location:


    The hostkey parameter value consists of two sections separated by a space, where:

    • The first section requires the public key type. Supported key types are:
      • ecdsa-sha2-nistp256
      • ecdsa-sha2-nistp384
      • ecdsa-sha2-nistp521
      • ssh-ed25519
      • ssh-rsa
      • ssh-dss
    • The second section requires the actual value of the public key.

    The following example shows the hostkey configuration:

    "hostkey": "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBP/4CFOOhQPL1L5SVpU8Y1H6SWaAQuCGieAWbC6/RqY1lX/2XyoE39owQgWPjFzEPatAoD5rSq6GoLbBCCMAnzE="

    • For more information, see the Configuration guide. (CBILL-4875)

September 02, 2021PrivateEdition.png

What's New

  • When you use the wizard to create a BDS configuration, the country parameter is now required. (CBILL-4911)

Resolved Issues

  • The transformation process now works correctly following test sessions. Previously, transformation failed following some test-session scenarios. (CBILL-5073)

  • The folder multicloud_pe now contains templates with appropriate product_id values for Genesys Multicloud CX Private Edition. (CBILL-4940)

  • During startup, if BDS finds any placeholder values in the configuration files, it automatically uses values from environment variables instead. (CBILL-4788)

For private edition

  • Billing Data Service now supports the use of arbitrary, or random, user IDs (UIDs) in OpenShift.

    • The Dockerfile has been modified to specify container and file ownership as user=500 (genesys) and group=0 (root).
    • The securityContext settings exposed in the default values.yaml file specify the user and group IDs for the genesys user (500:500:500). You must override these Helm chart values if you want OpenShift to use arbitrary UIDs. For more information, see Configure BDS.
    • Billing Data Service is deployed using a ServiceAccount that uses the restricted Security Context Constraint (SCC). If you do not want to use arbitrary UIDs in your OpenShift deployment, you must associate the ServiceAccount with the genesys-restricted SCC, as described in Deploy BDS. If you want OpenShift to use arbitrary UIDs and if you previously deployed Billing Data Service using a ServiceAccount associated with the genesys-restricted SCC, you must remove the association. To do so, execute the following command:
      oc adm policy remove-scc-from-user genesys-restricted -z <serviceaccount> -n <namespace>
    • Billing Data Service is deployed using ServiceAccounts that use the restricted Security Context Constraint (SCC). In an earlier implementation, Genesys required you to deploy all private edition services using a ServiceAccount associated with the custom genesys-restricted SCC, to control permissions for the genesys user (500). Genesys now expects OpenShift to use arbitrary UIDs in your deployment, and the genesys-restricted SCC has been deprecated. If you previously deployed Billing Data Service using the genesys-restricted SCC, Genesys recommends that you redeploy Billing Data Service so that you use arbitrary UIDs. (CBILL-5069)

June 30, 2021PrivateEdition.png

For private edition

  • Starting with this release, Billing Data Service (BDS) is available for select customers in Genesys Multicloud CX private edition, as part of the Early Adopter Program. Deployments on OpenShift Container Platform (OpenShift) are supported. (CBILL-4628)
    More info: Billing Data Service Private Edition Guide

Comments or questions about this documentation? Contact us for support!