Jump to: navigation, search

Configuring BDS

Before Billing Data Server (BDS) is ready to use, you must complete the steps described on this page to provision global and tenant configuration values. This page describes the initial configuration of BDS. For subsequent configuration changes or maintenance activities, see the Billing Data Server User's Guide.

This page describes how to configure BDS to run in an offline subscription mode, or in an on-premise mode, which stores files only in a local path, but supports an extended set of metrics. For more information about how BDS works in on-premise deployments, see the Billing Data Server User's Guide.

Using the Configuration wizard

In BDS release 9.0.002.01 and later, use the information in this section to configure BDS. In earlier releases, configure BDS manually. The BDS configuration wizard is a script (brsctl.py setup) that helps you to easily configure BDS. The wizard allows you to create a new configuration, but does not support modification of an existing configuration for previous BDS. To make changes to an existing configuration, see the section that describes configure BDS manually.

Important
All brsctl.py commands mentioned in this procedure must be executed in configuration mode. For more information, see the Procedure to set configuration mode.

Procedure: Configure BDS using the Setup wizard

Purpose: Use the steps in this procedure to create and populate configuration files.

Prerequisites

  • Execute the following command to launch BDS in configuration mode:
    ./cloudbilling-prem.sh config
  • Create an encryption token. To do so, execute the following command:
    python3 /genesys/bin/generate_keys.py
    BDS generates a token, and saves it in the path defined as the value of the crypto_key_path parameter in gvars.py. This token is subsequently used to encrypt and decrypt BDS keys and passwords.

Steps

  1. At the command-line prompt, enter the following command to launch the configuration wizard:
    python3 brsctl.py setup
    The configuration wizard starts. You can cancel the wizard at any time by entering q at the prompt.
    When prompted, enter appropriate responses by referring Configuration Wizard prompts.
    • The script automatically extracts the appropriate templates for the mode you choose.
    • The credentials you use must have user account privileges as follows:
      • Database user accounts that BDS uses to extract data from Genesys Info Mart and Genesys Voice Platform (GVP) databases now require only read-only access to the schema.
      • User accounts that BDS uses to connect to Configuration Server now require only read-only permissions, as follows:
        • If gvp metrics are enabled, access to read configuration options of the GVP Reporting Server to ensure the data is not yet purged.
        • If configuration-based Voicemail box is enabled, access to read Agent Groups, Agent Logins under switches, and DNs under switches.
  2. Once you have completed all of the configuration steps, the wizard saves the configuration files to the locations you specify at the relevant prompt.

Configuration Wizard prompts

Configuration Wizard allows you to configure BDS through a series of prompts (questions) in the command-line prompt. Provide appropriate input values for the prompts by referring the descriptions in the following table.

Prompt Description
Which type of subscription is yours?

1. Subscription
2. Extended
Default is "2". Leave empty for default.

Specify the subscription type.
  • Select 1, if your subscription type is only Subscription.
  • Select 2, if your subscription type is either Subscription or Extended. By default, option 2 is set.

If this prompt is left empty or unanswered, the configuration proceeds by considering the default value, that is, 2.

Region name. Example: "eu" Specify the region name (mandatory) in lowercase. The Region Name you provide here is used as an identifier for the Genesys IT Processing team to refer and process the data in the backend.

The valid region names currently supported are us, eu, ap, au (lowercase only).
Note: The region name us supports Latin American countries as well.

dc name. Example: "ash" Specify the data center name as configured in the Configuration Server. For example, LON, FRA, SJC, and so on.

This is an identification input to process the data in the backend.

switches: Specify the Switch values as configured in the Configuration Server for a particular region/location. Multiple switches can be specified as comma-separated values.

The wizard does not automatically populate the Switch values, you must specify them manually. Note: This option can be left empty (that is, [ ]). If left empty, then all the switches from datasets will be billed. If there are multiple locations, then only the switches in the default location can be empty, you must provide switches for other locations.

dc_aliases:

Default is "[]". Leave empty for default. List of aliases used for this location.

(for multi-region deployments only) An optional prompt to specify the list of aliases (datacenter names) used for that location in multi-region deployments. The value you provide here is required for control validation, Genesys Interaction Recording (GIR) data extract, etc.
Do you have Elastic Search for this location? Yes(y)\No(n) Select Yes (y), if your region has GIR, otherwise select No (n).
Do you have GVP server for this location? Yes(y)\No(n) Select Yes (y), if your region has GVP, otherwise select No (n).
shared_cs_primary_host:


