Database config files documentation

cmldb.conf

key

description

database

dbId

Database identification; required. It has to be unique within JVM for every database. Two applications connected to the same database should have the same dbId.

PGSQL & MSSQL

dbClass

Database type identification; required. Values are PGSQL, MSSQL

PGSQL & MSSQL

dbDriver

JDBC driver class; required
for MSSQL net.sourceforge.jtds.jdbc.Driver
for PGSQL org.postgresql.Driver

PGSQL & MSSQL

dbURL

required; for PGSQL it's jdbc:postgresql://$dbServer:$dbPort/$dbName?charSet=$dbEncoding
for MSSQL it's jdbc:jtds:sqlserver://$dbServer:$dbPort/$dbName;instance=$sqlInstanceName where part ;instance=$sqlInstanceName is optional and is set up acording to $dbName value

PGSQL & MSSQL

dbUser

Database user login; required

PGSQL & MSSQL

dbPass

Database user password; required

PGSQL & MSSQL

dbEncoding

Database encoding; required

PGSQL & MSSQL

dbIp

Database server ip or server name; required

PGSQL & MSSQL

dbPort

Database server port; required

PGSQL & MSSQL

dbName

Database name; required

PGSQL & MSSQL

sqdb-ds-applicationName

Application name. No practical use, it's displayed by Enterprise Manager or Profiler associated with the connection

PGSQL & MSSQL

sqdb-ds-instance

Named instance to connect to

MSSQL

sqdb-ds-domain

Specifies the Windows domain to authenticate in

MSSQL

sqdb-ds-namedPipe

When set to true, named pipe communication is used to connect to the database instead of TCP/IP sockets; required

MSSQL

sqdb-ds-ssl

Specifies if and how to use SSL for secure communication

PGSQL & MSSQL

cdcDbName

Name of the CDC database (needed for the OLAP cube)

MSSQL

cdcDbOwner

Owner of the CDC DB objects (default: dbo)

MSSQL

dbValidator

If dbValidator property is set to true then every connection is validated by SQL call "SELECT 1". In case of database disconnection (e.g. database reset) connection is automatically refreshed.

PGSQL & MSSQL

validator-enabled

Database structure validator settings - if enabled, SafeQ check structure of database schema after start based on version defined in definition files.
It is strongly recommended to let it enabled otherwise some functionalities may not start correctly.

PGSQL & MSSQL

validator-makearchive

archives an old definition of views while replacing with a new definition

PGSQL & MSSQL

validator-deletearchive

clears definition in archives before running a new database validation cycle

PGSQL & MSSQL

dbDefaultConnectionTimeout

max duration of stale connection; default is 20 sec

PGSQL & MSSQL

dbValidatorConnectionTimeout

max duration of stale connection for dbValidator; default is 20 sec, 0 means use non-expirable connection

PGSQL & MSSQL

dbConnectionCleanerPeriod

connection are cleaned up after the specified time period; default is 10 sec

PGSQL & MSSQL

dbMaxConnections-SQDB

maximum connections hold by pool

PGSQL & MSSQL

dbMinConnections-SQDB

minimum connections hold by pool

PGSQL & MSSQL

sqdb-srvname

database server name

MSSQL

sqdb-dbowner

database owner

MSSQL

sqdb-dwsrvname

database server name

MSSQL

sqdb-dwdbowner

database owner for MSSQL sever for DWH database

MSSQL

dbConnTestCount

total number of database connection test attempts

PGSQL & MSSQL

dbConnTestDelayInSec

delay in seconds between connection test attempts

PGSQL & MSSQL

cmldb-cluster.conf

key

description

database

dbId

Database identification; required. It has to be unique within JVM for every database. Two applications connected to the same database should have the same dbId.

PGSQL & MSSQL

dbClass

Database type identification; required. Values are PGSQL, MSSQL

PGSQL & MSSQL

dbDriver

JDBC driver class; required
for MSSQL net.sourceforge.jtds.jdbc.Driver
for PGSQL org.postgresql.Driver

PGSQL & MSSQL

dbURL

required; for PGSQL it's jdbc:postgresql://$dbServer:$dbPort/$dbName?charSet=$dbEncoding
for MSSQL it's jdbc:jtds:sqlserver://$dbServer:$dbPort/$dbName;instance=$sqlInstanceName where part ;instance=$sqlInstanceName is optional and is set up acording to $dbName value

PGSQL & MSSQL

dbUser

Database user login; required

PGSQL & MSSQL

dbPass

Database user password; required

PGSQL & MSSQL

dbEncoding

Database encoding; required

PGSQL & MSSQL

dbIp

Database server ip or server name; required

PGSQL & MSSQL

