Configuration Migration
Some Oracle Health Insurance applications have the ability for users to select configuration rules, package and extract these rules into a data file set and import them into another environment.
This ability supports an incremental migration strategy, that is, one rule at a time, for bringing in new configuration rules all the way from a development environment to the production environment.
This page describes the API that enables such selective configuration migration strategy.
The configuration migration option uses the same /dataexchange API as used in the Data Set Operations.
|
Operations
This API supports the following operations:
|
|
|
|
|
|
Export Configurations
PUT: Create a Migration Set
A PUT
request to /dataexchange/datasetdefinition/{datasetDefinitionCode}/dataset
creates a new configuration migration set.
The URL is different per component, as it includes the component specific data set definition code. The following data set definition codes are available:
-
CLAIMS_CONFIGURATION
-
POLICIES_CONFIGURATION
-
AUTHORIZATIONS_CONFIGURATION
-
GATEWAY_CONFIGURATION
For example, the URL for the Claims looks like this:
http://[hostName]:[portNumber]/[api-context-root]/dataexchange/datasetdefinition/CLAIMS_CONFIGURATION/dataset
For the payload structure and an example of the payload see Create a Migrations Set for creating the data set is as follows:
Rules
-
Each configMigrationItem represents a single top level configuration item or rule that is included in the migration set.
When the migration set builds, the application includes all listed items in the payload. By default this also includes all building block configuration upon which the selected item depends.
-
To avoid the application from including (some of) these underlying configuration items, specify excludeOptions.
Each
excludeOption
represents an instruction to the application to omit a part of the underlying configuration, when building the migration set. -
There are a few global includes possible, like Agents, Brokers and Providers for Policies. If any data gets migrated and has a reference to the selected global option, then that also gets included in the set. Otherwise, these are excluded by default.
POST: Create and Build a Migration Set
A POST
request to /dataexchange/createandexport/datasetdefinition/{dataSetDefinitionCode}/dataset
creates a new configuration migration set and builds an outbound file for migration.
See Data Set Operations for more details on the create and build steps.
The build payload request (described in the Data Set Operations Integration Point) can be used to re-build the payload file if needed by providing the set code created by this process. |
The payload structure for creating the data set and building the file is the same as for the PUT operation.
<inclusionDate> is optional, if present, then only those items from the set are included that are created or updated since the inclusionDate. This helps in keeping the size of the set in check. |
PATCH
A PATCH
request to /dataexchange/createandexport/datasetdefinition/dataset/{id}
updates the configuration migration set.
The following payload example updates a migration set:
{
"configMigrationItems" : [{
"tableId": 647005,
"recordId" : 4002
},
{
"tableId": 647006,
"op": "remove"
},
{
"tableId": 647005,
"recordId" : <recordId>,
"op": "add"
},
{
"tableID" : <tableId>
}
],
"excludeOptions": [{
"tableTopId": 647005,
"tableDependentId" : 2220
},
{
"tableTopId": 647005,
"tableDependentId" : 2220,
"op" : "remove"
}
],
"globalIncludeOptions": [{
"tableId" : 542005
},
{
"tableId" : 542006,
"op": "remove"
}
]
}
Import Configuration Migration Files
Import requests enable the import of the payload on the target environment.
See Data Set Operations - Target Environment Operations for more details.