CRS configuration

This page describes configuration for CRS installation. See also the page Data management and backup for further information.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg We highly advise you that you make a backup of "DeploymentConfig" folder once the configuration is finished. The backup of your original settings will be very useful in case of CRS recovery or update and it shall be stored in the safe location.

Global configuration

DeploymentConfig\env.ini:

//Enables services startup at the end of installation.
startupServicesAfterInstall= true
 
//SMTP configuration
mailServer=<SMTP_IP_ADDRESS>
mailServerBackup=<SMTP_BACKUP_IP_ADDRESS>
mailFrom=<MAIL_FROM>
mailUser=<USER>
mailPass=<USER_PASSWORD>
 
// If SSL or TSL is enabled, it is used for communication with the SMTP mail server. SSL or TLS must be enabled also on your mail server.
// Both properties mailSmtpSsl and mailSmtpTls should not be enabled at once.
mailSmtpSsl = false
mailSmtpTls = false
 
//Administrator e-mail address where system will send alerts (eg. if a printer fails).
adminEmail=<ADMIN_EMAIL>
 
//If send-email-after-startup is enabled, an e-mail will be sent to adminEmail each time the SafeQ service starts.
//Do not enable this feature unless you are sure that adminEmail and mailserver options are configured correctly.
send-email-after-startup=true
 
// Localization
// supported languages: cs,en,sk,es
int_languages= en
int_defaultLanguage= en
 
// currency - USD($ %) 840, EUR(€ %) 978, CZK(% Kč) 203, GBP(£ %) 826, HUF(% Ft) 348
// character ¤ will be replaced by int_currency variable
int_currency_fmt=¤%
int_currency=$
int_currency_name = USD

Note: If a mail server does not require authentication, do not specify mailUser and mailPass properties. Otherwise an authentication error from mailserver appears and sending fails.

Open DeploymentConfig\crs\env.ini and enter all necessary configurations.
WARNING: In paths, use a single slash ( / ) or double backslash ( \ \ ). DO NOT USE a single backslash ( \ ).

//Internal sybsystem identification parameter (Do not edit this parameter.)
subsystem = CRS
 
//Database engine installation type
//(Do not edit this parameter because only the external MSSQL database engine is supported for the CRS subsystem.)
embeddedDBInstall = false
 
//Database instance creation type (For the first installation, use the *clean-full-cluster* value.)
databaseInstanceType = clean-full-cluster
 
//clean-full-cluster:
// Creates empty database instances yBoxDB and yBoxDBCDC.
// Executes initial SQL scripts. After installation, performs database validation.
//existing-db:
//Connects to existing database instances yBoxDB and yBoxDBCDC with no changes;
//yboxDBRep will be created from scratch.
 
// MSSQL DB version (For the first installation, use the *autodetect* value.)
dbVersion = autodetect
//Allowed values: \\
// MSSQL 2008 = 10.0
// MSSQL 2008 R2 = 10.50
// MSSQL 2012 = 11
 
//MSSQL DB edition (required for correct cube installation/upgrade)
dbEdition = autodetect
//Allowed values:
// standard = 2*
// enterprise = 3*
 
//Enables installation of reporting services (database
//repDbName, replication, reports & builder components in MSSQL)
//default false
installReportingServices = true
 
//path to binn directory of installed MS SQL Server
//for x64 bit platforms this path must be set
//to 32bit version, e.g. c:\\Program Files (x86)\\Microsoft SQL Server\\100\\DTS\\Binn\\
//use \\ instead of single / as a directory separator
//default "" (Binn directory is by default in PATH variable)
crs-database-path =
 
//Target (installation) directory of CRS node
//Required field
targetDir = C:/SafeQCRS
 
//if branch is not known for CDC server, should it create one? [default=true]
cdc-register-new-branch = true
 
//year from we have data in DWH [yBoxDBCDC]
dataYearStart = 2011

In the same env.ini file, enter all required values in the Database connection settings sections:

//Database type identification (The only allowed value for the CRS subsystem is *MSSQL*.)
dbClass=MSSQL
 
