Configuration Files
This page documents the configuration files used by the various Streaming Integration Platform components on all supported platforms.
Configuring Configuration Server
During installation on Windows, Configuration Server is configured based on the information entered into the installer UI.
During installation on Linux, Configuration Server is configured based on the various settings in /etc/sysconfig/sp.conf, which is discussed in Preparing to Install on Linux.
Configuring Components on Windows and Linux
ISAM Agent (Windows/Linux)
On Windows hosts, configuration files for ISAM Agent are located in ProgramData%\Synergex\SIP\profile-name, and on Linux hosts, they're in /etc/synergex/sip/profile-name.
| Filename | Description |
| MasterConfig.json | Master configuration file |
| ServerConfig-ISAMAgent.json | Server-specific configuration file |
If Configuration Server is in use, refer to Configuration Server at Startup below.
JSON Agent (Windows/Linux)
On Windows hosts, configuration files for JSON Agent are located in ProgramData%\Synergex\SIP\profile-name, and on Linux hosts, they're in /etc/synergex/sip/profile-name.
| Filename | Description |
| MasterConfig.json | Master configuration file |
| ServerConfig-JSONAgent.json | Server-specific configuration file |
| json-agent-hostname.pfx | Server TLS certificate file |
| json-agent-hostname.pass | Server TLS certificate password file |
If Configuration Server is in use, refer to Configuration Server at Startup below.
Message Broker (Windows/Linux)
On Windows hosts, configuration files for Message Broker are located in ProgramData%\Synergex\SIP\profile-name, and on Linux hosts, they're in /etc/synergex/sip/profile-name.
| Filename | Description |
| MasterConfig.json | Master configuration file |
| iceoryx2.toml | Configuration file for the ICEORYX2 library |
If Configuration Server is in use, refer to Configuration Server at Startup below.
Snapshot Agent (Windows/Linux)
On Windows hosts, configuration files for Snapshot Agent are located in ProgramData%\Synergex\SIP\profile-name, and on Linux hosts, they're in /etc/synergex/sip/profile-name.
| Filename | Description |
| MasterConfig.json | Master configuration file |
If Configuration Server is in use, refer to Configuration Server at Startup below.
SQL Agent (Windows/Linux)
On Windows hosts, configuration files for SQL Agent are located in ProgramData%\Synergex\SIP\profile-name, and on Linux hosts, they're in /etc/synergex/sip/profile-name.
| Filename | Description |
| MasterConfig.json | Master configuration file |
| ServerConfig-SQLAgent.json | Server-specific configuration file |
| sql-agent-hostname.pfx | Server TLS certificate file |
| sql-agent-hostname.pass | Server TLS certificate password file |
If Configuration Server is in use, refer to Configuration Server at Startup below.
Configuration Server at Startup
The following Windows and Linux components can be configured to use Configuration Server:
- ISAM Agent
- JSON Agent
- Message Broker
- Snapshot Agent
- SQL Agent
During the startup of each of these components, if Configuration Server is in use, the component will attempt to contact and authenticate with Configuration Server and download the latest versions of the necessary configuration files. Also, if the component requires a TLS certificate (i.e., ISAM, JSON, and SQL Agents) and the certificate is not present, it will be downloaded along with its associated password file.
Any downloaded files are then cached in the appropriate local configuration directories from which they will be loaded and used.
If Configuration Server is not in use or cannot be contacted, the component will attempt to load the necessary files from the local configuration directories and will fail if they are not present. So to configure an environment without using Configuration Server, simply place the necessary configuration files in the appropriate configuration directories.
Configuring Components on OpenVMS
On OpenVMS Hosts, configuration files are located in the directory identified by the logical name SIP_CONFIG:
Message Broker (OpenVMS)
| Filename | Description |
| BROKER.TOML | Broker and snapshot agent configuration file |
Snapshot Agent (OpenVMS)
| Filename | Description |
| BROKER.TOML | Broker and snapshot agent configuration file |
| FILES.JSON | Snapshot Agent metadata file |