Jump to: navigation, search


All Genesys software is © Copyright 2019-2021 Genesys Cloud Services, Inc. All rights reserved.

Complete information about Genesys proprietary intellectual property, including copyrights, can be found here.


Genesys and the Genesys logo are registered trademarks of Genesys Cloud Services, Inc. in the U.S.A. and other countries. Complete information about Genesys proprietary intellectual property, including all trademarks, can be found here.

All other trademarks are the property of their respective owners.

Third Party Software

Genesys follows applicable third-party redistribution policies to the extent that Genesys solutions utilize third-party functionality. Please contact your customer care representative if you have any questions. The following list describes specific third-party code and functionality for this product:

LICENSE and LEGAL NOTICE information is available in the Billing Data Server (BDS) distribution package.

What's New in Billing Data Server for 9.0

May 12, 2021

This release contains the following new features and enhancements:

  • SFTP enhancements — The premise_loader_sftp section to the config.json file is renamed as loader_sftp. For more information, see Configuring BDS. (CBILL-4749)

April 19, 2021

This release contains the following new features and enhancements:

  • Exit code enhancements — Two Billing Data Server (BDS) modules now return exit codes upon completion:
    • The BDS Control utility (Brsctl.py) now returns exit codes to indicate whether processing was successful (0 - success, or 1 - failure). (CBILL-4470)
    • The Dispatcher.py utility now returns exit codes when extraction, transformation, and load (ETL) processes complete, indicating whether the ETL was successful, and if it failed, where the error occurred.
      For more information about exit codes, see exit codes. (CBILL-4376)
  • Dataset integrety validation — The BDS Installation Package now includes hashed datasets. During extraction, BDS makes new hashes of the datasets and validates them against the original hashes. (CBILL-4334)

February 16, 2021

  • Enhanced configuration migration support — The BDS Control utility supports a new command, migrate, which will enable you to migrate configuration information when you upgrade to future releases from release or later. For more information, see Configuration: the Control utility. (CBILL-4264)
    To support this change:
    • gvars.py is updated to include support for the new migration API. (CBILL-4318)
    • A new parameter, cfg_template_version, is added to the global section, to provide support for migration between BDS releases. See Configuring BDS. (CBILL-4275)
  • Configuration enhancements — In addition to configuration enhancements associated with migration, the following changes are introduced:
    • BDS now stores a backup of the configuration file, in the path /genesys/brs/timestamp_config_name.json. (CBILL-4262)
    • The configuration wizard now validates watermarks to ensure they match the pattern yyyy-mm-dd.
    • The configuration wizard now performs additional error-checking, and prompts the user to correct any misconfigurations.
    • The configuration wizard now consistently displays the name of the section and subsection in the middle of the display, and each question is cleared before the next one appears. For information about the configuration wizard, see Configuring BDS. (CBILL-4347)

December 17, 2020

This release includes the following new features:

  • Bot reporting enhancements — Three new metrics provide reporting on chatbot and voicebot usage:
  • Multi-tenant configuration enhancements — A new parameter, cme_credentials, is added to the tenant and to gvp configuration sections. Populate these values in multi-tenant deployments where each tenant has unique credentials/endpoints. In single-tenant scenarios, leave them blank, which causes BDS to use the credentials defined in the globals section. (CBILL-4089)
  • Tenant template updates — The fields seat_model and elasticsearch_host were removed from tenant generation and sample templates. (CBILL-4195)

December 01, 2020

This release includes the following new features:

  • Installation and Configuration enhancements — BDS now provides enhanced deployment and configuration methods that reduce the complexity and time required to deploy and set up the software.
    • Deployment script — A new deployment script, deploy_prem_install.sh, automates the installation of BDS on the premise host. (CBILL-4015)
    • Configuration wizard — A new option (brsctl.py setup), enables you to easily create new BDS configurations. (CBILL-3815)
    For more information, see Installing BDS and Configuring BDS. (CBILL-4072)
    • When generating the global template, BDS now automatically adds only appropriate attributes in the mode_settings section. (CBILL-3786)
  • Logging Enhancements:
    • BDS now logs an error when the Configuration Server returns an empty list of test agents. BDS repeats the request up to three times, logging an error each time. (CBILL-4059)
    • BDS now logs an error if it cannot create a cursor object from the connection, and makes a new connection to the database server. (CBILL-4143)

August 27, 2020

