Configuring Apache CouchDB Settings

Before you begin

  • By default, CouchDB only runs on the local host using HTTP protocol and on port number 5984. To ensure that CouchDB runs on HTTPS, you must execute the config_couchDB.bat file provided with ISO.
  • Perform this step only if you are installing Plant Applications Web Client for the first time.
  • CouchDB 2.3.1 must be installed on a Windows machine.

About this task

Apache CouchDB is a document storage application that stores the documents used in discrete applications. Perform steps below to automate the configuration of CouchDB settings to work with Plant Applications. You can skip this procedure if you have already performed it.

Procedure

  1. In a machine where CouchDB is installed, mount the ISO file for the Plant Applications Web Client or load the DVD if you created one from the ISO file for Plant Applications.
  2. From the ISO root folder, run the config_couchDB.bat file using the System Administrator credentials.
    The command prompt window appears and prompts you for inputs.
  3. Provide details for the following:
    • Path of the certificate file. For example, C:\certs\server.crt
    • Path of the key file. For example, C:\certs\server.key
    • Path where the CouchDB is installed. For example, C:\CouchDB
    If no error messages appear and when the command prompt window closes, that is an indication that Apache CouchDB settings are configured. You can view all the changes that you have made by accessing https://<host name or IP address of Apache CouchDB>:<port number>/_utils/.
    Note:
    • By default, the CouchDB HTTPS port number is 6984.
    • To configure CouchDB with SSL, use certificates issued to the CouchDB server (machine) name. Do not use Operations Hub generated certificate if Operations Hub and CouchDB are on different servers.

    You must now create a CouchDB user for using it in the Plant Applications Web Client installation.

  4. Access the CouchDB url in a browser https://<host name or IP address of Apache CouchDB>:<port number>/_utils/ and create a user that can be used in the Plant Applications Web Client installation.
    Note:
    1. To upgrade CouchDB from version 2.3.1 to 3.2.2, take backup of the CouchDB full install folder which also includes the data folder.
    2. Uninstall the existing CouchDB version, and install the most recent Apache CouchDB version. See https://couchdb.apache.org/#download.
    3. Replace the data folder from old CouchDB install and replace it to a new install path.
    4. Run config_couchDB.bat file from Proficy Plant Applications ISO to make CouchDB accessible on https. Ensure that the same certs are reused.