4.2 Configure Interconnect

This topic describes how to configure interconnect settings to enable communication between integrated systems.

After completing OBRH configuration, link Interconnect to OBRH as follows:

  1. Navigate to Create System → System Details → Transaction Details in Interconnect.
  2. Set Data Exchange Method to API.
  3. Provide the following configuration parameters.

    Table 4-3 Configuration Parameters

    Parameter Description
    Service Consumer Must exactly match the name configured in OBRH
    Consumer Service Must exactly match the consumer service name within the same Service Consumer in OBRH
  4. Select the API Type.

    Table 4-4 API Type

    API Type Behavior
    Single One REST API call is made per record
    Batch One REST API call is made per chunk (chunk size configurable)

    Note:

    When Batch mode is selected, an additional field is displayed to configure the number of records per API call (chunk size).

Integration Flow

Once configured, Interconnect automatically invokes OBRH using the configured Service Consumer and Consumer Service names. OBRH routes the request to the appropriate domain API endpoint based on the service provider and routing configuration. The domain processes the received payload and returns a response in the format expected by Interconnect.

Request & Response Specifications

Request Body Sent by Interconnect

For both Single and Batch modes, Interconnect sends a Map<String, ObjectNode> structure where:

  • Key: recordId — Interconnect's internal record identifier
  • Value: com.fasterxml.jackson.databind.node.ObjectNode — the actual JSON payload for the record
Single Mode — Example Request Body
{
  "1446467591934476288": {
    "customerName": "Tom",
    "age": "31",
    "id": "14134846241400000"
  }
}
Batch Mode — Example Request Body (chunk size = 3):
{
  "1446467591934476289": { "customerName": "Jack", "age": "30", "id": "14134846241400000" },
  "1446467591934476290": { "customerName": "Van",  "age": "27", "id": "14134846241400000" },
  "1446467591934476291": { "customerName": "Sandy","age": "26", "id": "14134846241400000" }
}

Expected Response from Domain Systems

Interconnect expects domain systems to return a JSON array of per-record processing outcomes:

[
  {
    "recordId": "1446467591934476288",
    "status": "SUCCESS",
    "message": "OK"
  },
  {
    "recordId": "1446467591796064256",
    "status": "FAILED",
    "message": "Customer already exists"
  }
]

Allowed status values

Table 4-5 Allowed status values

Value Description
SUCCESS Record was processed successfully
FAILED Record processing failed; include a descriptive message

Note:

Single Mode: Even in Single API mode, the domain must return a list containing a single element.

Recommended: OBRH Response Transformation

It is strongly recommended to leverage OBRH's response transformation capability to decouple domain response structures from Interconnect's expected format. This approach eliminates the need for domain-side code changes whenever Interconnect's response contract evolves.

OBRH transformation can handle scenarios such as:

  • Mapping domain-specific status codes to SUCCESS or FAILED.
  • Extracting error descriptions into the message field.
  • Wrapping a single response object into the required list structure.

Integration Checklist — Routing Hub

Table 4-6 Integration Checklist — Routing Hub

Step Action
1 Create Service Consumer, Service Provider, and Consumer Service in OBRH.
2 Configure transformation and routing logic in OBRH.
3 Configure Transaction Details in Interconnect.
4 Interconnect invokes OBRH using configured Service Consumer and Consumer Service names.
5 OBRH routes payloads to the target domain API endpoint.

Additional Notes

Ensure naming consistency between OBRH and Interconnect configurations. Any mismatch in Service Consumer or Consumer Service names will result in routing failures.

Parent topic: Integration via Routing Hub (OBRH)