This release contains the following new features and enhancements:

  • Data encryption enhancements — Extract and transform files are now encrypted using a new BDSCrypto class. (CBILL-3845, CBILL-3846)
    • The Billing Data Server (BDS) Control utility (Brsctl.py) now accepts a command, decrypt, that you can use to decrypt extract or transform files. For more information, see Configuration: the Control utility. (CBILL-3876)
    • BDS now allows you to use the premise_loader_sftp parameter to upload decrypted transform files to a configured SFTP server. For information about premise_loader_sftp, see Initial configuration of BDS for on-premise deployments. (CBILL-3847)
    • The Statistic utility (brs/bds_statistic/statistic.py) now works with encrypted extract or transform files. (CBILL-3896)
  • Daily enabled seat reporting — BDS now generates a 'daily' version of the Enabled seats detailed report. See the Billing Data Server User's Guide for more information. (CBILL-3892)
  • Configuration enhancements —Several parameters are renamed for clarity in the globals.json and configuration.json files:
    • The 'globals/premise' section is renamed as 'globals/mode_settings'.
    • The parameter 'premise_transform_path' is renamed as 'local_transform_path'.
    • The parameter 'premise_extract_path' is renamed as 'local_extract_path'.
    For more information about configuration parameters, see Initial configuration of BDS for on-premise deployments and Global variables in the Billing Data Server Deployment Guide.
    If you are upgrading from an older BDS release, you must update your configuration to account for these changes. (CBILL-3785)
  • Operating Mode control — A new environment variable, BDS_OPERATING_MODE, now controls the current operating mode (CLOUD, MULTICLOUD, PREMISE). For more information, see Global variables. (CBILL-3784)
  • Record filtering enhancements — In scenarios where a tenant configuration has IVR usage profiles set to the default location ("ivr_usage_profiles":"000"), BDS now filters out records that have an empty value for LOCAL_URI. It does not filter out records that have media-service=treatment, or that have a populated LOCAL_URI, but an empty value for media-service.
    When a record is filtered out, BDS logs a message similar to the following:
    Default IVR profile, discarded media services: {'media': 1, 'record': 3}, discarded IVR: ['1665'].
  • Error logging enhancements — BDS now creates log entries to track the number of regular error messages and critical error messages. (CBILL-3940)

July 20, 2020

  • SFTP configuration enhancements — A new section, premise_loader_sftp, in the config.json file, defines the SFTP server to which transformed files are automatically uploaded. When this optional section is present, BDS uploads files to the location specified. For more information, see the Billing Data Server Deployment Guide. (CBILL-3741)
  • Usage statistics — BDS now provides the ability to aggregate peak usage data over configurable reporting intervals. New parameters in statistic.py control the reporting interval over which this data is aggregated; for more information, see the Billing Data Server User's Guide. (CBILL-3749)
  • Dataset enhancements:
    • Two new fields, gvm_mailbox_terminatedts and infra_class_terminatedts, are added to the dn dataset.
    • A new field, gvm_mailbox_terminatedts, is added to the agent_login and agent_group datasets.
    • The following datasets are now version voice_session, mm_sessions, dn, agent_login, and agent_group. (CBILL-3797, CBILL-3793)
  • Extraction performance enhancements:
    • Co-browse logins are now correctly joined with corresponding user data in the co-browse section of the voice_session and mm_sessions datasets.
    • ORDER BY is removed from the voice_session, mm_sessions, and sm_fact datasets.
    • RESOURCE_TYPE_CODE is now used (instead of RESOURCE_TYPE) to filter AGENTS in the voice_session and mm_sessions datasets. (CBILL-3793)
  • Version-checking enhancements — A new configuration parameter, source_version in the primary_statements section, specifies the minimum required release of the data source (such as Genesys Info Mart). BDS uses this information to ensure that it executes a compatible SQL statement. BDS executes the primary statement, unless the installed data source version is earlier than the value specified in this parameter, in which case it executes an alternative secondary statement. (CBILL-3760)

June 25, 2020

  • Configuration template enhancements:
    • This following enhancements improve usability of the region template:
      • The location_name parameter is renamed as region_name.
      • The put_location_name_here placeholder is renamed as put_region_label_here. (CBILL-3498)
    • This following enhancements improve usability of the location template:
      • The deprecated dc_name parameter is removed from the location configuration template. (CBILL-3489)
  • Configuration validation enhancements — BDS now validates values provided for the dc_aliases parameter to ensure that each tenant has unique aliases (including global configuration) only in enabled locations. (CBILL-3621)
  • Error handling enhancements — Error handling was rewritten to provide clearer, more concise logging, and now provides complete details about errors that cause the transformation process to stop. (CBILL-3542)