Primary CS hostname. Example: "cm-primary-01" or "10.1.1.2".

Provide the host name of the primary Configuration Server. Do not provide the IP address, only host names are validated.
CS user. Will be used from the global parameters if value is empty. Specify the username to log in to the Configuration Server.
CS password. Will be used from the global parameters if value is empty. Specify the password for the corresponding user to log in to the Configuration Server. The input password will be ciphered and hidden.
gvp_primary_rs_name:


Primary GVP RS Name. Example: "rs-primary-01" or "10.1.1.2"

Specify the GVP Reporting Server (RS) application name as configured in the Configuration Server. If GVP RS is not applicable, leave this prompt blank.

Do not provide the IP address, only GVP RS application names are validated.

db_type:

1. sql_server
2. postgre 3. oracle Default is "1". Leave empty for default. GVP database platform.

Select the database type of GVP RS. Currently supported database types are: sql_server, postgre, and oracle.
GVP database password. Specify the password to log in to GVP RS database. The input password will be ciphered and hidden.
tenant_id:

Tenant ID. Example: "123"

Specify the tenant ID of the Tenant you are configuring. The Tenant ID is a unique identifier for each of the customer’s Tenants, including Production and Lab environments. Obtain this value from Genesys.
Do you want to use shared GVP? Yes(y)\No(n) Specify whether you want to share GVP between multiple tenants.
  • Select Yes(y), if you want to configure GVP as a shared resource between multiple tenants.
  • Select No(n), if you want to configure a dedicated GVP for each tenant.
shared_gvp_alias:

Shared GVP alias name. Example: "Tenant_123"

Specify the shared GVP alias name. This is an optional prompt that gets the tenants' DB Ids list if it had failed to get directly or by using tenant’s name.
contact_center_id:

The contact center ID of the tenant. Example: "b7f9c3cc-49c3-11eb-9cd7-3b392a8f9437

Specify the Contact Center ID (CCID) provisioned in Genesys Web Services (GWS). This is a mandatory prompt to be answered if your deployment is using GIR and you're configuring Genesys Web Service (GWS), otherwise optional. Leave it blank if you are not configuring GWS. CCID is required for measuring recording metrics only.

You can get CCID by running the following command:

curl --user $gwsAdminName:$gwsAdminPass --request GET '$authURL/environment/v3/contact-centers'

Alternatively, refer to the Get contact center ID from GWS page for a detailed procedure.

primary_location:

Name of the default location

Specify the primary location name. If primary location name is not defined in the globals section, BDS refers the credentials from the primary location name you specify here. BDS requires this credentials to establish a connection to Consul, CME, or GWS.

Note: When establishing a connection to GWS or Consul, if there are multiple location names available, BDS first checks the primary_location parameter that points the location name where BDS must refer for the credentials. If primary location is not specified (left blank here), or if the specified location has no credentials configured, then BDS refers the globals section for the connection parameters.

PrimaryLocation.png
business_units:

Default is "[]". Leave empty for default.
List of the business units name. Example: BU1, BU2

Specify the list of business units name as configured in the Configuration Server. Specify the list in a comma-separated format. For example, BU1, BU2.

You can leave this prompt blank, if Business Unit is not used in your organization. The wizard does not automatically populate the Business Unit values, you must specify them manually.

Do you have SFTP for this tenant? Yes(y)\No(n) Specify whether you use SFTP to transfer the BDS reports.
  • Specify Yes(y) if your organization pushes data either to a Genesys SFTP folder directly or to an internal SFTP folder.
  • Specify No(n) if your organization does not want to use SFTP to transfer BDS reports.
production_date:

Default is "2022-01-31". Leave empty for default. First day when tenant's activity should be billed.

The date from which BDS starts processing the data if watermarks are not available. Once watermarks are available, BDS starts referring to the watermark dates and ignore the production date value set here. If left blank, BDS picks the default date and process the reports.
extract_watermark:

Default is "2022-01-31". Leave empty for default. Last successfully extracted date.

Specify the date in yyyy-mm-dd format. This is the date in which BDS will extract the first set of data.

Default on the first creation of the watermark. Records up to which date each step of extract transform and load needs to be started. This start date tells BDS what would be the date from which the data needs to be extracted up to yesterday.

Number of contracted IVR ports
This option is required only for cloud deployments; for other deployments, specify '0'.
ivr_usage_profiles:

Default is "['000']". Leave empty for default.Comma-separated list of IVR profiles to extract.

