1. Download connector
First you need to download the connector (visit Downloads page);
2. Configure connector
A configuration file (config.json) is distributed together with the connector, that you must fill in in order to use it.
- Endpoint: The URL of the OMNIA subscription you want the connector to be used on.
- Client: Click here to know how to get the Client ID and Secret
- ID: Client ID of the connector configuration you registered on the platform.
- Secret: Client Secret of the connector configuration you registered on the platform.
It also supports optional parameters:
- BehavioursManagerPort: The port that the connector will open its behaviours manager on. If ommitted, defaults to 49995. If this is already in use (i.e. you want to have two connectors in parallel), you must add this configuration.
- Logging: The minimum log level. Further details here
- ReconnectionTimeLimit: The maximum time (in hours) the connector will attempt to establish a connection with the Platform. If not set the default value is 24 hours.
3. Install connector
After you have downloaded the connector (see our Downloads page) and extracted it, you can either run it directly (not recommended for production environments) or install it as a Windows service.
To run it, you should just do
Omnia.Connector.Windows.exe (in cmd) or
./Omnia.Connector.Windows.exe (in powershell) from the folder you extracted it to. In order to install the Windows service, add
install to the end of that line. To uninstall it, add
uninstall. In both of these scenarios, ensure you are running as an administrator.
4. Manage connector
When the connector is installed as a Windows service, it can be started or stopped on Windows Services list.
The connector can also be started through console, by inserting on cmd
Either way, the connector will launch three different processes on the machine:
All processes are essential and should not be manually closed, so that the connector is always responsive.