Configure system components

Adapters use JSON configuration files in a protected directory on Windows and Linux to store configuration that is read on startup. While the files are accessible to view, we recommend that you use REST or the EdgeCmd utility for any changes you make to the files.

As part of making adapters as secure as possible, any passwords or secrets that you configure are stored in encrypted form where cryptographic key material is stored separately in a secure location. If you edit the files directly, the adapter may not work as expected.

Note: You can edit any single component or facet of the system individually using REST, but you can also configure the system as a whole with a single REST call.

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": "StructuredDataFiles1",

   "ComponentType": "StructuredDataFiles"

   },

   {

   "ComponentId": "StructuredDataFiles2",

   "ComponentType": "StructuredDataFiles"

   },

   {

   "ComponentId": "OmfEgress",

   "ComponentType": "OmfEgress"

   }

   ]

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

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

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

7. To initialize the system components configuration, use Postman to send the ConfigureComponents.json content using the PUT method, by Postman to http://localhost:5590/api/v1/configuration/system/components.

   Note: If you installed the adapter to listen on a non-default port, update 5590 to the port number in use.