Specify the default IVR Application ID (dbid) from Configuration Server. Multiple values should be comma separated. For example,
"ivr_usage_profiles": [
"114", "122"]

Note: ivr_usage_profiles is used for filtering during the transformation stage.

Configure BDS manually

In BDS release 9.0.001.05 and earlier, use the procedures in this section to configure BDS. In later releases, use the wizard.

Configuration information is stored in a file called config.json, which comprises several nodes, or sections, structured as follows:

{
    “globals”: {. . .},
    “regions”: {
        “region_name”: {
            “location_name”: {. . .}
         }
         . . .
    },
    “metrics”:  {. . .},
    “tenants”: {	
         “tenant_name”: {
             “region_name”: {
                 “location_name”: {. . .}
              }
              . . .
          }
     }
}

You must generate and populate a template for each section in the config.json file, using the command-line Control utility, brsctl.py (for more information, see Configuration: the Control utility). BDS provides a number of predefined templates for this purpose — to view a list of the configuration templates in the current software release, execute the following command at the command-line prompt:

python3 brsctl.py template -l

A list of available templates appears, similar to the following:

Available templates:
1. globals
2. regions
3. location
4. metrics
5. tenants

The procedures on this page provide instructions to help you add and populate the templates that are needed in most on-premise deployments.

Procedure: Set the configuration mode

Purpose: Use the steps in this procedure to ensure that BDS is in the correct configuration mode for on-premise deployment.

Steps

  1. Open the file ./cloudbilling-prem.local/etc/gvars.py.
  2. Verify that the lines that define cfg_mode and cfg_file, are set as follows:
    cfg_mode = 'file'
    cfg_file = '/genesys/etc/config.json'
  3. Execute the following command to launch BDS in configuration mode:
    ./cloudbilling-prem.sh config
    An interactive prompt appears.

Procedure: Create and import the globals template

Purpose: Use the steps in this procedure to generate the template for the globals section of the config file. Note that, while config.json is the default name for the main configuration file, and Genesys recommends that you always use this name and the default path, you can optionally configure another file name and path.

Steps

  1. At the command-line prompt, enter the following command to generate the globals template:
    python3 brsctl.py template -t   globals -f   /genesys/etc/globals.json

    Console output should include a string similar to: Successfully exported to globals.json.

  2. Open the newly-created globals.json file for editing. It should contain the following text:
    {
        "globals": {
            "mode_settings": {
                "subscription": "", 
                "local_extract_path": "", 
                "local_transform_path": "", 
                "local_cache": ""
            }, 
            "gimdb": {
                "db_type": "sql_server",
                "driver_name": "FreeTDS",
                "username": "user_name",
                "password": "some_password"
            }, 
             "gvpdb": {
                "db_type": "sql_server", 
                "driver_name": "FreeTDS", 
                "username": "", 
                "password": ""
            }, 
            "cme_credentials": {
                "username": "", 
                "password": ""
            }, 
            "elasticsearch": {
                "hosts": "http://sample_host.generic.com:80"
            }
        }
    }
  3. In the mode_settings section of the file, populate each of the parameters listed in the table Premise parameters in the globals.json file. In release 9.0.001.01 and earlier, this section of the file was named premise.
  4. Provide valid credentials. The credentials you enter must be encrypted and have user account privileges as follows:
    • Database user accounts that BDS uses to extract data from Genesys Info Mart and Genesys Voice Platform (GVP) databases now require only read-only access to the schema.
    • User accounts that BDS uses to connect to Configuration Server now require only read-only permissions, as follows:
      • If gvp metrics are enabled, access to read configuration options of the GVP Reporting Server to ensure the data is not yet purged.
      • If configuration-based Voicemail box is enabled, access to read Agent Groups, Agent Logins under switches, and DNs under switches.
    • Encrypt all passwords using the brsctl utility, and enter them as cyphertext. To generate an encrypted password:
      1. Execute the following commands to create the encryption token:
        python3 /genesys/bin/generate_keys.py
        BDS generates a token, and saves it in the path defined as the value of the crypto_key_path parameter in gvars.py. This token is subsequently used to encrypt and decrypt BDS keys and passwords.
      2. Execute the following command at the command-line prompt:
        python3 brsctl.py encrypt
        Console output provides the encrypted password, for example:
        $ python3 brsctl.py encrypt
        *#:Password: gAAAAABdJI3cT5HR3K3z226uUpiz0PT57UtQTZXRbjIlYJWHd0vuPaW7YlUqwmTOYyYrvqpNth1H-aZ02VZC6p619vNTlcV0Mg==
      3. Copy the encrypted password string to each appropriate password field in the gimdb, gvpdb, and cme_credentials sections of the globals.json file.
  5. Once you have populated all of the required parameters, save the globals.json file.
  6. Execute the following command to import the values from globals.json into config.json:
    python3 brsctl.py config -i /genesys/etc/globals.json

    Console output should include a string similar to: Config from "globals.json" successfully imported.

  7. Execute the following command to verify that globals configuration information was imported correctly:
    python3 brsctl.py config -l

    Console output should include a string similar to: DEBUG MainThread config.py:init: Read configuration from ./config.json.

