Calyx RIM 7.1 Data Exchange

Import Data with the Data Exchange API

When the data in your system has been exported to a common location and is properly formatted according to the schema provided in the Calyx RIM Data Exchange API, it is ready to be imported into the Calyx RIM database.

Calyx RIM Data Exchange requires read only access to the data to be imported.

For the following procedure, refer to the Calyx RIM Data Exchange API documentation and APIUsageExample.java for more detailed information and examples.

To import data:
  1. Import the necessary Calyx RIM Data Exchange code.
  2. Use the API to specify the action for the data: add, update, or upsert.
    On the first message, specify only one request.
  3. Assign a unique ID to each entity.
  4. Set the values for all fields on the entity by using the API.
  5. Use the DataExchangeClient to send the data to Calyx RIM Data Exchange by posting a message to the Data Exchange Web Service.
    The Web service returns a transaction ID in a URL.
  6. Use the returned transaction ID to check the import transaction status in the logs.