Service instance configuration overview

Adapter properties exist to allow flexibility in how adapters communicate with external systems. You can update these properties throughItential Platform Admin Essentials at any time. When changes are saved, the adapter restarts automatically whileItential Platform remains up.

Property schema

Adapter properties are defined in the propertiesSchema.json file. This JSON schema file specifies each property’s data type (string, integer, boolean, enumeration, and so on), a description, and a default value where applicable.

You can add custom properties to propertiesSchema.json as needed. However, avoid removing or changing the default values for properties originally defined in this file — doing so may cause the adapter to stop functioning correctly. The properties defined here are consumed by the adapter-utils library.

Overriding properties per call

Adapter properties can be overridden on a per-call basis by passing callProperties in the request object from the method in adapter.js to the adapter library.

Property versioning

Properties are added periodically as the adapter-utils library evolves. The documentation here assumes you have the current version of adapter-utils installed. If you are running an older version, some properties described in this section may not be available.

Reference documentation

Property definitions are also available in the PROPERTIES.md file included with every open-source adapter and adapters built with Adapter Builder. Older adapters may contain equivalent information in their README.md file instead.