dbPort

Database server port; required

PGSQL & MSSQL

dbName

Database name; required

PGSQL & MSSQL

sqdb-ds-applicationName

Application name. No practical use, it's displayed by Enterprise Manager or Profiler associated with the connection

PGSQL & MSSQL

sqdb-ds-instance

Named instance to connect to

MSSQL

sqdb-ds-domain

Specifies the Windows domain to authenticate in

MSSQL

sqdb-ds-namedPipe

When set to true, named pipe communication is used to connect to the database instead of TCP/IP sockets; required

MSSQL

sqdb-ds-ssl

Specifies if and how to use SSL for secure communication

PGSQL & MSSQL

dbValidator

If dbValidator property is set to true then every connection is validated by SQL call "SELECT 1". In case of database disconnection (e.g. database reset) connection is automatically refreshed.

PGSQL & MSSQL

dbDefaultConnectionTimeout

max duration of stale connection; default is 20 sec

PGSQL & MSSQL

dbValidatorConnectionTimeout

max duration of stale connection for dbValidator; default is 20 sec, 0 means use non-expirable connection

PGSQL & MSSQL

dbConnectionCleanerPeriod

connection are cleaned up after the specified time period; default is 10 sec

PGSQL & MSSQL

dbMaxConnections-SQDBCLUSTER

maximum connections hold by pool

PGSQL & MSSQL

dbMinConnections-SQDBCLUSTER

minimum connections hold by pool

PGSQL & MSSQL

cmldb-sqdw.conf

key

description

database

dbId

Database identification; required. It has to be unique within JVM for every database. Two applications connected to the same database should have the same dbId.

PGSQL & MSSQL

dbClass

Database type identification; required. Values are PGSQL, MSSQL

PGSQL & MSSQL

dbDriver

JDBC driver class; required
for MSSQL net.sourceforge.jtds.jdbc.Driver
for PGSQL org.postgresql.Driver

PGSQL & MSSQL

dbURL

required; for PGSQL it's jdbc:postgresql://$dbDwhServer:$dbDwhPort/$dbDwhName?charSet=$dbEncoding
for MSSQL it's jdbc:jtds:sqlserver://$dbDwhServer:$dbDwhPort/$dbDwhName;instance=$sqlInstanceName is optional and is set up acording to $dbDwhName value

PGSQL & MSSQL

dbUser

Database user login; required

PGSQL & MSSQL

dbPass

Database user password; required

PGSQL & MSSQL

dbEncoding

Database encoding; required

PGSQL & MSSQL

dbIp

Database server ip or server name; required

PGSQL & MSSQL

dbPort

Database server port; required

PGSQL & MSSQL

dbName

Database name; required

PGSQL & MSSQL

sqdb-ds-applicationName

Application name. No practical use, it's displayed by Enterprise Manager or Profiler associated with the connection

PGSQL & MSSQL

sqdb-ds-instance

Named instance to connect to

MSSQL

sqdb-ds-domain

Specifies the Windows domain to authenticate in

MSSQL

sqdb-ds-namedPipe

When set to true, named pipe communication is used to connect to the database instead of TCP/IP sockets; required

MSSQL

sqdb-ds-ssl

Specifies if and how to use SSL for secure communication

PGSQL & MSSQL

dbValidator

If dbValidator property is set to true then every connection is validated by SQL call "SELECT 1". In case of database disconnection (e.g. database reset) connection is automatically refreshed.

PGSQL & MSSQL

validator-enabled

Database structure validator settings - if enabled, SafeQ check structure of database schema after start based on version defined in definition files.
It is strongly recommended to let it enabled otherwise some functionalities may not start correctly.

PGSQL & MSSQL

validator-makearchive

archives an old definition of views while replacing with a new definition

PGSQL & MSSQL

validator-deletearchive

clears definition in archives before running a new database validation cycle

PGSQL & MSSQL

dbDefaultConnectionTimeout

max duration of stale connection; default is 300 sec

PGSQL & MSSQL

dbValidatorConnectionTimeout

max duration of stale connection for dbValidator; default is 20 sec, 0 means use non-expirable connection

PGSQL & MSSQL

dbConnectionCleanerPeriod

connection are cleaned up after the specified time period; default is 10 sec

PGSQL & MSSQL

dbMaxConnections-SQDB

maximum connections hold by pool

PGSQL & MSSQL

dbMinConnections-SQDB

minimum connections hold by pool

PGSQL & MSSQL

sqdb-srvname

database server name for MSSQL sever

MSSQL

sqdb-dbowner

database owner for MSSQL sever

MSSQL

sqdb-dwsrvname

database server name for MSSQL sever for DWH database

