Overview - Service Instance Configuration

IP Service Instance Configuration for an adapter exist to allow flexibility in the adapters. Changes to fields or properties within the IP Service Instance Configuration for the adapter can be made through IP Admin Essentials. When these changes are made, the adapter will be restarted but IP will remain up. The ability to refresh adapter properties using refreshProperties does exist, but IP does not currently make use of that capability.

The adapter properties are defined in the propertiesSchema.json file. This is a json schema file that can provide information such as the property data type (String, Integer, Boolean, Enumeration, etc.), a description of the property, and whether there is a default value.

You can add additional properties to the propertiesSchema.json file if needed. The adapter properties that are originally defined in the propertiesSchema.json file are utilized by the adapter-utils library. Removing or changing any of the default values for these properties could cause the adapter to not function properly.

Adapter properties can be overridden on an individual call through the callProperties passed in the request object from the method in the adapter.js file to the adapter library.

Properties get added periodically. The version of the adapter-utils library can change frequently, and, as of October 31, 2022, the current verison is 4.48.x. The correlated documentation assumes you have the current version of Adapter Utils installed in your adapter. If this is not the case, some of the properties discussed here may not be available for your usage.

Information about the "properties" available in the IP Service Instance Configuration for the adapter can also be found in the PROPERTIES.md file within every opensource adapter, as well as adapters recently built using the Adapter Builder. Older adapters will have similar information contained within the README.md file.