Hybrid Integration

The Hybrid Integration feature allows you to access your on-premise applications—that are normally inaccessible due to security restrictions, firewalls, or licensing issues—via webMethods.io Integration platform. This feature establishes a secure connection between webMethods.io Integration platform and your server behind the firewall. As a result, you can easily consume data from your on-premise applications, and use those applications in your workflow. Because of Hybrid Integration, you can pass data from your workflow to on-premise application and in-return get processed data back to your workflow.

Let’s now glance through the steps involved in creating a hybrid integration:

Overview of Steps

  • Step 1: Login to Integration Server instance
  • Step 2: Create account on on-premise Integration Server
  • Step 3: Create the application you want to run on webMethods.io Integration
  • Step 4: Upload the created application on webMethods.io Integration

Detailed Steps

Step 1: Login to Integration Server instance

Before we can start creating the hybrid integration, we need to connect the Integration Server instance with your webMethods.io Integration account where you want to execute the workflows.

To do so, login to your Integration Server instance, click webMethods Cloud menu listed in the left-side panel, and click Settings option.

1-login-to-ic.png

Enter the following details in the Settings screen that appears:

User Name:
Enter the email ID of your webMethods.io integration account.

Password:
Enter the password of your webMethods.io integration account.

webMethods Cloud URL:
Enter the complete tenant URL of your webMethods.io Integration account.

2-login-details.png

Once this is done, click Update Settings button to save the settings.

Step 2: Create account on on-premise Integration Server

An account on the on-premise Integration Server acts as a two way communication channel for data transfer between the on-premise Integration Server and webMethods.io Integration.

So, when you execute the application uploaded on webmethods.io Integration, it in turn invokes the application instance deployed on the on-premise Integration Server where the actual execution takes place. The output/response of this execution is then sent back to webMethods.io Integration.

To create a new account, navigate to webMethods Cloud > Accounts, and click on Create On-Premise Account link.

3-create-account.png

In the account configuration screen that appears, enter the following details:

General Settings

Enable: Select Yes to enable the account as soon as you create it.

Alias Name:
Provide a suitable name for the account.

Description:
Provide a short description for the account.

Stage:
Select the relevant stage (Development, Live, Pre-live, Test) where you want to execute the exposed applications.

Account Settings

Maximum Reconnection Attempts: Enter the maximum number of times reconnection should be attempted before throwing the error.

Request Timeout:
Enter the maximum limit (in milliseconds) for request timeout.

Time to Live:
Enter the time (in milliseconds) for which the execution results should remain in the cache of the on-premise Integration Server. This is applicable only if you are batching the data. This value must be greater than 0. By default, this value is set to 60 seconds.

Allowed On-Premise Hosts:
The on-premise Integration Cloud can use multiple addresses to access webMethods.io Integration. You can specify a comma-separated list of IP addresses that can receive requests from webMethods.io Integration. Only these IP addresses can receive requests.

Run As User:
Click on the Search icon and select relevant user role (Administrator, Default, Developer, Replicator) as per your requirements.

4-save-account.png

Once this is done, click Test Account Settings. This will verify whether the details entered by you are valid or not.

If the entered details are valid, you will get a notification message stating so. You can then click on Save Changes button to save the account settings.

Step 3: Create the application

You need to create the applications you want to execute using webMethods.io Integration on the Integration Server. Once created, these applications can then be uploaded on to webMethods.io Integration where they can be used in workflows.

To create an application, navigate to webMethods Cloud > Applications and click on Define webMethods Cloud Application link.

5-define-app.png

In the application configuration window that appears, enter the following details:

Name:
Provide a suitable name for the application. This name will be visible to you as the application name in the Connectors panel of your webMethods.io integration account. Note: Spaces are not allowed in the application name. You can replace the spaces with underscores instead. For example, my_application

Description:
Provide a short description for the application.

Assign Services to Application:
Select the relevant services you want to add as operations in your application.

Note:
The Service which has wrapper type fields (i.e. fields of type other than String and IData) in its Input or Output signature cannot be exposed to webMethods.io Integration and it will not be available in the package/Service column mentioned below.

6-define-app-screen.png

Once this is done, click Save Changes. This will create the specified application.

Step 4: Upload the created application on webMethods.io Integration

Once you have created an application, you need to upload it to webMethods.io integration in order to use it in your workflow. When you upload an application to webMethods.io integration, the metadata of its services such as name, description, and Input/Output Signature is also uploaded to the said application.

To upload the application, navigate to webMethods Cloud > Applications, locate the application you want to upload in the webMethods Cloud Applications list, and click on the Upload icon.

7-upload-app.png

With this, you have successfully created the application in your webMethods Integration Server which can be used in your webMethods.io integration workflows.

After this, whenever you login to your webMethods.io Integration account, you will find the uploaded application in the Connectors panel on the right-side of the canvas.

9-canvas.png

You can now use this application, like any other connector in your workflows.

10-workflow.png

When you double-click on the application icon, you can see that the configuration window is same as that of any other connector available on webMethods.io Integration. 

Once you have selected the action, you will see the name and account (you had specified while creating the application) being used to execute the workflow. After this, click Next.

12-action-next.png

You will be redirected to the action configuration screen, where you can add relevant details to execute the action.

13-config-action.png

After this, click Next, optionally test the action, and then click Done. This will take you back to the canvas. Once you have configured the rest of the workflow, save it. 

After this, whenever you execute the workflow, the webMethods.io Integration will send request to Integration Server to execute the added application and Integration Server will in turn send back the execution response to webMethods.io Integration platform. This data can then be used to execute the rest of the workflow.