MSSQL

sqdb-dwdbowner

database owner for MSSQL sever for DWH database

MSSQL

dbConnTestCount

total number of database connection test attempts

PGSQL & MSSQL

dbConnTestDelayInSec

delay in seconds between connection test attempts

PGSQL & MSSQL

Configuration examples

Connect to MSSQL using windows credentials

User and sync must both have same domain. If you are not using domain use PC name instead.

Remember that when you are setting domain name to change dbURL also.

cmldb.conf

dbURL = jdbc:jtds:sqlserver://localhost:1433/SQDB5;appName=SafeQ;ssl=request;domain=MYPC
dbUser = dbuser
dbPass = # write user password
dbEncoding = UTF-8
dbIp = localhost
dbPort = 1433
dbName = SQDB5
sqdb-ds-applicationName = YSoft SafeQ 5
sqdb-ds-instance =
sqdb-ds-domain = MYPC
sqdb-ds-namedPipe =
sqdb-ds-ssl =
cdcDbName =
cdcDbOwner =
dbValidator = false
validator-enabled = true
validator-makearchive = true
validator-deletearchive = false
dbDefaultConnectionTimeout = 20
dbValidatorConnectionTimeout = 20
dbConnectionCleanerPeriod = 10
dbMaxConnections-SQDB = 100
dbMinConnections-SQDB = 10
sqdb-srvname=MYPC
sqdb-dbowner=dbo
sqdb-dwsrvname=MYPC
sqdb-dwdbowner=dbo
dbConnTestCount = 3
dbConnTestDelayInSec = 15

cmldb-cluster.conf

dbId = SQDBCLUSTER
dbClass = MSSQL
dbDriver = net.sourceforge.jtds.jdbc.Driver
dbURL = jdbc:jtds:sqlserver://localhost:1433/SQDB5;appName=SafeQ;ssl=request;domain=MYPC
dbUser = sync
dbPass = # write user password
dbEncoding = UTF-8
dbIp = localhost
dbPort = 1433
dbName = SQDB5
sqdb-ds-applicationName = YSoft SafeQ 5
sqdb-ds-instance =
sqdb-ds-domain = MYPC
sqdb-ds-namedPipe =
sqdb-ds-ssl =
validator-enabled = false
dbDefaultConnectionTimeout = 20
dbValidatorConnectionTimeout = 20
dbConnectionCleanerPeriod = 10
dbMaxConnections-SQDBCLUSTER = 20
dbMinConnections-SQDBCLUSTER = 0

cmldb-sqdw.conf

dbId = SQDBDW
dbClass = MSSQL
dbDriver = net.sourceforge.jtds.jdbc.Driver
dbURL = jdbc:jtds:sqlserver://localhost:1433/SQDB5_SQDW;appName=SafeQ;ssl=request;domain=MYPC
dbUser = sa
dbPass = # write user password
dbEncoding = UTF-8
dbIp = localhost
dbPort = 1433
dbName = SQDB5_SQDW
sqdb-ds-applicationName = YSoft SafeQ 5
sqdb-ds-instance =
sqdb-ds-domain = MYPC
sqdb-ds-namedPipe =
sqdb-ds-ssl =
#dbValidator = true
validator-enabled = true
dbDefaultConnectionTimeout = 300
dbValidatorConnectionTimeout = 300
dbConnectionCleanerPeriod = 10
dbMaxConnections-SQDBDW = 20
dbMinConnections-SQDBDW = 0

Connect to MSSQL instance

cmldb.conf

dbURL = jdbc:jtds:sqlserver://localhost:1433/SQDB5;appName=SafeQ;ssl=request;;instance=$sqlInstanceName
dbUser = dbuser
dbPass = # write user password
dbEncoding = UTF-8
dbIp = localhost
dbPort = 1433
dbName = SQDB5
sqdb-ds-applicationName = YSoft SafeQ 5
sqdb-ds-instance = myInstance
sqdb-ds-domain =
sqdb-ds-namedPipe =
sqdb-ds-ssl =
cdcDbName =
cdcDbOwner =
dbValidator = false
validator-enabled = true
validator-makearchive = true
validator-deletearchive = false
dbDefaultConnectionTimeout = 20
dbValidatorConnectionTimeout = 20
dbConnectionCleanerPeriod = 10
dbMaxConnections-SQDB = 100
dbMinConnections-SQDB = 10
sqdb-srvname=
sqdb-dbowner=dbo
sqdb-dwsrvname=
sqdb-dwdbowner=dbo
dbConnTestCount = 3
dbConnTestDelayInSec = 15

cmldb-cluster.conf

