Billing Data Service Articles

Billing Data Service

BDS 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 to Genesys back-office for invoicing.
  • Local storage of encrypted billing files as backup, or for other purposes.
  • Creates local reports based on the various agent seat metric calculations.

Supported Kubernetes platforms

Billing Data Service is supported on the following cloud platforms:

  • Google Kubernetes Engine (GKE)
  • OpenShift Container Platform (OpenShift)

See the Billing Data Service release notes for information about when support was introduced.

Release notes

Find out about changes in each release: Billing Data Service Release Notes

Private edition

The Billing Data Service Private Edition Guide provides information about deploying, configuring, and operating BDS.

Find detailed information about how to deploy this service in your environment.

Billing Data Service Guide

Get started

Billing Data Service (BDS) provides data that the Genesys financial organization uses to bill customers for subscription services. After you have completed deployment of BDS in Genesys Multicloud CX Private Edition, see the links in this section for additional information.

The Genesys Multicloud CX Private Edition release of BDS is has different functionality / features than previous on-premises releases of the software. However, the following on-premises documentation resources can be useful as a reference:

NOTE: Genesys Multicloud CX private edition is being released to pre-approved customers as part of the Beta Program. Please note that the documentation and the product are subject to change. For more details about the program, please contact your Genesys representative.

Billing Data Service (BDS) is a service available with the Genesys Multicloud CX private edition offering.

Overview

Learn more about BDS its architecture, and how to support high availability and disaster recovery.

Configure and deploy

Find out how to configure and deploy BDS.

Operations

Learn how to monitor BDS with metrics and logging.

NOTE: Genesys Multicloud CX private edition is being released to pre-approved customers as part of the Beta Program. Please note that the documentation and the product are subject to change. For more details about the program, please contact your Genesys representative.

Limitations and assumptions

In a private edition environment, Billing Data Service (BDS) currently supports deployments only on the specific Kubernetes platforms cited in About BDS. Deploying BDS in environments that are not officially tested and certified by Genesys is not supported. If your organization requires a special business case to deploy BDS in an uncertified or unsupported environment (for example, mixed-mode), contact your Genesys Account Representative or Customer Care.

Download the Helm charts

For general information about downloading containers, see: Downloading your Genesys Multicloud CX containers.

To learn what Helm chart version you must download for your release, see Helm charts and containers for Billing Data Service.

The BDS Helm chart defines a CronJob:

BDS Helm chart package [ bds-cronjob-<version>.tgz ]:

Scripts in this container run Extraction, Transformation, and Load process according to the main configuration specified as Config Map.  

BDS queries data primarily from Genesys Info Mart, GVP Reporting Server, and the Framework Configuration Management Environment, and can transmit the data to the SFTP server.

Third-party prerequisites

Before deploying BDS, configure the following 3rd party components:

  • Consul
    • Version: 1.9.5 - 1.9.x
    • Purpose: Service discovery, service mesh, and key/value store
    • Notes: Provision Consul to provide gvp_config_dbid and ivr_app_dbid parameters with Tenant ID and default IVR application ID values from the GVP Configuration Server database. Where,
      • gvp_config_dbid is the DB ID for a particular tenant.
      • ivr_app_dbid is the DB ID for the default IVR application for that tenant.

        Example request:

        curl -H "Authorization: Bearer <token>" https://<consul_url>/v1/kv/tenants/<tenant_uuid>/gvp
        {
        "gvp_config_dbid": "161",
        "ivr_app_dbid"  : "217"
        }
    • Command Line Interface
      • Purpose: The command line interface tools to log in and work with the Kubernetes clusters.

Storage requirements

To deploy a BDS container on a node (or a worker computer), you need the following storage elements:

  • dual-core vCPU
  • 8 GB RAM
  • 40 GB PVC*
  • Database - BDS does not require any database but extracts the data from the GIM database, that is, Postgres. Hence, BDS supports any Postgres version that GIM currently supports.

* BDS creates the persistent volume claim (PVC) file storage to save the extracted and transformed files with current ETL time stamps.

  • The file share must be persistent, and must be mounted inside the pod to /mnt/fileshare folder. Note: Mount name cannot be changed, once created.
  • The information and files necessary to start BDS in between launches is stored on PVC.
  • Data in the file share must be backed up with a retention period of 90 days, and data protection.

