Configuring the connection from your Content Deployer microservice to the State Store database

In the <State> section of your Content Deployer configuration file, deployer-conf.xml, set the properties for the State Store database in a Storage element.

Before you begin

Before performing this task, you must have installed the State Store database, in one of the following ways:
  • You installed your State Store database tables in the same database as the Content Data Store (default option)
  • You chose to install your State Store database tables in a separate State Store database (option that optimizes for performance)

About this task

This task requires you to set a number of properties for the State Store database. If your State Store database tables are in the same database as the Content Data Store, you will have set values for some properties already in the Storage element for the Content Data Store, as found in the Storage Layer configuration file, cd_storage_conf.xml. Even so, the Storage element in cd_storage_conf.xml has a different definition than the one in deployer-conf.xml, and you will need to set some additional properties.

Procedure

  1. Go to the configuration location of your Content Deployer microservice.
  2. Resolve the following placeholders, as found in the Storage element contained in the State element in the file deployer-conf.xml:
    PlaceholderDescription of value
    dbadapterThe type of database:
    • mssql if you have a Microsoft SQL Server database
    • oracle if you have an Oracle database
    dbdriverThe Java class of your database driver:
    • com.microsoft.sqlserver.jdbc.SQLServerDriver if you have a Microsoft SQL Server database
    • oracle.jdbc.driver.OracleDriver if you have an Oracle database
    dbhostThe host name of the database server. Oracle users: the attribute is called serverName, but Oracle calls this setting HOST in, for example, its tnsnames.ora file.
    dbportThe port number of the database server.
    dbnameThe name of the database. Oracle users: the attribute is called databaseName, but Oracle calls this setting SERVICE_NAME in, for example, its tnsnames.ora file.
    dbuserThe name of a user who can access the database. Oracle users: Oracle also uses the word "schema" to refer to the user name.
    dbpasswordThe (encrypted) password of the user who can access the database.
    testonborrowSet to true to validate objects before they are borrowed from the pool. If validations fails, the object is dropped from the pool, and an attempt is made to borrow another. Defaults to true.
    dbmonitorintervalNumber of seconds between checks for idle objects by an eviction thread. The value defaults to -1 (never check for idle objects).
    dbencryptMicrosoft SQL Server users: Encrypt the connection to the database if this property is set to true. Defaults to false.
    If your State Store database tables are in the same database as the Content Data Store, a number of values must match the values as specified in cd_storage_conf.xml, in the Storage element that has its Id attribute set to the value defaultdb:
    Value of this placeholder in deployer-conf.xml......must match this value in cd_storage_conf.xml
    dbadapterStorage@dialect
    dbhostStorage/DataSource/Property[@Name="serverName"]@Value
    dbportStorage/DataSource/Property[@Name="portNumber"]@Value
    dbnameStorage/DataSource/Property[@Name="databaseName"]@Value
    dbuserStorage/DataSource/Property[@Name="user"]@Value
    dbpasswordStorage/DataSource/Property[@Name="password"]@Value
  3. Save and close deployer-conf.xml.