//JDBC driver class (Do not edit this parameter.)
dbDriver=net.sourceforge.jtds.jdbc.Driver
 
//relation database server for CRS (IP address or hostname of server with MSSQL database)
sqlDbServer = 127.0.0.1
 
//SQL server instance
//if default instance is used, leave this string empty.
//if a custom server instance is used, set the parameter to instance=<INSTANCE_NAME>, e.g.
//sqlDbInstance = instance=MYINSTANCE
//the whole value becomes part of the DB connection URL
sqlDbInstance =
 
//relation database server name for CRS
sqlDbServerName = test
 
//Database port (Use the default port: *1433*.)
dbPort=1433
 
//Database encoding (Use *UTF-8*.)
dbEncoding=UTF-8
 
//Database account name for CRS service (default: *sa*)
dbUser=
 
//Database account password for CRS service
// (If empty, the password will be set during the installation process.)
dbPass=
 
//Operational database instance name (Use the default values.)
dbName=yBoxDB
 
//CDC database instance name(Use the default values.)
cdcDbName=yBoxDBCDC
 
//CDC database owner (If the username is sa, enter dbo.)
cdcDbOwner=dbo
 
//how many calendar years will be in DWH [yBoxDBCDC]
//default is 1
archiveDataYears = 1
 
//is DWH [yBoxDBCDC] backup enabled
//default is true
enableDBBackup = true
 
//backup path db + cube
cdcDbBackupPath = c:/SafeQCRS/backup/
 
//is DWH [yBoxDBCDC] cleanup enabled
//default is true
enableDBCleanup = true

In the same env.ini file, enter all required values in the Cube & package settings sections:

//olap database server
olapDbServer = 127.0.0.1
 
//relation database user for CRS (empty = dbUser)
olapSqlUser =
 
//relation database password for CRS (empty = dbPasswd
olapSqlPasswd =
 
//olap database domain user for CRS (empty value = current user)
olapDomainUser =
 
//olap database domain password for CRS
olapDomainPasswd =
 
//olap full cube template path
//cdcCubeTplPath = @targetDir@\scripts\CUBE\4_cubecreate\
//see Utils.setupEnv4CRS
 
//CDC cube name
cdcCubeName = SafeQCDC
 
//Job name
//needed for 'cdc-build-cube = spstartjob' option
//default: BuildCubeSafeq
cdc-jobname = BuildCubeSafeq
 
//CDC server domain
cdcServerDomain =
 
//how old full cube is archived, number of monthes, default 3
cdcArchiveCubeMonths = 3
 
//if we delete old full cubes, 0/1, default 1
cdcDeleteOldCubes = 1
 
//enables installation and processing of Cube RV
enableCubeRV = false
 
//how many calendar years will be in cube
//default is 1
cdcArchiveCubePeriod = 1
 
//is base cube backup enabled
//default is 1
cdcEnableBackupCubeBase = 1
 
//is full cube backup enabled
//default is 1
cdcEnableBackupCubeFull = 1
 
//is base cube cleanup enabled [1 - yes, 0 no]
//default is 1
enableBaseCubeCleanup = 1

In the same env.ini file, enter all required values in the Integration services settings sections:

//integration database server
intDbServer = 127.0.0.1
 
//relation database user for CRS (empty = dbUser)
intSqlUser =
 
//relation database password for CRS (empty = dbPasswd)
intSqlPasswd =
 
//Type of cube processing
//allowed values: safeq (local MSSQL), spstartjob (external MSSQL), none (other)
//default: safeq
cdc-build-cube = safeq
 
//CDC package name
//needed for 'cdc-build-cube = safeq' option
//default: PackageBuildCubeSafeq
cdcPackageName = PackageBuildCubeSafeq

In the same env.ini file, enter all required values in the Reporting services settings sections:

//reporting database server
repDbServer = 127.0.0.1
 
//relation domain user for reports (empty = dbUser)
repDomainUser =
 
//relation domain user for reports (empty = dbPasswd)
repDomainPasswd =
 
//relation database user for reports (empty = repDomainUser)
repSqlUser =
 
//relation database password for reports (empty = repDomainPasswd)
repSqlPasswd =
 