Network requirements

Not applicable

Browser requirements

Not applicable

Genesys dependencies

BDS interoperates with the following Genesys software applications to receive billing data:

  • Genesys Voice Platform Reporting Server (GVP RS) 9.0 or later
  • Genesys Info Mart 8.5.015.19 or later

Depending on the metrics that you need, you must ensure that the corresponding data sources are available in your environment for BDS to generate meaningful reports.

To build requests for main data sources, BDS obtains additional information from the following sources:

  • GVP Config Server
  • Genesys GWS

NOTE: Genesys Multicloud CX private edition is being released to pre-approved customers as part of the Beta Program. Please note that the documentation and the product are subject to change. For more details about the program, please contact your Genesys representative.
Did you find this page useful?

Introduction

Billing Data Service (BDS) operates as a CronJob, which runs once a day, consisting of a sequence of steps that collect various data from sources -- such as Genesys Info Mart, GVP RS, and Configuration -- and transforms that data into usage statistics that track your consumption of Genesys services, which is used for billing purposes. Files are securely transferred to Genesys back-office using SFTP.

Autoscaling is not supported.

For information about the overall architecture of Genesys Multicloud CX private edition, see the high-level Architecture page.

See also High availability and disaster recovery for information about high availability/disaster recovery architecture.

Architecture diagram - Connections

The numbers on the connection lines refer to the connection numbers in the table that follows the diagram. The direction of the arrows indicates where the connection is initiated (the source) and where an initiated connection connects to (the destination), from the point of view of Billing Data Service as a service in the network.

Architecture diagram for Billing Data Service in Private Edition.

Connections table

The connection numbers refer to the numbers on the connection lines in the diagram. The Source, Destination, and Connection Classification columns in the table relate to the direction of the arrows in the Connections diagram above: The source is where the connection is initiated, and the destination is where an initiated connection connects to, from the point of view of Billing Data Service as a service in the network. Egress means the Billing Data Service service is the source, and Ingress means the Billing Data Service service is the destination. Intra-cluster means the connection is between services in the cluster.

Connection Source Destination Protocol Port Classification Data that travels on this connection
1 Billing Data Service Pushgateway HTTP 9091 Intra-cluster BDS-specific monitoring metrics are available through PushGateway. A monitoring tool connection can scrape those metrics from PushGateway.
2 Billing Data Service Genesys Web Services and Applications HTTP 80 Intra-cluster Obtains information on voicemail boxes configured in the tenant’s configuration.
3 Billing Data Service Voice Platform Configuration Server TCP 8888 Intra-cluster Verifies necessary configurations required to connect to Voice Platform Reporting Server in a tenant's primary region.
4 Billing Data Service Consul HTTPS 443 Intra-cluster Connection to Consul in a tenant's primary region.
5 Billing Data Service Voice Platform Reporting Server TCP 1433 Intra-cluster Connection to the Voice Platform Reporting Server's database (GVS RS DB) to extract metrics information in a tenant's primary region.
6 Billing Data Service Genesys Info Mart TCP 5432 Intra-cluster Connection to the Genesys Info Mart's database (GIM DB) to extract metrics information in a tenant's primary region.
7 Billing Data Service Voice Platform Configuration Server TCP 8888 Egress Verifies necessary configurations required to connect to Voice Platform Reporting Server in a tenant's non-primary region(s).
8 Billing Data Service Consul HTTPS 443 Egress Connection to Consul in a tenant's non-primary region(s).
9 Billing Data Service Voice Platform Reporting Server TCP 1433 Egress Connection to the Voice Platform Reporting Server's database (GVS RS DB) to extract metrics information in a tenant's non-primary region.

 

NOTE: Genesys Multicloud CX private edition is being released to pre-approved customers as part of the Beta Program. Please note that the documentation and the product are subject to change. For more details about the program, please contact your Genesys representative.

 

Billing Data Service (BDS) is a Cronjob that runs on a per-tenant basis, so High Availability (HA) is not applicable.

See High Availability information for all services: High availability and disaster recovery

NOTE: Genesys Multicloud CX private edition is being released to pre-approved customers as part of the Beta Program. Please note that the documentation and the product are subject to change. For more details about the program, please contact your Genesys representative.

You can find out about changes in each release in the Resource Center article, Billing Data Service Release Notes.

Announcements