webMethods Cloud Applications

A group of services that you share with IBM® webMethods Integration is called as an application. On-premises applications are created on the on-premises Integration Server and uploaded to IBM webMethods Integration. IBM webMethods Integration runs any service that is hosted by an on-premises Integration Server.

When you share services in an application, you are sharing the metadata for the service. For Integration Server services, the metadata you share is the service name, service signature, display name, and service comments. You can then create integrations in IBM webMethods Integration that start services defined in the applications. When IBM webMethods Integration runs a service, the on-premises Integration Server returns all the results to IBM webMethods Integration. You can batch the results to limit the number of results that are returned to IBM webMethods Integration.

After you create applications, you upload them to IBM webMethods Integration. If the application changes on the on-premises Integration Server, you must upload the application again for the changes to be replicated on IBM webMethods Integration.

When you upload applications to IBM webMethods Integration, you associate one or more accounts that the application can use to access services on the on-premises Integration Server. If the account associated with an application changes, you can upload the account to IBM webMethods Integration without having to upload the application.

Defining on-premises applications to share with IBM webMethods Integration

To define an on-premises application to share with IBM webMethods Integration, in the webMethods Cloud menu, click Applications > Define webMethods Cloud Application and under webMethods Cloud Application, complete the following fields.

  • Name: A unique name for the application. The application name cannot exceed 32 characters, contain reserved words and characters that are used in Java or C/C++ (such as for, while, and if), or the following invalid characters: "#-&@^!%*:$./\`;,~+=)(|}{][><"
  • Description: Description of the application.
  • Assign Services to Application: Specify the services to show to IBM webMethods Integration. Under Package/Services, click the + icon to expand the services available in the package. Select each service that you want to expose to IBM webMethods Integration. If you want the service to return results in batches rather than return the results all at once, click Batch Data. If the top level output signature of the service contains only one field, and the field is a document list or document reference list (both of which are IData arrays), Batch Data is selected by default. Otherwise, it is cleared. Under Display Name, specify the name of the service as it should appear in IBM webMethods Integration or accept the default. The Display Name field cannot contain reserved words and characters that are used in Java™ or C/C++ (such as for, while, and if) or the following illegal characters: "#-&@^!%*:$./\`;,~+=)(|}{][><"
Note: Applications are displayed in IBM webMethods Integration as on-premises connectors. Operations are named according to the name defined in the Display Name field.

Uploading on-premises applications

After you define an on-premises application, you must upload the application to IBM webMethods Integration before using it. To upload an application, open the Integration Server Administrator and in the webMethods Cloud menu, click Applications.

Click one of the following icons in the row that corresponds to the application you want to upload in the Upload column.

Icon Description
New or have been edited since the last time it was uploaded to IBM webMethods Integration. For a new application, the icon indicates that the application has not been uploaded to IBM webMethods Integration. For an application that exists on IBM webMethods Integration, the icon indicates that the application on the on-premises Integration Server is not synchronized with the one on IBM webMethods Integration.
Synchronized with the application that has already been uploaded to IBM webMethods Integration.

When the Upload Application screen appears, in the Select Accounts area, select one or more accounts to associate with the application and then click Upload.

When you upload the on-premises application, the on-premises Integration Server uploads the application to IBM webMethods Integration, replacing the existing on-premises connector. It updates the Last Uploaded Time column of the webMethods Cloud Applications screen to indicate that the on-premises connector on IBM webMethods Integration is synchronized with the one on the on-premises Integration Server. It also shares the service name, service signature, display name, and service comments with IBM webMethods Integration. If the application has been uploaded earlier, uploading the application again overwrites the existing on-premises connector. Further, if any account associated with an application is disabled during an upload, Integration Server uploads the application successfully and notifies you to enable the account to serve any requests.

Note: Applications that are uploaded from the on-premises Integration Server are listed in the Connectors > On-Premises Connectors page in IBM webMethods Integration.

When you no longer want to share on-premises applications with IBM webMethods Integration, you can delete them. Deleting an application from the on-premises Integration Server also deletes the application and its corresponding operations from IBM webMethods Integration.

After creating an application, you can edit the application details. If you edit an application, you must upload the application for the changes to take effect on IBM webMethods Integration. The updated application is not available for use until you upload it.

Sharing metadata on an on-premises Integration Server

You can create on-premises applications on the on-premises Integration Server to share services with IBM webMethods Integration.

Points to note while sharing services through an application

  • You can share only services running on the on-premises Integration Server that is configured to create applications on IBM webMethods Integration.
  • You can share only services that are contained in custom packages.
  • You can share services from different packages in the same application. For example, if service A is located in package A, and service B is located in package B, you can add both service A and service B to the same application.
  • You can share only those services whose signatures are of the following data types: String, String List, Document, Document Reference, Document List, Document Reference List, Object, Object List.
  • You can share only those services that have an input and/or output signature specified.
  • You can set the on-premises Integration Server to send service results to IBM webMethods Integration in batches.
  • You cannot share service signatures that include cyclical dependencies of document references, fields of type String Table, including fields of type String Table in a Document, and an empty Document or Document List.
  • When the server log facility code 0021 webMethods Cloud is set to the Debug log level, Integration Server writes log messages that indicate why an on-premises service is marked as not shareable.
  • Configure one or more accounts to associate with the application before you can upload the application to IBM webMethods Integration.
  • Upload the application for the updates to be shared with IBM webMethods Integration if you edit either the application or the signature or referenced Document of a service that is shared by the application.
  • When you upload an application, it replaces the application and operations available on IBM webMethods Integration with the one that you upload.