Before You Begin Configuration
Before you begin the configuration of an eMessage Connector, it is important to understand the format used in the configuration file. Once you understand the formatting requirements, review the sample configuration files provided with the eMessage Connector. You will copy one of them to use as the emessage.conf configuration file for your Connector. Refer to Sample Configuration
Files.
Typesafe Configuration Format
You can edit the sample configuration file for the eMessage Connector or create your own configuration file. The structure of the configuration file is hierarchical, and type safe, differentiating between strings and numbers. It consists of groups and properties. Groups can contain other groups, just properties, or a combination. The configuration file also supports multi-value arrays [ ].
The top-level group in the configuration file is called cx-server. For example:
cx-server {
thing {
name = "emessage-connector-123"
}
. . .
}
This expression is equivalent to the following expressions:
cx-server.thing.name = "emessage-connector-123"
Sample Configuration Files
The sample configuration files provided in the eMessage Connector installation provide comments to guide you through the configuration for two different environments. The sample, emessage-sample.conf , is for the installation of an eMessage Connector in a single-server mode ThingWorx Platform environment. The sample, emessage-ha-sample.conf, is for the installation of an eMessage Connector in a ThingWorx High Availability (HA) Clustering environment.
Each file contains comments to explain the settings. Any line that begins with // or # is a comment. Here is an overview of the contents of these files:
• emessage-sample.conf — This sample file contains the minimum settings for configuring an eMessage Connector to connect securely with a single-server mode ThingWorx Platform. As of v.2.0.0 this file is organized such that all settings that require a specific setting for your environment appear first, followed by the optional settings.
 |
This file was named as emessage.conf in releases prior to v.2.2.1. It was renamed in v.2.2.1.
|
• emessage-ha-sample.conf — This sample file contains the minimum settings for configuring an eMessage Connector to connect securely to a ThingWorx HA Cluster This file has been added for v.2.0.0 of the Connector. It is organized such that all settings that require a specific setting for your environment appear first, followed by the required settings that you should not change, and finally the optional settings.
• emessage-all.conf — This sample file contains the required settings and all the possible options for configuring the eMessage Connector.
Among the optional settings are configuration settings that you may want to use to fine tune your eMessage Connector after operating it for a while. Refer to Fine-Tuning the eMessage Connector for more information about these settings and what you may want to change.