dbId = SQDBCLUSTER
dbClass = MSSQL
dbDriver = net.sourceforge.jtds.jdbc.Driver
dbURL = jdbc:jtds:sqlserver://localhost:1433/SQDB5;appName=SafeQ;ssl=request;instance=$sqlInstanceName
dbUser = sync
dbPass = # write user password
dbEncoding = UTF-8
dbIp = localhost
dbPort = 1433
dbName = SQDB5
sqdb-ds-applicationName = YSoft SafeQ 5
sqdb-ds-instance = myInstance
sqdb-ds-domain =
sqdb-ds-namedPipe =
sqdb-ds-ssl =
validator-enabled = false
dbDefaultConnectionTimeout = 20
dbValidatorConnectionTimeout = 20
dbConnectionCleanerPeriod = 10
dbMaxConnections-SQDBCLUSTER = 20
dbMinConnections-SQDBCLUSTER = 0

cmldb-sqdw.conf

dbId = SQDBDW
dbClass = MSSQL
dbDriver = net.sourceforge.jtds.jdbc.Driver
dbURL = jdbc:jtds:sqlserver://localhost:1433/SQDB5_SQDW;appName=SafeQ;ssl=request;;instance=$sqlInstanceName
dbUser = sa
dbPass = # write user password
dbEncoding = UTF-8
dbIp = localhost
dbPort = 1433
dbName = SQDB5_SQDW
sqdb-ds-applicationName = YSoft SafeQ 5
sqdb-ds-instance = myInstance
sqdb-ds-domain =
sqdb-ds-namedPipe =
sqdb-ds-ssl =
#dbValidator = true
validator-enabled = true
dbDefaultConnectionTimeout = 300
dbValidatorConnectionTimeout = 300
dbConnectionCleanerPeriod = 10
dbMaxConnections-SQDBDW = 20
dbMinConnections-SQDBDW = 0

Connect to PostgreSQL

cmldb.conf

dbId = SQDB
dbClass = PGSQL
dbDriver = org.postgresql.Driver
dbURL = jdbc:postgresql://localhost:5432/SQDB5?charSet=UTF-8
dbUser = dbuser
dbPass = # write user password
dbEncoding = UTF-8
dbIp = localhost
dbPort = 5432
dbName = SQDB5
sqdb-ds-applicationName = YSoft SafeQ 5
sqdb-ds-instance =
sqdb-ds-domain =
sqdb-ds-namedPipe =
sqdb-ds-ssl =
cdcDbName =
cdcDbOwner =
dbValidator = false
validator-enabled = true
validator-makearchive = true
validator-deletearchive = false
dbDefaultConnectionTimeout = 20
dbValidatorConnectionTimeout = 20
dbConnectionCleanerPeriod = 10
dbMaxConnections-SQDB = 100
dbMinConnections-SQDB = 10
sqdb-srvname=
sqdb-dbowner=dbo
sqdb-dwsrvname=
sqdb-dwdbowner=dbo
dbConnTestCount = 3
dbConnTestDelayInSec = 15

cmldb-cluster.conf

dbId = SQDBCLUSTER
dbClass = PGSQL
dbDriver = org.postgresql.Driver
dbURL = jdbc:postgresql://localhost:5432/SQDB5?charSet=UTF-8
dbUser = sync
dbPass = # write user password
dbEncoding = UTF-8
dbIp = localhost
dbPort = 5432
dbName = SQDB5
sqdb-ds-applicationName = YSoft SafeQ 5
sqdb-ds-instance =
sqdb-ds-domain =
sqdb-ds-namedPipe =
sqdb-ds-ssl =
validator-enabled = false
dbDefaultConnectionTimeout = 20
dbValidatorConnectionTimeout = 20
dbConnectionCleanerPeriod = 10
dbMaxConnections-SQDBCLUSTER = 20
dbMinConnections-SQDBCLUSTER = 0

cmldb-sqdw.conf

dbId = SQDBDW
dbClass = PGSQL
dbDriver = org.postgresql.Driver
dbURL = jdbc:postgresql://localhost:5432/SQDB5_SQDW?charSet=UTF-8
dbUser = dbuser
dbPass = # write user password
dbEncoding = UTF-8
dbIp = localhost
dbPort = 5432
dbName = SQDB5_SQDW
sqdb-ds-applicationName = YSoft SafeQ 5
sqdb-ds-instance =
sqdb-ds-domain =
sqdb-ds-namedPipe =
sqdb-ds-ssl =
validator-enabled = true
dbDefaultConnectionTimeout = 300
dbValidatorConnectionTimeout = 300
dbConnectionCleanerPeriod = 10
dbMaxConnections-SQDBDW = 20
dbMinConnections-SQDBDW = 0