//replication folder, publisher-subscriber
//repFolder = @targetDir@\replication\
//see Utils.setupEnv4CRS
 
//database name for reporting services
repDbName=yBoxDBREP
 
//publisher name used for replication
repPubName=SafeQREP
 
//Name of report builder
//default is "SafeQ Report Builder"
repBuildName=SafeQ Report Builder
 
//Name of reports
//default is "SafeQ Reports"
repReportsName=SafeQ Reports
 
//domain name of report server
//default is localhost
repServerDomain = localhost
 
//virtual dir of report server
//default is ReportServer
repVirtualDir = ReportServer
 
//if branch is not known for CDC server, should it create one? [default=true]
cdc-register-new-branch = true
 
//number of decimal places displayed in web reports
cdcPricePrecision = 2
 
//enable/disable DB optimization on CRS, default false
//should nbe enabled for external DB engines
disableCRSDBOptimization = false
 
 
//Each of these properties will list the email addresses that will receive an email
//notification once the data reception / data processing after reception is finished
//successfully / with an error. (When the property is empty, the notification will not be sent.)
 
//notify-receive-success-recipients = example@email.com
notify-receive-success-recipients = 
 
//notify-receive-failure-recipients = example@email.com
notify-receive-failure-recipients = 
 
//notify-process-success-recipients = example@email.com
notify-process-success-recipients = 
 
//notify-process-failure-recipients = example@email.com
notify-process-failure-recipients =
 
//CDC ENT type (true/false)
cdc_enable_enterprise = true
 
//Mappings setting - these tables would be mapped in ent CDC
cdc-mappings-ent = users_user;smartq_devices;smartq_devices_groups;safeq_projects;smartq_stats_filetype;users_ou;smartq_servers;smartq_cdc_counters;safeq_data_repair_cdcstats;safeq_stats_bad_safeq_projects;safeq_stats_bad_smartq_devices_groups;safeq_stats_bad_smartq_devices;safeq_stats_bad_smartq_stats_filetype;safeq_stats_bad_users_ou;safeq_stats_bad_users_user;safeq_subdata_bad_smartq_devices;safeq_subdata_bad_users_user;
cdc-mapping-ent-users_user = 3;login
cdc-mapping-ent-smartq_devices = 3;ip_address
cdc-mapping-ent-smartq_devices_groups = 3;name
cdc-mapping-ent-safeq_projects = 3;code
cdc-mapping-ent-smartq_stats_filetype = 3;prefix
cdc-mapping-ent-users_ou = 3;name
cdc-mapping-ent-smartq_servers = 3;code
cdc-mapping-ent-smartq_cdc_counters = 3;id
cdc-mapping-ent-safeq_data_repair_cdcstats = 3;id
cdc-mapping-ent-safeq_stats_bad_safeq_projects = 3;id
cdc-mapping-ent-safeq_stats_bad_smartq_devices_groups = 3;id
cdc-mapping-ent-safeq_stats_bad_smartq_devices = 3;id
cdc-mapping-ent-safeq_stats_bad_smartq_stats_filetype = 3;id
cdc-mapping-ent-safeq_stats_bad_users_ou = 3;id
cdc-mapping-ent-safeq_stats_bad_users_user = 3;id
cdc-mapping-ent-safeq_subdata_bad_smartq_devices = 3;id
cdc-mapping-ent-safeq_subdata_bad_users_user = 3;id
 
//enable/disable generating basic reports in CRS
enable-reporting-services = false
 
//how many calendar years will be in web reports
//default is 1
archiveReportsYears = 1
 
//is web reports cleanup enabled
//default is true
enableReportsCleanup = true

Open DeploymentConfig\crs\TEST\node1\env.ini and edit all required attributes.

//unique CRS GUID
GUID = TEST-CRS
 
//IP address of installed CRS server
smartQ-server-ip =
 
//CRS server name
smartQ-server-name =
 
//Additional CRS server info (Keep this setting's default.)
smartQ-server-id = 1
smartQ-server-dbflag = 2

Save and close the env.ini file and continue to the next step.