Integration Configuration (Config)

What is it?

An integration configuration is end user provided information that customizes how their integration data flow will operate. The author of the integration template should provide a definition for the config, so it isn’t ad hoc, which tells the end user “these are the blanks that you get to fill in”. When merged with a template, an integration config creates an executable integration data flow.

How is it used?

Use integration configs to do the following:

  • Provide configuration points for end users to customize available integrations.
  • Deploy unique instances of templated integrations into the active integration environment.

Why is it important?

The ability to allow end user configuration within the context of a templated integration is the fundamental difference between building reusable product integrations and building a bespoke integration one time for one user. Integration configs are one of the two fundamental concepts enabling that, the other being templates.

Integration configs relate to the following entities:

  • Integration configs relate to a single tenant, because they are defined once and within the context of an end user’s account/tenant/etc.
  • Integration configs relate to a single integration definition, because they are designed to provide context for one of the integrations made available to end users.
  • Integration configs relate to whatever credential abstraction is made available via the integration engine, so that necessary credential references can be passed in for use in the data flow. In the case of Open Integration Hub, this is a Secret.