Designing Micro-Integrations

You can create two types of Micro-Integrations between a PubSub+ event broker service and your external system:

  • Target Micro-Integrations—Data flows from the event broker service through the Micro-Integration to the external system.

  • Source Micro-Integrations—Data flows from an external system through the Micro-Integration to the event broker service.

For an overview of how Micro-Integrations work, see PubSub+ Cloud-Managed Micro-Integrations.

Prerequisites

Before you start creating Micro-Integrations, ensure that you have:

Considerations for Creating Micro-Integrations

When you are creating Micro-Integrations, you should be aware that:

 

Create a Micro-Integration

If you are using more than one environment, ensure that you select the same environment as the event broker service you want to connect to before you create your Micro-Integration, otherwise the service won't be available for selection in the steps below. For more information, see Selecting Environments.

To create a Micro-Integration, perform these steps: 

  1. Log in to the PubSub+ Cloud Console if you have not done so yet. The URL to access the Cloud Console differs based on your authentication scheme. For more information, see Logging In to the PubSub+ Cloud Console.
  2. On the navigation bar, select Micro-Integrations .

  3. If your organization uses multiple environments, on the Micro-Integrations page, select the environment where you want to create the Micro-Integration. For more information, see Selecting Environments.

    Ensure that you select the same environment as the event broker service that you want to connect to.

  4. Click Create Micro-Integration.

    If it is your first time using Micro-Integrations , you may see a pop-up screen. Select Check Out Available Micro-Integrations to create a new Micro-Integration or Explore On My Own to deploy an already existing Micro-Integration.

  5. Select a source or target Micro-Integration for your requirement (see Designing Micro-Integrations). The Create Micro-Integration page opens, showing the steps you can navigate through to build your Micro-Integration. You can return to any step at any time.

  6. On the Details step, enter a unique name for your Micro-Integration. Optionally, add a description for it, and then click Next: Source Connection.

  7. On the Source Connection step, perform the following to enter the configuration details:

    1. If you are creating a source Micro-Integration, enter the details for it. See Configuring an External System as a Source or Target.

    2. If you are creating a target Micro-Integration, enter your event broker service details. See Configuring Your Event Broker Service as a Source or Target.

    3. Click  Next: Mappings.

  8. (Optional) On the Mappings step, click and drag the required header fields from the source to the target to create mappings.

    Mappings are not available for the Qdrant Micro-Integration.

    You can also:

    • upload JSON files to map fields between the payloads of your two systems, or to map fields between headers and payloads

    • add transformation functions to your mappings to modify the source header or payload data so that it conforms to your target format

    • define constants so that you can use string or numeric values in your mappings

    For more information, see Mapping Headers and Payloads (Beta).

    When you've finished with your mappings, click Next: Target Connection.

  9. On the Target Connection step, perform the following to enter the configuration details:

    1. If you are creating a source Micro-Integration, enter your event broker service details. See Configuring Your Event Broker Service as a Source or Target.

    2. If you are creating a target Micro-Integration, enter the details for it. For more information, see Configuring an External System as a Source or Target.

    3. Click Next: Summary.

  10. On the Summary step, verify the details on the Source Connection, Target Header Mapping, and Target Connection tabs. If everything looks correct, click Create.