Before You Begin Configuration
Before you begin the configuration of a Connection Server, 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 Connection Server. You will copy one of them to use as the cxserver.conf configuration file for your Connection Server.
Typesafe Configuration Format
You can edit the sample configuration file for the Connection Server 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 = "CXServer1"
num - "1"
}
. . .
}
This expression is equivalent to the following expressions:
cx-server.thing.name = "CXServer1"
cx-server.thing.num = 1
Sample Configuration Files
The sample configuration files provided in the Connection Server installation provide comments to guide you through the configuration for two different environments. The sample, cxserver-sample.conf, is for the installation of a Connection Server in a single-server ThingWorx Platform installation environment. The sample, cxserver-ha-sample.conf, is for the installation of a Connection Server in a ThingWorx High Availability Clustering environment.
Each file contains comments to explain the settings. The comments may be prefixed with // or #. Here is an overview of the contents of these files:
• cxserver-sample.conf — This sample file contains the minimum settings for configuring a Connection Server to connect securely with a single-server ThingWorx Platform installation. As of v.9.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.
• cxserver-ha-sample.conf — This sample file contains the minimum settings for configuring a Connection Server to connect securely to a ThingWorx High Availability Clustering environment. This file has been added for v.9.0.0. 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.
• cxserver-long-sample.conf — This sample file contains the required settings and all the possible options for configuring the Connection Server.
Among the optional settings are configuration settings that you may want to use to fine tune your Connection Server after operating it for a while. Refer to
Fine-Tuning a Connection Serverfor more information about these settings and what you may want to change.