Parameter Description
Premise parameters in the mode_settings section of the config.json file
''local_cache'': <path> Where <path> is the full path name to the folder where BDS stores results of the processing. Genesys recommends that this be the path to a folder that is mapped to the deployment host’s folder. Example: local_cache = /genesys/data/
"subscription": "true|false" Enables subscription type:
  • If true, only billable metrics that are applicable for Premise Subscription can be enabled.
  • If false, both the billable and usage metrics that are available as templates can be enabled, if the corresponding data sources are available.
"local_extract_path" : <extract> Where <extract> is the local path where the extracted files are stored. This is a relative path based on the local_cache value; for example, if local_cache = /genesys/data and local_extract_path = extract, then the extract path is /genesys/data/extract.

In release 9.0.001.01 and earlier, this parameter was named "premise_extract_path".

"local_transform_path" : <transform> Where <transform> is the relative local path where the transformed files are stored. This is a relative path based on the local_cache value; for example, if local_cache = /genesys/data and local_transform_path = transform, then the transform path is /genesys/data/transform.

In release 9.0.001.01 and earlier, this parameter was named "premise_transform_path". The local path where the transformed files are stored.

Procedure: Create and import region and location templates

Purpose: For tenant deployments, use the steps in this procedure to configure region and location parameters. Alternatively, you can modify and import the example templates that are provided in the BDS /genesys/templates directory.

Steps

  1. At the command-line prompt, execute the following command to generate the regions template:
    python3 brsctl.py template -t   regions -f /genesys/etc/regions.json

    Console output should include a string similar to: Successfully exported to regions.json.

  2. Open the newly-created regions.json file for editing.
  3. Populate the following parameters:
    • “put_region_label_here“ placeholder — a code for the region. For example “us”. In release 9.0.000.43 and earlier, this placeholder was named “put_region_name_here”.
    • “region_name” parameter — the name that will be used in the produced files. If BDS is used for subscription billing in either online or offline modes, ensure that the value you enter complies with codes defined in Genesys SFDC – for example, “US”, “EU”, “AP”. In release 9.0.000.43 and earlier, this parameter was named “location_name”.
  4. Save the regions.json file.
  5. For tenant environments with multiple regions, repeat the preceding steps for each region, saving each regions.json template file with a unique name.
  6. At the command-line prompt, execute the following command to generate the location template:
    python3 brsctl.py template -t location -f   /genesys/etc/location.json

    Console output should include a string similar to: Successfully exported to location.json.

  7. Open the newly-created location.json file for editing.
  8. Populate the parameters listed in the Location parameters table.
  9. Save the location.json file.
  10. For tenant environments with multiple locations, repeat the preceding steps for each location, saving each location.json template file with a unique name.
  11. Import the regions into the config.json file:
    python3 brsctl.py config -i  /genesys/etc/<regions.json>

    Where <regions.json> is the name of the regions file to import. Repeat this step for each regions template you created.

  12. Import the locations into the config.json file:
    python3 brsctl.py config -i /genesys/etc/<location.json>

    Where <location.json> is the name of the location file to import. Repeat this step for each locationtemplate you created.

  13. Execute the following command to verify that regions and location configuration information was imported correctly:
    python3 brsctl.py config -l

    Console output should include a string similar to: DEBUG MainThread config.py:init: Read configuration from ./config.json.

Parameter Description
Location parameters
“put_region_name_here“ placeholder The code for the region to which this location will belong. Use any of the regions defined in the regions.json files, for example “us”.
"country" parameter The code for the country to which this location will belong, as defined by ISO 3166-1 alpha-2.

This parameter is available in BDS release 9.0.000.37 and later.

