Adapters Configuration
File Layout
The adapters JSON configuration file layout requires a top level "adaptersConfig" object that contains an "adapters" array object. The adapters array object contains the list of available adapter configurations.
Example layout:
{ "adaptersConfig": { "adapters": [ { "name": "adapter-name-1", "className": "className1" }, { "name": "adapter-name-2", "className": "className2" }, { "name": "adapter-name-3", "className": "className3" } ] } }
Each adapter configuration contains property values that define the adapter name and Java class that will be used when the adapter is loaded.
Properties
Below is a list of properties that must be included in the configuration file.
Property Name | Required? | Description |
name | yes | The human-readable name or label given to this adapter. This name will be used in connection configuration files that use the adapter. Example: |
className | yes | The fully qualified class name of the main adapter class. Example: |
Example
This is the example file form the sample configuration shipped with the installation file:
{ "adaptersConfig": { "adapters": [ { "name": "ars", "className": "com.kineticdata.schedule.adapter.ars.ArsAdapter" } ] } }
This example tells the application that one adapter is available, and it is the ArsAdapter. The ArsAdapter works with any Remedy server v7+.