Integrate integration streams

Updated at:

The Mobi platform provides a powerful feature for integrating with integration streams. You can use simple configurations to seamlessly connect to integration streams and interact with their data. This document shows you how to create and use these integrations.

Features

The integration stream feature supports the following:

  • Seamlessly call integration streams.

  • Custom trigger methods. You can set integration operations to trigger manually or run automatically to meet different business needs.

  • Callbacks and data transformation. You can execute specific integration operation events when a query succeeds or fails. You can also customize how the returned data is processed.

  • Advanced settings. You can use advanced configurations for debouncing and execution conditions to optimize integration operations.

For more information about events, see Integration operation events.

Use integration stream integrations

Step 1: Create an integration stream

  1. Log on to the Mobi platform and go to the console.

  2. Navigate to Resources > Integration Stream, and then click Create Integration Stream.

  3. Build the execution logic for the integration stream. For more information about how to build the logic, see Integration Stream.

  4. Click Publish to publish the integration stream to the target environment.

Important

To access an integration stream in an environment, you must first publish it to that environment.

In the application designer, you can access only the integration streams that are published to the development environment.

Step 2: Create an integration operation within an application

  1. Open the Code panel. Click the plus sign (+) for the target scope, and then select Integration Operation.

  2. Select the integration stream that you created as the resource. Configure the parameters for the integration stream as needed. Then, select a trigger method and configure other settings for the integration operation.

  1. Click Run to preview the query results.

Configuration panel details

General configurations

  • Parameters: Set the input parameters based on the definitions in the integration stream.

  • Trigger method: You can choose to trigger the operation manually or have it run automatically. A manual trigger executes only when an integration operation event occurs or when you call the action.trigger method in an API call. An automatic run executes on the initial load and whenever dependencies change. For example, it runs when {{input1.value}} changes.

  • Description: Provide details about the integration stream operation.

Callback configuration

  • Data transformation: Process the data returned by the API. The default is return data, which means the data is not processed.

  • Success callback: Configure the event that triggers when the API call succeeds.

  • Failure callback: Configure the event that triggers when the API call fails.

Advanced configuration

  • Debounce: Set a debounce expression to prevent frequent API calls.

  • Disable execution condition: Use a conditional expression to determine whether to execute the integration operation.

Manually trigger an integration

Event trigger

  1. In the component that needs to trigger the integration operation, configure an event handler.

  2. Set the action type to Integration Operation and select the target integration.

  3. Enter the configured parameters as an object.

API trigger

If the integration operation is named action1, you can call the action1.trigger() method from any script to trigger the operation. If the operation has parameters, you must provide them as an object.