Jump to: navigation, search

Global variables

An outline of the configuration process of the Billing Data Server (BDS) in on-premise deployments is provided on the Configuring BDS for on-premise deployment page. This page describes part of that process in more detail: the configuration of relevant paths in the gvars.py file, located in the ~/cloudbilling-prem.local/etc/ directory.

Modify the following variables during the initial installation:

Global Variable Description Example
cfg_mode Ensure that this is set to file. file
cfg_file The full path and file name of the configuration file. Genesys recommends that you always store the configuration file in a folder that is mapped to the deployment host folder. fg_file = /vagrant/data/bds.json
premise In release 9.0.000.18 and earlier, set this variable to indicate that BDS is running in premise mode. Must be set to True.

For later releases, this setting is controlled in the configuration json file (see the table Premise Parameters) which is generated by PS during deployment:

True
local_cache The full path name of the folder where BDS stores processing output. Genesys recommends that you always direct this output to a folder that is mapped to the deployment host’s folder. local_cache = /vagrant/data/
premise_extract_path The name of a subfolder within the folder defined in the ‘local_cache’ variable. BDS uses this sub folder to store results of the data extraction. premise_extract_path= 'extract'
premise_transform_path The name of a subfolder within the folder defined in the ‘local_cache’ variable. BDS uses this sub folder to store results of the data transformation. premise_transform_path = 'transform’
online A flag to indicate where transformed data is stored. If set to True, the transformed data is saved to both S3 and local storage. If set to False, the transformed data is saved only to local storage. False
tmp_folder A folder where BDS temporarily stores intermediate processing results within the Docker container. tmp_folder = /tmp
LOG_FILE_MAIN The full path and file name of the main log file. Genesys recommends that you direct logs to a folder that is mapped to the deployment host’s folder by default. LOG_FILE_MAIN=/vagrant/log/bds.log
LOG_FILE_STATS The full path and file name of the log file where BDS stores additional statistics. Genesys recommends that you direct logs to a folder that is mapped to the deployment host’s folder by default. LOG_FILE_STATS=/vagrant/log/bds_stats.log
LOG_LEVEL This value controls how BDS filters information placed in the log file. Valid values: CRITICAL, ERROR, WARNING, INFO, and DEBUG. Genesys recommends that you set the log level to DEBUG, at least initially, to facilitate initial setup and troubleshooting. LOG_LEVEL=DEBUG
LOG_DAYS_TO_KEEP The number of days that BDS retains log data. The log file is rotated daily, and files older than this value are automatically deleted. log_days_to_keep = 30
enabled_seats_detailed_dir The folder in which BDS stores reports containing detailed information about agent login sessions that contributed to the monthly enabled seats result. Genesys recommends that you configure this variable to store reports in the mapped folder. /vagrant/data/seats_detailed
concurrent_seats_detailed_dir The folder where BDS stores reports containing detailed information about agent login sessions that contributed to the daily peak seats value. Genesys recommends that you configure this variable to store reports in the mapped folder. /vagrant/data/seats_detailed
SENSITIVE_ITEMS A list of item names that could possibly contain sensitive data. 'login', 'username', 'user_name', 'userid', 'user_id', 'employeeid', 'employee_id', 'agent_first_name', 'agent_last_name'
crypto_key_path The folder where, beginning with release 9.0.000.22, BDS stores the encryption tokens and keys used to decrypt and encrypt passwords. /vagrant/etc/crypto/
BUSINESS_UNITS_NAMES_BLACKLIST A 'blacklist' for business unit names. Business units that are added to the blacklist cannot be added or imported; this prevents errors during business unit name detection. 'agents', 'dns', 'persons', 'campaigns', 'switches','configurations', 'agent logins', 'campaign groups'

Premise parameters

Parameters in the Premise section of the Configuration json file control how data files are handled.

Parameter Description
Premise parameters in the Configuration json file
''local_cache'': ''path'' 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 = /vagrant/data/
"subscription": "true|false" Enables subscription mode:
  • If true, only a subset of metrics that are applicable for Premise Subscription can be enabled, and the subscription mode - offline or online - can be defined by a "subscription_mode" parameter.
  • If false, all the metrics that are available as templates can be enabled, if the corresponding data sources are available. Extract and transform files are stored only locally.
"subscription_mode" : "online|offline" Controls whether files are uploaded to S3:
  • If online, transformed results are stored locally, and automatically uploaded to S3.
  • If offline, extract and transform files are stored only locally.
"premise_extract_path" : 'extract' The local path to where the extracted files are stored.
"premise_transform_path" : ''transform'' The local path where the transformed files are stored.

Procedure: Provision passwords

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

Steps

  1. To encrypted 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.

Next Steps

Provision the Global settings.
This page was last modified on April 12, 2019, at 13:04.

Feedback

Comment on this article:

blog comments powered by Disqus