How to upload an application and use it in a workflow

See an example of how to upload an application and use it in a workflow.

High-level steps

  1. Log in to the Integration Server instance.

  2. Create an account on the on-premises Integration Server.

  3. Create the application that you want to run on IBM® webMethods Integration.

  4. Upload the application on IBM webMethods Integration.

  5. Use the uploaded application in a Workflow.

Log in to the Integration Server instance

Log in to your Integration Server instance, click the webMethods Cloud option that is listed on the left-side panel, and then click Tenant connections. Enter the following details on the Settings screen. Once done, click Update Settings to save the settings.

  • Username: Enter the email ID of your IBM webMethods Integration account.
  • Password: Enter the password of your IBM webMethods Integration account.
  • webMethods Cloud URL: Enter the complete tenant URL of your IBM webMethods Integration account.

Create an account on the on-premises Integration Server

An account on the on-premises Integration Server acts as a two-way communication channel for data transfer between the on-premises Integration Server and IBM webMethods Integration. So when you run the application uploaded on IBM webMethods Integration, it in turn starts the application instance that is deployed on the on-premises Integration Server where the actual execution takes place. The output or response of this execution is then sent back to IBM webMethods Integration.

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

On the Create Account configuration screen, enter the following details:

  • General Settings

  • Enable: Select Yes to enable the account when 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 run 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-premises Integration Server. This is applicable only if you are batching the data.

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

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

Once this is done, click Test Account Settings. This verifies whether the details entered by you are valid or not. If the entered details are valid, you get a notification message stating so. Click Save Changes to save the account settings.

Create the application that you want to run on IBM webMethods Integration

You need to create the applications you want to run by using IBM webMethods Integration on the Integration Server. Once created, these applications can then be uploaded to IBM webMethods Integration where they can be used in the workflows and Flow services.

To create an application, go to webMethods Cloud > Applications and click Define webMethods Cloud Application.

In the Define Application configuration window, 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 IBM webMethods Integration account. 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 that you want to add as operations in your application.

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

Upload the application on IBM webMethods Integration

After you have created the application, you need to upload it to IBM webMethods Integration in order to use it in your workflow or Flow service. When you upload an application to IBM webMethods Integration, the metadata of its services such as name, description, and Input/Output signature is also uploaded to that application.

To upload the application, go to webMethods Cloud > Applications, locate the application that you want to upload in the webMethods Cloud Applications list, and click Upload.

With this, you have successfully created the application in your webMethods Integration Server, which you can use in your IBM webMethods Integration workflows and Flow services.

Use the uploaded application in a Workflow

Let us see how to use this application in a workflow. Log in to IBM webMethods Integration. You will find the uploaded application (onPremise_app) in the Connectors panel on the right-side of the canvas.

You can use this application like any other connector in your workflow.

When you double-click the application icon (onPremise_app), you can see that the configuration window is the same as that of any other connector available in IBM webMethods Integration. Select the action (myService) and click Next.

You are redirected to the action configuration screen, where you can add the relevant details to run the action.

You can optionally test the action and then click Done. This takes you back to the canvas. Once you have configured the rest of the workflow, save it.

Whenever you run the workflow, IBM webMethods Integration sends the request to Integration Server to run the added application and Integration Server in turn sends back the execution response to IBM webMethods Integration. This data can then be used to run the rest of the workflow.

Important: A workflow, which contains an on-premises connector cannot be cloned.

Start Flow services for on-premises connectors

Click On-Premises Connectors to see an example of how to start Flow services for on-premises connectors.