Skip to main content

Configure connections for FairCom DB Notify

dbnotifyconnections.json

Abstract

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

Configure the connection from FairCom DB Notify to FairCom MQ using the dbnotifyconnections.json file. dbnotifyconnections.json is located in the <faircom_install_folder>/config/ folder.

Example dbnotifyconnections.json file

{
  "directConnectionsToFairComMq":
  [
    {
      "brokerConnectionName": "faircomMq1",

      "faircomServerName": "FCEDGEMQ",
      "brokerHostname": "localhost",
      "brokerPort": 5597,

      "brokerUserName": "ADMIN",
      "brokerUserPassword": "ADMIN",
      "passwordCertificateFilename": "",

      "reconnectFrequencySeconds": 15,

      "tls": 
      {
        "certificateFilename": "cert.pem", 
        "privateKeyFilename": "key.pem",
        "allowedCipherSuites": ["AES256-SHA256"],
        "certificateAuthoritiesFilename": "ca.pem"
      },
      "metadata": {},
      "defaultIncludePrimaryKey": "never",
      "defaultTagChanges":        "neverTag"
    }
  ]
}

"directConnectionsToFairComMq" property summary

Table 1. "directConnectionToFairComMq" property summaries

Property

Description

Default

Type

Limits (inclusive)

"brokerConnectionName"

defines a user-defined unique name for a broker integration

Required - No default value

string

Minimum length: 1
Maximum length: 64

"faircomServerName"

defines FairCom MQ server name

Required - No default value

string

Minimum length: 1
Maximum length: 255

"brokerHostname"

defines a unique broker host name or TCP/IP address

Required - No default value

string

Minimum length: 1
Maximum length: 255

"brokerPort"

defines the TCP/IP port

1883

int16

1 - 65,535

"brokerUserName"

defines login name to FairCom MQ

"ADMIN"

string

Minimum length: 1
Maximum length: 64

"brokerUserPassword"

defines the login password to FairCom MQ

"ADMIN"

string

Minimum length: 1
Maximum length: 128

"passwordCertificateFilename"

contains the filename of a certificate that DB Notify loads and sends to the FairCom MQ server to authenticate

"none"

enum string

"none"

"brokerPasswordEncryption"

defines the encryption of the "brokerPassword" property

"none"

enum string

"none"

"reconnectFrequencySeconds"

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

15

int32

1 - 65,535

"tls"

contains Transport Layer Security settings for connecting to FairCom MQ

{}

object

"metadata"

exists primarily for the user interface to find integration information

{}

object

"defaultIncludePrimaryKey"

specifies when to include the primary key designation of fields in responses. See includePrimaryKey

"forPrimaryKeyFields"

string

"forEachField"
"never"
"forPrimaryKeyFields"

"defaultTagChanges"

specifies when to include change status of fields in responses. See tagChanges

"tagEachField"

string

"tagEachField"
"neverTag"
"tagPrimaryKeyFields"


"tls" property summary

Table 2. Optional protocol property summaries

Property

Description

Default

Type

Limits (inclusive)

"certificateFileName"

contains the file name of the public server certificate file — such as, cert.pem

"./web/fccert.pem"

string

"privateKeyFilename"

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

"key.pem"

string

"allowedCipherSuites"

contains a list of ciphers that the client may use to connect to the server

Note

A client can only connect to the server using one of the listed ciphers.

[ "AES256-SHA256" ]

array

"certificateAuthoritiesFilename"

contains the file name of the certificate authorities file

"./web/ca.pem"

string



The "certificateAuthoritiesFilename" property is the filename of the certificate authorities file. It defaults to "./web/ca.pem"

Things to know:
  • The certificate authorities file contains the list of certificate authorities the server uses to validate X509 certificates that clients present as authentication credentials.

  • For an X509 certificate to be accepted by the server, the certificate must be signed by a certificate authority in the certificate authorities file. This approach supports self-signed certificates as long as the creator of the self-signed certificate is in the certificate authorities file.