Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.

Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

Configuration prerequisites

After you have completed the steps in Installing Billing Data Server (BDS), carry out the steps described on this page. These steps must be complete before you configure BDS.

Regions and locations

Within each tenant configuration, define a set of regions and locations in which the tenant is enabled.


In the globals section, define credentials at the top level in the following sections.

  • cme_credentials — the credentials to access all the Configuration Servers. The account must have at least read-only access to the schema, which must include:
    • If GVP metrics are enabled, the ability to read configuration options of the GVP Reporting Server. This is required to ensure the data is not yet purged.
    • If CME-based Voicemail box is enabled, read access to Agent Groups, Agent Logins under switches, and DNs under switches.
  • gimdb — the default credentials to access the Genesys Info Mart (GIM) databases. The account must have at least read-only access to the schema.
  • gvpdb — the default credentials to access the Genesys Voice Platform (GVP) Reporting Server. The account must have at least read-only access to the schema.
  • gws — (optional) credentials for authorization to GWS, including the following:
    "host": "",
    "grant_type": "client_credentials",
    "client_id": "<gws client name>",
    "client_secret": "<encrypted password>",

Tenants configuration

Configure the following to support GWS authentication. On top or location levels:

  • Define the environment identifier (env_id) in the tenant contact_center_id field. If these fields are specified at the location level, they are used instead of global ones.

On location levels:

  • Define GWS credentials.

The interface of the provider is selected based on the configuration of tenants:

  • If the configuration has credentials for GWS, the PlatformConfigAPI interface is selected. Otherwise, ConfigDataExtractor is selected.
  • If credentials for providers are defined at the level of individual locations in tenant configurations, Global credentials for providers are ignored.

GVP section

For each top level location, define the following shared GVP deployment details in the gvp section:

  • Configuration Server parameters
  • GVP Reporting Server database parameters
  • Credentials (inherited from the gvpdb section under the globals section)

Reporting Server database

Globally defined GVP Reporting Server database parameters for each location and default credentials are propagated down to the tenant level, and can be overridden on that level.  In addition, each tenant has a shared_gvp flag that has default value of true:

  • In on-premise deployments, always set shared_gvp to false.
  • Do not populate (leave empty) the shared_gvp_alias parameter, as it is not used to configure premise tenants.

MCP configuration

Configure the Media Control Platform (MCP) to send the required events to the Reporting Server, as follows (BDS does not validate the configuration, but it must be populated):


Validate the availability of the events based on the retention period of the event records, as configured in the Reporting Server:


Database configuration

BDS works with the following database (db_type) types:

  • sql_server
  • postgre
  • Oracle

BDS uses the following corresponding drivers (driver_name):

  • FreeTDS
  • PostgreSQL
  • OracleODBC-12.1

Business unit billing breakout configuration

The presence of the "business_units" attribute on the tenant level of the BDS configuration causes BDS to generate additional billing information on a business unit level. Configure this attribute to contain a list of business units names, for example:

    "tenants": {
        "tenant_with_units": {
            "tenant_id": "111",
            "tenant_name": "tenant_with_units",
            "business_units": ["unit_1","unit_2"],

To calculate billing metrics on a business unit level, each metric requires underlying datasets in addition to those already configured. For that purpose, the additional datasets needed for business unit level calculations specifically can be added to a metric definition under a separate "bu_datasets" section. The datasets listed in the "bu_datasets" section are extracted only if that tenant has the "business_units" parameter configured with at least one value, as follows:

    "metrics": {
        "<metric_name>": {
            "datasets": [
            "bu_datasets": [

Configuration Management Environment (CME) configuration prerequisites

The configuration folder structure is defined in the configuration database, and must store billing-related configuration objects in folders named as business units. Billable activity is attributed to the business unit based on the presence of the business unit name in the path to the configuration object linked to that particular activity. This requirement applies to configuration objects of the following types:

  • DN - should be located in CME under the paths as: Switches/<switch name>/DNs/../<business unit name>/...
  • Agent Login - should be located in CME under the paths as: Switches/<switch name>/Agent Logins/../<business unit name>/...
  • Person - should be located in CME under the paths as: Persons/../<business unit name>/...
  • Agent Group - should be located in CME under the paths as: Agent Groups/../<business unit name>/...
This page was last edited on October 30, 2019, at 16:25.


Comment on this article:

blog comments powered by Disqus