Converting to a Separated Configuration Database

Converting an existing Spectrum™ Technology Platform installation to a separated configuration database enables you to take advantage of the improved scalability of a separated configuration database. When you convert to a separated configuration database, your existing installation is converted from one where the configuration database is part of the server to one where the configuration database is in a separate cluster.

At a high level, this is the conversion process:

Note: This procedure applies both to converting a single server to a separated configuration database, and converting a cluster to a separated configuration database.

To convert to a separated configuration database:

  1. Back up module-specific data for any of these modules if you have them installed.
    Module Items to Back Up
    Advanced Matching Module, Data Normalization Module, and Universal Name Module Back up the contents of these subfolders located in SpectrumLocation/server/modules:
    • cdqdb
    • lucene
    • matcher
    • parser
    • searchindex
    • tables
    .
    Data Hub Module If you do not already have a backup copy of your models, create a backup manually. To create a backup manually, open the Relationship Analysis Client and click Manage. Select the model you want to back up then click Backup.
    In addition to backing up your models, back up these two property files:
    • server\modules\hub\hub.properties
    • server\modules\db\neo4j.properties
    Location Intelligence Module Back up your named resources, data, and configuration files.
  2. (Optional) If you are upgrading to a new version as part of converting from a standard installation to a separated configuration database, upgrade your existing server. For instructions, see Upgrading a Server (for upgrading a single serer) or Upgrading a Cluster (for upgrading a cluster).
  3. Shut down the server. If you have a clustered installation, shut down the cluster.
  4. Install the configuration database to a new server.
    1. Place the Spectrum™ Technology Platform installer on the machine where you want to install the configuration database. This must be a different machine from the one where you have your existing Spectrum™ Technology Platform server installed.
    2. Double-click installdb.exe.
    3. Follow the prompts to install the configuration database.
    4. After the installation is complete, the configuration database starts up automatically. Verify that the configuration database is fully started before continuing by opening the log file <Spectrum Installation Location>/server/app/repository/logs/wrapper.log and looking for this message:
      INFO  [Server] Pitney Bowes Spectrum(TM) Technology Platform (Version version build) Started
      Important: Do not continue until the configuration database has fully started up. If it fails to start up, troubleshoot the issue before continuing. Also, do not attempt to stop the configuration database until after it has fully started for the first time. Stopping the configuration database before it performs an initial startup can cause your installation to become unusable.
    5. Stop the configuration database. To stop the configuration database, right-click the Spectrum™ Technology Platform icon in the Windows system tray and select Stop Spectrum™. Alternatively, you can use the Windows Services control panel to stop the configuration database by stopping the Spectrum Database service.
    6. Copy the server\app\repository\store folder from your existing server to the server where you installed the separate configuration database. Replace the existing server\app\repository\store folder.
    7. Run the conversion utility on the configuration database on the new configuration database server.
      Before running the conversion utility note the following:
      • In order to run this utility, the server must have adequate disk space. The amount of free disk space needed is three times the size of the server/app/repository/store/databases folder. If necessary, add disk space before proceeding.
      • The conversion process may take an hour or more if you have a large configuration database.
      • If no conversion is necessary, the utility will display a message saying that there is nothing to do.

      To run the conversion utility:

      1. Back up the following folder: server/app/repository/store/databases
      2. Right-click the following file and select Run as administrator: SpectrumFolder\server\bin\convert.db.bat
    8. Configure the cluster properties for the database cluster by editing the file server/app/conf/spectrum-container.properties as follows:
      spectrum.cluster.name
      • If this is the first node in the cluster, set this to any name you want to give to the cluster. Be sure that the name is unique if you have multiple clusters.
      • If you are adding a node to an existing cluster, set this to the name of the cluster that you want this node to join.
      spectrum.cluster.enabled
      Set this to true.
      spectrum.cluster.address
      Set this to the network interface to which you want this node to bind. Specify 0.0.0.0 if you want the node to bind to all network interfaces.
      spectrum.cluster.seeds
      Set this to the IP address of the configuration database server you want to be used to set up new configuration database nodes added to the cluster. The configuration database from the seed server is copied to the node whenever it starts up so that it is synchronized with the cluster.
      Note: If this is the first node in the cluster you may specify seed nodes that are not yet running. If you know the IP addresses of the nodes you want to use as seed nodes, you may enter those now. Otherwise, you will need to return to this properties file once you have the IP addresses of the seed nodes and enter them.

      You can specify multiple comma-separated IP addresses. You should specify multiple seed nodes so that if one is down others can be used to allow the node to join the cluster. The node will attempt to access each seed node in the order listed. If none of the seed nodes can be reached, the node will not join the cluster.

    9. Save and close the spectrum-container.properties file.
    10. Start the configuration database. To start the configuration database, right-click the Spectrum™ Technology Platform icon in the Windows system tray and select Start Spectrum™. Alternatively, you can use the Windows Services control panel to start the configuration database by starting the Spectrum Database service.
    11. Install the configuration database on additional servers as needed to complete the configuration database cluster.
  5. Install the server.
    1. (Optional) If you are upgrading to a new version and you want to use the same machine to host the upgraded server as hosted the existing server, uninstall the existing server of Spectrum™ Technology Platform.
    2. Install the server cluster. For instructions, see Installing a Cluster.
      Important: When installing each server select the Server only option in the installer and provide the host and port of one or more of the configuration database servers. You can find the port in the file InstallationLocation\server\app\conf\spectrum-container.properties. The port is specified in the spectrum.orientdb.binary.port property.