May 21, 2020

  • BDS now checks to ensure that metrics are used only in appropriate modes, and logs error messages for both of the following scenarios:
    • A user attempts to enable a metric that cannot be used in the current mode. For example when a metric that is intended for extended usage measuring is being enabled in subscription mode.
    • The transformation job attempts to transform a metric that cannot be used in the current mode. (CBILL-3635)
  • A new configuration option, check_gim_data_availability, in the gvars.py file controls whether BDS checks for available data in the Genesys Info Mart database before processing. The default value is False; to enable checking, change the value to True. Previously, BDS always queried Info Mart's database control tables, however, this sometimes produced false negative results in scenarios where there was no new activity, but Info Mart processing was moving ahead without delays. (CBILL-3632)
  • A new metric, Genesys SIP Interaction, counts the number of agents with voice sessions registered on switches of type 72 (SIP Switch or SIP Cluster), and who handle interactions during the reporting period. For more information, see Genesys SIP Interaction. (CBILL-3565)
  • The scope of the metric Genesys CIM Premise Users has changed to global. This means that BDS now produces one file for each tenant for a given metric, regardless of how many regions are defined for the tenant. (CBILL-3533)
  • BDS now performs filtering to exclude non-agent login sessions — such as sessions of IVR ports configured as agents — in the following metrics:
    • seats_voice
    • seats_inbound_voice
    • seats_outbound
    • seats_callback
    • seats_webrtc
    • seats_supervisor

April 15, 2020

  • CIM Platform billing enhancements:
    • A new metric, Genesys CIM Premise Users (cim_platform_users), tracks the number of unique agents having active sessions.
      This metric replaces the Genesys Customer Interaction Management Platform (seats_CIM) metric, which is discontinued. The new metric provides enhanced filtration and checking. (CBILL-3155)
    • A new metric and associated dataset enhancements, Genesys CIM Premise Places (cim_platform_places), tracks the number of unique agent places in the deployment. (CBILL-3325, BILL-3324)
  • Enabled-seat calculation enhancements — Whenever possible, BDS now uses the enabled seats detailed report for the previous day to calculate enabled seats metric for the processing date. (CBILL-3396)
  • Error management enhancement — A new configurable parameter, raise_error_DC_aliases in gvars.py, permits you to control whether BDS stops with an error, or continues transformation in scenarios where BDS uses a location dc_aliases list to process a metric, and the list includes a dataset that is not containing a value that is not defined in any tenant location. (CBILL-3504)

March 31, 2020

  • Enhanced agent location tracking — BDS now leverages functionality introduced in Genesys Info Mart release to more accurately associate agent seat counts with regions. (CBILL-3075)
  • Control Utility enhancements — The BDS Control utility (Brsctl.py) now supports deletion of metrics defined in the BDS configuration. (CBILL-3286)
  • Enhanced error checking — In scenarios where BDS detects that a Data Center (DC) alias encountered in a dataset is not present in any of dc_aliases lists of locations defined in the BDS configuration, BDS now stops processing the current metric and logs an error. (GCXI-3458)
  • Miscellaneous enhancements — The BDS container now runs Python 3.6. Previous releases ran Python 2.7. (CBILL-3249)

January 22, 2020

  • Social media reporting enhancements — The following enhancements are introduced:
    • The metrics seats_twitter_public and seats_twitter_messenger are now merged into a single metric, seats_twitter, with RMS_SERVICE_CLASS 24. (CBILL-3131)
    • The metrics seats_facebook_public and seats_facebook_messenger are now merged into a single metric, seats_facebook, with RMS_SERVICE_CLASS 22. (CBILL-3130)
    See the Billing Data Server User's Guide for more information.
  • Chat reporting enhancements — The metric seats_chat_nexus is removed. Instead, Genesys Chat Seats for NEXUS now uses the metric seats_chat. The metric seats_chat is enhanced so that it now correctly measures chat agent seats in Nexus deployments. (CBILL-3129)
  • Genesys Task Routing enhancements — The following enhancements are introduced:
    • The metric configuration template was updated.
    • The gtr_interactions metric is now calculated without the test sessions dataset. See the Billing Data Server User's Guide for more information.
  • Miscellaneous performance enhancements — The following enhancements are introduced:
    • BDS now produces both concurrent and enabled reports on a daily basis, where the number of enabled seats is calculated as a running total since the first day of the month. Previously, BDS produced a file each day with the peak concurrent seats number, but produced a file only once a month to capture the number of unique seats during the month. (CBILL-3134)
    • The query used in the sm_fact dataset is enhanced to improve performance. (CBILL-3147)
    • In Nexus deployments where SMS interactions are handled by agents who are logged in to the chat media channel, BDS now uses a new field, SMS, in the sm_fact query, to calculate the seats_sms metric. (CBILL-3167)

