Configure system components

This section includes steps to configure your system components as well as a list and description of the available system component parameters.

To configure your system components:

1. To initialize the configuration, use the PUT method in conjunction with the http://localhost:5590/api/v1/configuration/system/components REST endpoint.

2. Create an empty text file using a text editor.

3. Copy and paste a sample configuration for system components into the file. For example:

   [

   {

   "componentid": "OmfEgress",

   "componenttype": "OmfEgress"

   }

   ]

   If you are configuring an adapter with two adapter instances, you can use the following example:

   [

   {

   "componentId": "BACnet1",

   "componenttype": "BACnet"

   },

   {

   "componentid": "BACnet2",

   "componenttype": "BACnet"

   },

   {

   "componentid": "OmfEgress",

   "componenttype": "OmfEgress"

   }

   ]

4. Using the available parameters, update the example JSON parameters for your environment.

   Available parameters include ComponentId and ComponentType

   Note: The OmfEgress component is required to run the adapter. Both its ComponentId and ComponentType are reserved and should not be modified.

5. Save the file. For example, as ConfigureComponents.json.

6. Open a command line session. Change directory to the location of ConfigureComponents.json.

REST URLs

The following table includes other REST operations that you can perform, such as updating or deleting a system components configuration.