Creating Micro-Integrations in Solace Cloud

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

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

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

For an overview of how Micro-Integrations work, see Micro-Integrations in Solace Cloud.

Prerequisites

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

• The Micro-Integration Manager role to allow you to view, edit, and deploy Micro-Integrations. For more information, see Roles and Permissions.

• An event broker service (version 10.2.1 or later). If you don't have one, see Creating Event Broker Services.

• Any queues and subscriptions are configured on the event broker service. For more information, see Configuring Queues and Configuring Topic Endpoints.

• The connection details and credentials for your external system. For more information, see Discovering Micro-Integrations in Solace Cloud.

Create a Micro-Integration

To create a Micro-Integration, perform these steps: 

1. Log in to the Solace 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 Solace 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 dialog. 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 Searching for a Micro-Integration Type to Create). 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, enter the connection details for the event broker service or the vendor system, depending on whether you are creating a source or target Micro-Integration. For more information, see Configuring Your Event Broker Service as a Source or Target or Configuring an External System as a Source or Target.

8. Click Next: Target Connection.

9. On the Target Connection step, enter the connection details for the event broker service or the vendor system, depending on whether you are creating a source or target Micro-Integration. For more information, see Configuring Your Event Broker Service as a Source or Target or Configuring an External System as a Source or Target.

10. Click  Next: Summary.

11. On the Summary step, verify that the details look correct. You can click any step to go back and make changes. When everything looks right, click Create.

12. A confirmation dialog appears that lists the next steps. You can either:

    • Click Close to edit the Micro-Integration details.

    • Create a Micro-Integration Flow.

Create a Micro-Integration Flow

Your Micro-Integration requires at least one Flow to be deployable. To create a Flow, perform the following steps:

1. If you haven't already, open a Micro-Integration.

2. Click Create Flow.

3. On the Details step:

   1. Enter a unique name for your Flow. Optionally, add a description for it.

   2. Enter the destination details for the Source Connection and the Target Connection. For more information, see Configuring Your Event Broker Service as a Source or Target and Configuring an External System as a Source or Target.

4. Click Next: Mappings.
   

5. (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

   Setting a Smart Topic Destination on the Mappings step overrides the target destination field set on the Details step.

   For more information, see Mapping Headers and Payloads.

6. Click Next: Summary.

7. On the Summary step, verify the details in the Source Connectionand Target Connection sections. If everything looks correct, click Create. A confirmation message appears.

You can now:

• Repeat the preceding steps to create more Flows.

• Edit your Micro-Integration.

• Deploy your Micro-Integration.