“put_dc_name_here” placeholder The location code, for example "ash".
"dc_name" The region and location name, separated by a colon (:), for example "US:Ashburn". This parameter is deprecated in release 9.0.000.45 and later.
“switches” parameter A list of tenant switches for this location. For example [“Sip_switch”, “MultimediaSwitch”]. If this parameter is not populated, the location becomes a default location, and all activity is attributed to this location.
"dc_aliases” parameter A list of identifiers that can appear in various datasets, which serve to identify this particular location. Beginning with release 9.0.000.37, BDS compares values that correspond to an agent session in the Genesys Info Mart AGENT_LOCATION table with values in the dc_aliases lists of locations defined in the BDS configuration. If any of the values match, the agent session is attributed to the region to which the location belongs. If this method is not successful, BDS assigns a location based on the switch names and default locations, as it did in earlier releases.
Populate the remaining parameters (the GVP section) only if GVP metrics are enabled for tenant:
"shared_cs_primary_host", "shared_cs_backup_host", "shared_cs_port” Hosts and port of primary and backup Configuration Servers that contain configuration of a GVP server for the location.
"gvp_primary_rs_name" The name of the GVP Reporting Server application as specified in the configuration.
"db_type", "driver_name", "server", "port", "database" parameters The GVP RS database parameters.
“username” and “password” Credentials for the GVP RS DB (inherited from the gvpdb section under the globals section).
“ivr_usage_profiles” A mandatory parameter that must contain either a list the DBIDs of IVR usage profiles to be included into billing, or a value of 000, which causes all profiles to be included into the billing.
Note that 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.

Procedure: Import metrics templates

Purpose: Use the steps in this procedure to define the metrics for which the tenant(s) will be billed by BDS. All templates for metrics are provided in the BDS /genesys/templates directory.

Prerequisites

Review the available metrics, and determine for which metrics this customer should be billed.

