Configuring the Reporting Database

Last published : Nov 13, 2026
To configure the reporting database, first install your Manager; second, configure the database; and third, configure the Manager to use the new database. Then, restart the Manager.

Install the Manager

  1. Install and configure your GridServer Manager. Restart the Manager after completing the installation.
  2. Ensure that the tables.<db>.sql file needed by the createdb script is in the DS_MANAGER/webapps/livecluster/WEB-INF/etc/db directory.

Configure the database

  1. Set the CLASSPATH on the Manager containing the Director that communicates with the database. The CLASSPATH must include the database driver JAR files applicable to your database. For example, to create an SQL Server database in a UNIX shell:
    export CLASSPATH=JDBCDriver/mssql-jdbc-13.4.0.jre11.jar
    replacing JDBCDriver with the actual path to the directory containing your driver JAR files.
  2. Run the createdb script provided in DS_MANAGER/webapps/livecluster/WEB-INF/etc/db directory on your Manager. Pass the name of the database properties file as an argument. Before you run the script, change the property file settings to match those of your database.
    Note:
    • Use the Microsoft JDBC Driver for SQL Server ( mssql-jdbc version 7.0 or later) for both the createdb step and the runtime connection. If you are using a Java 11 runtime, use the jre11 build included in version 7.1.1.
    • The JDBCDriver parameter specifies the path to the directory that contains the driver JAR file. Using the same driver version ensures consistency across the createdb process, the com.microsoft.sqlserver.jdbc.SQLServerDriver entry in the connection table, and the Active Directory (AD) authentication.

Configure the Manager

  1. Log in to the GridServer Administration Tool with an account that has a Security Role with the Manager Reconfigure feature enabled.
  2. Go to Admin > System Admin > Manager Configuration > Database.
  3. Configure the values in the Reporting Database Connection section using the appropriate table below. Note that hostname is the hostname and database is the name of the database.
    Oracle
    Property Value
    URL jdbc:oracle:thin:@hostname:1521/database
    Driver oracle.jdbc.OracleDriver
    Transaction Isolation TRANSACTION_READ_COMMITTED
    Microsoft SQL Server
    Property Value
    URL jdbc:sqlserver://hostname:1433;DatabaseName=dbName;SelectMethod=cursor ( SelectMethod=cursor is required)
    Driver com.microsoft.sqlserver.jdbc.SQLServerDriver
    Transaction Isolation TRANSACTION_SERIALIZABLE
    PostgreSQL
    Property Value
    URL jdbc:postgresql://hostname:5432/dbName
    Driver org.postgresql.Driver
    Transaction Isolation TRANSACTION_READ_COMMITTED
  4. To configure Microsoft SQL Server using AD authentication, please refer to Configuring Active Directory (AD) Authentication for the SQL Server Reporting Database (On-Premise).
  5. Copy the corresponding JDBC driver’s JAR file into the Manager’s DS_MANAGER/webapps/livecluster/WEB-INF/lib directory.
  6. Restart the GridServer Manager.
Note: To retrieve the reporting database username and password from HashiCorp Vault instead of entering them manually, refer to Configuring HashiCorp Vault for Reporting Database Credentials.

Configuring an Encrypted Connection to MS SQL

By default, the connection between TIBCO DataSynapse GridServer and MS SQL is not encrypted. This procedure describes how to configure an encrypted connection between TIBCO DataSynapse GridServer and Microsoft SQL Server (MS SQL) by modifying the MS SQL driver properties in the database URL.
Note: For specific requirements and security best practices related to your environment, consult your Database Administrator (DBA).
  1. Navigate to the database URL setting in GridServer Manager.
  2. Go to GS Admin > Admin > Manager Configuration > Database > Reporting Database Connection > URL.
  3. Add the following properties to the database URL:
    encrypt=true;trustServerCertificate=true
    For example, if your original URL is:
    jdbc:sqlserver://mysqlserverhost:1433;DatabaseName=grid_db;SelectMethod=cursor
    Modify it to the following URL:
    jdbc:sqlserver://mysqlserverhost:1433;DatabaseName=grid_db;SelectMethod=cursor;encrypt=true;trustServerCertificate=true