Data Exchange

Configuring Data Exchange Between Environments

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

Configuration Migration

The property ohi.application.uri.CONF can be setup to configure one or more environments as source to migrate configuration data. 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 - Set up a single source environment

    • POST "/api/generic/properties"

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

  • Example 2- Set up multiple source environments

    • POST "/api/generic/properties"

{
   "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 - Set up a single source environment

    • POST "/api/generic/properties"

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

  • Example 2- Set up multiple source environments

    • POST "/api/generic/properties"

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

Managing Credentials using the Credentials IP

If one or both of these properties are set up, the credentials need to be setup for credential key DataExchangeClient.

Example: PUT "/api/credentials/credential/DataExchangeClient"

{
   "username": "a_username",
   "password": "a_secret_password"
}

The user "a_username" should have access restriction "dataexchange IP" granted.

Please note that configuring these properties is optional if one wants to use only the "File Imports" option in "Inbound Data Sets" page.