Environments

An environment is a reference to an instance of the integration engine. These could be multiple instances of the same integration engine, for example "stage" and "prod" environments. While not likely to be made up of many entries, your list of environments is effectively a registry of integration platforms, whether homegrown or commercially available, that will move data on your end users behalf.

Properties

  • name: The name for this environment, e.g. "stage", "prod", "test"
  • description: A description of the environment
  • users: Information about the users within an environment. See below
  • components: See below
  • serviceURLs: See below

Environment Components

The components property is an object that maps a component name to a component id within a particular OIH instance. This allows a template author to reference the functionality of a component without having to know ahead of time that component's environment-specific id. A component name jsonata, for example, could refer to a component that performs a JSONata transformation on its input.

Service URLs

The serviceURLs property is an object that maps OIH services to their public endpoints for a particular OIH instance. In order for Doohickey to interact with OIH it must know which URLs to use. Thus setting the iam url to https://iam.example.com tells Doohickey to use that URL for API calls related to the Identity Access Management service (IAM).

Users

Important: When creating a tenant for a specific environment, the tenant API will expect to find an admin user within the users object. This admin user will be used to create and modify tenants in the OIH environment.