Configuring BDS for on-premise deployment provides an outline of the configuration process for on-premise deployment of the Billing Data Server (BDS). The first step for configuration of BDS is to configure the relevant paths in the gvars.py file, located in the ~/cloudbilling-prem.local/etc/ directory.
The following variables should be modified during the initial installation:
- cfg_mode : Must be set to file in the current version
- cfg_file : Full path name of the configuration file. Genesys recommends that BDS stores the configuration file, which gets updated during processing, in a folder that is mapped to the deployment host folder, so that this file wouldn’t get lost, or overwritten accidentally during, for instance, BDS upgrade. Example: cfg_file = /vagrant/data/bds.json
- premise : A variable indicating that BDS is running in premise mode. Must be set to True.
- local_cache : Path name to the folder, where BDS stores results of the processing. It is recommended that this is a path to a folder, which is mapped to the deployment host’s folder. Example: local_cache = /vagrant/data/
- premise_extract_path : Name of a subfolder under a folder defined in the ‘local_cache’ variable, where BDS stores results of the data extraction. Example: premise_extract_path= 'extract'
- premise_transform_path : Name of a subfolder under the a folder defined in the ‘local_cache’ variable, where BDS stores results of the data transformation. Example: premise_transform_path = 'transform’
- online : If set to true, the resulting transform files are saved to both S3 and local storage. If set to false, the resulting transform files are saved only to local storage.
- tmp_folder : Temporary folder for storing intermediate processing results within the Docker container. Example: tmp_folder = /tmp
- LOG_FILE_MAIN : Full path name of the main log file. Genesys recommends that it contains a path to a folder, which is mapped to the deployment host’s folder by default. Example: LOG_FILE_MAIN=/vagrant/log/bds.log
- LOG_FILE_STATS : Full path name of the log file with additional statistics. Genesys recommends that is contains a path to a folder, which is mapped to the deployment host’s folder by default. Example: LOG_FILE_STATS=/vagrant/log/bds_stats.log
- LOG_LEVEL : Controls the filtering of information placed in the log file. Valid values: CRITICAL, ERROR, WARNING, INFO, and DEBUG. It is recommended that the log level is turned on to DEBUG, at least during the first runs, and initial setup to allow effective troubleshooting. Example: LOG_LEVEL=DEBUG
- LOG_DAYS_TO_KEEP : Number of days to retain log data. The log file is rotated daily and files older than this value are automatically deleted. Example: log_days_to_keep = 30
- enabled_seats_detailed_dir : Folder for storing the reports with detailed information about the agents login sessions that contributed to the monthly enabled seats result. Genesys recommends to have that stored in the mapped folder. Example: /vagrant/data/seats_detailed.
- concurrent_seats_detailed_dir : Folder for storing the reports with detailed information about the agents login sessions that contributed to the daily peak seats value. Genesys recommends to have that stored in the mapped folder. Example: /vagrant/data/seats_detailed.
You must provision in encrypted form the passwords (and S3 keys) that need provisioning in later sections. Template file provisioning must not contain passwords in plain-text format. To obtain encrypted passwords, run the admin utility with the encrypt command: brsctl.py encrypt
The admin utility prompts you for password and prints out the encrypted password. Copy and paste it into the corresponding entry or record it in the template.
After configuring relevant paths, you must provision the Global settings.