Skip to main content

Configure connection

Configure the connection from FairCom DB Notify to FairCom MQ using the <faircom>/config/dbnotifyconnections.json file.

Abstract

Configure the connection from FairCom DB Notify to FairCom MQ using the dbnotifyconnections.json file.

Example dbnotifyconnections.json file

{
 "logLevel": "development",
  "directConnectionsToFairComMq":
  [
    {
      "brokerConnectionName": "brokerCtree",
      "faircomServerName": "FCEDGEMQ",
      "brokerHostname": "localhost",
      "brokerUserName": "ADMIN",
      "brokerUserPassword": "ADMIN",
      "reconnectFrequencySeconds": 15,
      "tls": 
      {
        "enabled": false,
        "certificateFilename": "ctsrvr.pem",
        "x509_authentication":
        {
          "enabled": false,
          "certificateFilename": "admin.pem",
          "privateKeyFilename": "admin.key"
        }
      },
      "metadata": {},
      "defaultIncludePrimaryKey": "never", 
      "defaultTagChanges": "never", 
    }
  ]
}
Table 1. "dbnotifyconnections.json" properties summary

Property

Description

Default

Type

Limits (inclusive)

directConnectionsToFairComMq

specifies the possible FairCom MQ brokers that can receive MQTT messages published from DB Notify. At least one FairCom MQ broker must be specified.

Required - No default value

array of objects

directConnectionsToFairComMq
.brokerConnectionName

specifies a user-defined unique name for a broker integration

Required - No default value

string

1 to 64 characters

directConnectionsToFairComMq
.brokerHostname

specifies a unique broker host name or TCP/IP address

Required - No default value

string

1 to 255 characters

directConnectionsToFairComMq
.brokerPort

specifies the TCP/IP port

If defined, "faircomServerName" is ignored.

Required if "faircomServerName" is not defined - No default value

int16

1 to 65535 characters

directConnectionsToFairComMq
.brokerUserName

specifies login name to FairCom MQ

"ADMIN"

string

1 to 64 characters

directConnectionsToFairComMq
.brokerUserPassword

specifies the login password to FairCom MQ

"ADMIN"

string

1 to 128 characters

directConnectionsToFairComMq
.defaultIncludePrimaryKey

specifies the default value for when to include the primary key designation of fields in responses. This can be overridden by includePrimaryKey

"forPrimaryKeyFields"

string

"forEachField"
"never"
"forPrimaryKeyFields"
directConnectionsToFairComMq
.defaultTagChanges

specifies the default value for when to include the change status of fields in responses. This can be overridden by tagChanges

"forEachField"

string

"forEachField"
"never"
"forPrimaryKeyFields"
directConnectionsToFairComMq
.faircomServerName

specifies FairCom MQ server name

Required if "brokerPort" is not defined - No default value

string

1 to 255 characters

directConnectionsToFairComMq
.metadata

specifies metadata primarily for the user interface to find integration information.

{}

object

directConnectionsToFairComMq
.reconnectFrequencySeconds

specifies the number of seconds that the server waits between attempts to reconnect to FairCom MQ

15

int32

1 to 65535 characters

directConnectionsToFairComMq
.tls

specifies Transport Layer Security settings for connecting to FairCom MQ

{}

object

directConnectionsToFairComMq
.tls
.certificateFileName

specifies the file name of the public server certificate file — such as, ctsrvr.pem

Required - No default value

string

directConnectionsToFairComMq
.tls
.enable

enables TLS if true

"false"

boolean

"false"
"true"
directConnectionsToFairComMq
.tls
.x509_authentication

specifies x.509 settings to connect to Faircom MQ.

{}

object

directConnectionsToFairComMq
.tls
.x509_authentication
.certificateFilename

specifies the file name of the private server key file — such as admin.pem

Required - No default value

string

directConnectionsToFairComMq
.tls
.x509_authentication
.enabled

enables x.509 authentication if true

"false"

boolean

"false"
"true"
directConnectionsToFairComMq
.tls
.x509_authentication
.privateKeyFilename

specifies the file name of the private server key file — such as admin.key

Required - No default value

string

loglevel

specifies the level of log messages for dbnotify.

"none" - no status information

"production" - most important dbNotify status events are logged

"development" - all dbNotify status events are logged

A good practice is to start with "development" and when everything is configured, change to "production".

NOTE: Error messages are always printed.

"production"

string

"none"
"production"
"development"