Configure Data Exchange Between Environments (Deprecated Document)

This Document is Deprecated

See the following documents for detailed information on Data Exchange Between Environments.

Data Set Operations

Data File Sets

This document explains how to set up the data exchange between environments.

== Configuration Migration

Set up the property `ohi.application.uri.CONF` to configure one or more environments as source to migrate configuration data.
The value of this property should be the URL to the `dataexchange` IP.
Multiple URLs can be specified, separated by semicolon - to connect to multiple source environments.

Example 1: Single Source Environment::
Send a `POST` request to `/api/generic/properties` with the payload

----
{
 "name": "ohi.application.uri.CONF",
 "value": "http://dev.com:port/api/dataexchange"
}
----

Example 2: Multiple Source Environments::
Send a `POST` request to `/api/generic/properties` with the payload
----
{
 "name": "ohi.application.uri.CONF",
 "value": "http://dev.com:port/api/dataexchange;http://test.com:port/api/dataexchange"
}
----


== Product Definition

The property `ohi.application.uri.PRD` can be setup to configure one or more environments as source to import benefits/products data set.
The value of this property should be the URL to "dataexchange" IP.
Multiple URLs can be specified, separated by semicolon - to connect to multiple source environments.

Example 1: Single Source Environment::
Send a `POST` request to `/api/generic/properties` with the payload
----
{
 "name": "ohi.application.uri.PRD",
 "value": "http://dev.com:port/api/dataexchange"
}
----

Example 2: Multiple Source Environments::
Send a `POST` request to `/api/generic/properties` with the payload

----
{
   "name": "ohi.application.uri.PRD",
   "value": "http://dev.com:port/api/dataexchange;http://test.com:port/api/dataexchange"
}
----

== Managing Credentials Using the Credentials API

If one or both of the above properties are set up, also set up the credentials for credential key `DataExchangeClient`.

Example::
Send a `PUT` request to `/api/credentials/credential/DataExchangeClient`
----
{
   "username": "a_username",
   "password": "a_secret_password"
}
----

When registering more than one source environments, the username/password to access the sources must be the same on all source environments.

The user "a_username" must have a grant on the access restriction `dataexchange IP`.

Configuring these properties and credential keys is only required when you use the xref:development:integration-points:http-integration-points/data-set-operations-integration-point.adoc#_import_from_environment[Import from Environment option for the Data Set Operations].