Steps

  1. At the command-line prompt, execute the following command to import the metrics template:
    python3 brsctl.py config -i /genesys/templates/<metric_name>

    Where <metric_name> is the name of the data set to import, such as metric_voicemail_boxes.tpl. Console output should include a string similar to: Config from "../etc/metric_voicemail_boxes.tpl" successfully imported.

  2. Repeat the preceding steps for each metric.
  3. Examine the config.json file to ensure that the metrics have been added, for example:
    "metrics": {
            "voicemail_boxes": {
                "datasets": [
                   "voicemail_agents_groups"
                ], 
            "bu_datasets": [], 
                "scope": "global", 
                "frequency": "daily", 
                "load": true

Procedure: Provision and import tenant template

Purpose: Use the steps in this procedure to generate, populate, and import templates for tenants.

Steps

  1. At the command-line prompt, execute the following command to import the tenant template:
    python3 brsctl.py template -t tenants -f /genesys/etc/tenant.json

    Console output should include a string similar to: Successfully exported to tenant.json.

  2. Optionally, configure BDS to automatically upload billing files to the SFTP server. To do so, add the loader_sftp section to the config.json file, and define the SFTP server to which transformed files are automatically uploaded:
    "loader_sftp": {
                    "hostname": "",
                    "hostkey": "",
                    "path": "",
                    "port": "22",
                    "username": "",
                    "password": ""
                },

    For more information, see the Tenant parameters table. Note that, in release 9.0.003 and earlier, this section was named premise_loader_sftp.

  3. Populate each of the parameters listed in the table Tenant parameters.
  4. Execute the following command to import the tenant configuration into the config.json file:
    python3 brsctl.py config -i  /genesys/etc/tenant.json

    Console output should include a string similar to: Config from "tenant.json" successfully imported.

Parameter Description
Tenant parameters
"tenant_id" The ID of the tenant.
"production_date" The date on which tenant goes to production.
"cs_primary_host" The tenant primary CS host address.
"cs_backup_host" The tenant backup CS host address.
"cs_port" CS port, for example "8888".
"shared_gvp" Indicates whether tenant has shared GVP. Normally “false” in premise deployment. This parameter is required if GVP metrics are enabled for the tenant.
"shared_gvp_alias” The tenant alias in shared GVP environment. Specify this parameter only if “shared_gvp” is set to “true” and GVP metrics are enabled for the tenant.
"elasticsearch_hosts" Tenants GIR elastic search host. This parameter is required if GIR seats metrics are enabled for the tenant.
"business_units" A list of business units, for example: [“BU1”, “BU2”]. This parameter is required if the tenant is to be billed for multiple business units.
"extract_watermark" The last successful extraction date, should be greater or equal to production date.
"transform_watermark" The last successful transformation date, should be less or equal to the extract watermark, and greater than the production date.
"load_watermark" The last successful load date, should be less or equal to the transform watermark, and greater than the production date.
“contact_center_id” The tenant contact center ID, for example: "4d30c9d2-2ecf-4bd9-a210-f12d745aa013".

This parameter is required if GIR seats metrics or GWS are enabled for the tenant.

"gimdb" : "dap" Specify the Database Access Point (DAP) name configured in the Configuration Server to enable Genesys CX Insights (GCXI) reporting functionality. Ensure that the DAP configured must have an option gim-etl with a role INFO_MART. BDS uses the credentials from DAP’s DB Info properties.
"gimdb" : "db_type" Specify the database type of GIM DB. Supported values are: sql_server, postgre, and oracle
"gimdb" : "driver_name" Specify the DB driver, one of: 'FreeTDS', 'PostgreSQL' or 'OracleODBC-12.1'
"gimdb" : "server" Specify the GIM DB host.
"gimdb" : "port" Specify the GIM DB port.
"gimdb" : "database" Specify the name of GIM DB.
"gimdb" : "username" The user name for accessing GIM DB.
"gimdb" : "password" The password for the specified user name, in encrypted form (encrypted using brsctl.py).
'''loader_sftp''': "hostname" The hostname of the SFTP server to which the transformed files will be automatically uploaded, in the format "ftp.host.com".
'''loader_sftp''': "hostkey" The public key available for the SFTP server, which is used for additional authorization. It is an optional parameter. Public keys are available in the path: '/etc/ssh/*'. The value of the hostkey parameter value consists of two sections separated by a space:
  • First section: Specify the public key type. Supported key types are:
    • ecdsa-sha2-nistp256
    • ecdsa-sha2-nistp384
    • ecdsa-sha2-nistp521
    • ssh-ed25519
    • ssh-rsa, ssh-dss
  • Second section: Specify the actual value of the public key.

The following example shows the configuration of hostkey:
"hostkey": "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBP/4CFOOhQPL1L5SVpU8Y1H6SWaAQuCGieAWbC6/RqY1lX/2XyoE39owQgWPjFzEPatAoD5rSq6GoLbBCCMAnzE="

'''loader_sftp''': "path" The path on the SFTP server in which to store the files, for example "/BEC_RMS".
'''loader_sftp''': "username" A valid user name for the SFTP server.
'''loader_sftp''': "password" A valid password for the SFTP server, in encrypted form (encrypted using brsctl.py).
'''loader_sftp''': "port" The port to use on the SFTP server. (Default: 22)

Procedure: Modify an existing configuration

Purpose: This procedure to carry out common configuration changes.

Steps

  1. At the command-line prompt, execute one of the commands from the table Modifying the configuration.
  2. For additional information, see the brstcl Help, or The Control utility.
Desired result Example command
Modifying the configuration
Enable a tenant
python3 brsctl.py tenant -t <tenant_name> -on
Change tenant watermarks
python3 brsctl.py tenant -t <tenant_name> -ed <yyyy-mm-dd> -td < yyyy-mm-dd > -ld < yyyy-mm-dd >
Show all metrics
python3 brsctl.py metric -t <tenant_name> -ma -l
Enable region for a tenant
python3 brsctl.py region -on <region_name> -t <tenant_name>
Enable tenant location
python3 brsctl.py location -on <location_name> -t <tenant_name>
Enable and metric for a tenant
python3 brsctl.py metric -t <tenant_name> -m <metric_name> -on
Disable a metric
python3 brsctl.py metric -t <tenant_name> -m <metric_name> -off
Add business unit to a tenant configuration
python3 brsctl.py units -t <tenant_name> -a -u <business_unit_name>
Export a tenant configuration to file
python3 brsctl.py tenant -t   <tenant_name> -f /genesys/etc/tenant_export.json
Export the whole configuration to a file
python3 brsctl.py backup -f /genesys/etc/config_backup.json

Procedure: Provision passwords

Purpose: Use the steps in this procedure to create encrypted passwords. Encrypted passwords are required in later sections. Genesys strongly recommends that you never use plain-text unencrypted passwords in template file.

Steps

  1. To encrypt passwords, run the admin utility with the encrypt command, as follows:
    brsctl.py encrypt
  2. At the password prompt, type the plain-text password and press Enter.
    The utility displays the encrypted password.
  3. Copy and paste the encrypted password into the required locations, or record it in the template.
This page was last edited on April 14, 2022, at 11:48.
blog comments powered by Disqus