November 27, 2019

  • Extraction Optimization — Logic for Configuration Management Environment (CME) data extraction is optimized, resulting in an estimated 70% decrease in extraction time. (CBILL-3095)

October 28, 2019

  • General Datasets template enhancements — Two new fields are introduced:
    • version — shows the version of the template creation, or last update. Default value:
    • scope — indicates the scope of the dataset (global | location | region), where:
  • Genesys SMS metric enhancement — The seats_sms metric now tracks whether sessions include any interactions in which the corresponding media type was handled by an agent who was logged into the sms or smssession channel, and the metric count includes only those sessions where at least one such interaction was handled.
  • Configuration enhancements — During startup, BDS now checks for the the configuration file specified in gvars.pym. If the configuration file does not exist, BDS now automatically creates it as brs/config.json.
  • GIR Elastic Search enhancements — BDS now supports extracting data from GIR Elastic Search v3 index schemas.
  • Improved Peak Usage reporting — In metrics that show peak usage, the column _StartTime_ in the output CSV file is now populated with the actual peak time value. If the peak usage is null, the column is populated with the last second of the reported day, as it was in all scenarios for previous releases.
  • GIR metric enhancements — If there is no requirement to break down data based on business unit, BDS now generates GIR metrics (Active Call Recording, Screen Recording, and Quality Management) even when Genesys Info Mart datasets are not available. As a result, test datasets (test_voice_interactions) are no longer required, and are removed from the these metrics.

July 19, 2019

  • BDS now generates detailed reports for:
    • Each GIM-based voicemail boxes (voicemail_boxes_gim) transformation.
    • Each SIP voicemail (voicemail_boxes) transformation.
  • A new metric, Genesys Task Routing interactions, tracks the daily volume of Genesys Task Routing interactions.
  • BDS now tracks whether sessions include any interactions, in these metrics: Genesys E-mail and Genesys Voice metric.
  • The agent_login dataset is expanded to include a new column, switchname. (CBILL-2617)
  • Several usability and user experience improvements are introduced for the command-line Control Utility (brsctl.py), including many new or improved output messages.
  • BDS now supports S3 connections with or without credentials.
  • Logging of events peak calculation is enhanced by the addition of peak timestamp information.
  • BDS now logs more detailed information about the causes of failed initialization of the configuration object.

April 12, 2019

  • New options are introduced to more easily control how data is handled in premise mode (whether it is uploaded to S3, or only stored locally), and to allow a wide range of usage metrics to be tracked. Settings for premise and subscription modes (including extraction, transformation, and local cache paths) are now stored in the 'global' section of the BDS configuration file.
  • The Third Party work items and Genesys Chat metrics now include only sessions where at least one interaction was handled.
  • BDS now supports deployment without Oracle. (Oracle support continues as in previous releases, but it is installed as a separate, and optional, step.)

January 22, 2019

  • Support is added to track data for Genesys Info Mart-based voicemail.
  • Authentication through Web Services and Applications (GWS) is now supported.
  • BDS now provides enhanced logging capabilities.

See Billing Data Server Release Note to learn more about these, and other, new features and changes.

September 25, 2018

  • BDS now includes the Business Units breakout functionality.

See Billing Data Server Release Note to learn more about the new feature.

June 27, 2018

  • BDS now has the detailed concurrent and enabled seats report functionality.
  • BDS now unifies the native python logging approach.

See Billing Data Server Release Note to learn more about the new features and issues resolved with this release.

28 March 2018

  • BDS provides the data required for the Genesys financial organization to bill customers for subscription services.

See the Billing Data Server Release Note to learn about the main functions.

Billing Data Server

The Billing Data Server (BDS), deployed on customer premises, provides the data required for the Genesys financial organization to bill customers for subscription services. The main functions of BDS are:

  • Daily extraction of historical reporting and configuration data needed for billing
  • Aggregation of that data into daily and monthly summary files
  • Automated transmission of daily and monthly files back to Genesys for invoicing for online configuration
  • Local storage of billing files as backup or other uses

What's New

Billing Data Server is part of 9.x, which can include component releases from 9.1.x, 9.0.x, and 8.5.x code streams. Use the table below to check which component releases are part of 9.x.

All 9.x products 9.x Billing Data Server Release Notes
Product Component Latest Starting

Billing Data Server

Billing Data Server


Deployment Guide

Learn about how to deploy Billing Data Server and enable its features.

User's Guide

Learn how to use Billing Data Server.

More Release Information

This page was last edited on December 2, 2019, at 20:13.