Managing Applications

About Sharing Metadata on an On-Premise Integration Server

You create applications on the on-premise Integration Server to share services with Integration Cloud. Keep the following points in mind while sharing services through an application:

  • You can share only services running on the on-premise Integration Server configured to create applications on Integration Cloud.
  • You can share only services 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 that have an input and/or output signature specified.
  • 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
  • Any Object or Object List placed into the service pipeline, and therefore any Object or Object List in a service signature, must be a serializable data type. If it cannot be serialized, the pipeline cannot be exchanged with a remote Integration Server. Further, the class names for the data type must be included in the Integration Server whitelist classes file or a package whitelist classes file for the pipeline to be deserialized at the destination Integration Server. Classes defined by Integration Server are already included in the whitelist class file. This requirement applies to all Object and Object List variables, including those contained in a Document or Document List. For more information about the Integration Server whitelist, see the webMethods Integration Server Administrator’s Guide.
  • You can set the on-premise Integration Server to send service results to Integration Cloud 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.
    • An empty Document or Document List.
  • You must configure one or more accounts to associate with the application before you can upload the application to Integration Cloud. For more information about configuring accounts, see Configuring Accounts for Integration Cloud.
  • You must upload the application for the updates to be shared with Integration Cloud if you edit:
    • The application.
    • The signature or referenced Document of a service shared by the application.
  • When you upload an application, it replaces the application and operations available on Integration Cloud with the one that you upload.

Viewing the Applications that Reside on Your Server

About this task

The Applications screen lists all of the applications on the on-premise Integration Server that you can share with Integration Cloud.

To view the applications you can share with Integration Cloud from the on-premise Integration Server

Procedure

  1. Open the Integration Server Administrator if it is not already open.
  2. In the webMethods Cloud menu of the navigation panel, click Applications.

    The Applications screen displays the list of applications that were created on the on-premise Integration Server. Integration Server Administrator displays the following information for each application:

    Column Description
    Name Name of the application.
    Description Description of the application.
    Last Uploaded Time The last time the application was uploaded to Integration Cloud.
    Upload Displays one of the following icons to allow you to upload the application:
      This icon... Indicates that the application is...
      New or has been edited since the last time it was uploaded to Integration Cloud.
      Synchronized with the application that has already been uploaded to Integration Cloud.
    Delete Displays the icon to allow you to delete the application from the list and from Integration Cloud.

Defining Applications

About this task

Perform the following procedure to define applications to share with Integration Cloud.

To define an application to share with Integration Cloud

Procedure

  1. Open the Integration Server Administrator if it is not already open.
  2. In the webMethods Cloud menu of the navigation panel, click Applications.
  3. Click Define webMethods Cloud Application.
  4. Under webMethods Cloud Application, complete the following fields:
    Field Description
    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 illegal characters:

    "#-&@^!%*:$./\\`;,~+=)(|}{][><"
    Description Description of the application.
  5. In the Assign Services to Application area, specify the services to expose to Integration Cloud as follows:
    1. Under Package/Services, click to expand the services available in the package.
    2. Select each service you want to expose to Integration Cloud.
    3. If you want the service to return results to Integration Cloud in batches, rather than returning 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 will be cleared.

      By selecting this option, Integration Server uses pub.flow:iterator to batch service results. For more information about the pub.flow:iterator service, see webMethods Integration Server Built-In Services Reference.

    4. Under Display Name, specify the name of the service as it should appear in Integration Cloud 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 Integration Cloud as operations. Operations are named according to the name defined by the Display Name field. For more information about operations in Integration Cloud, see webMethods Integration Cloud Help.
  6. Click Save Changes.

Uploading Applications

About this task

After you define an application, you must upload it to Integration Cloud before using it in an integration.

To upload an application

Procedure

  1. Open the Integration Server Administrator if it is not already open.
  2. In the webMethods Cloud menu of the navigation panel, click Applications.
  3. Click one of the following icons in the row that corresponds to the application you want to upload in the Upload column of the webMethods Cloud Applications table.
    This icon... Indicates that the application on the on-premise Integration Server is...
    New or has been edited since the last time it was uploaded to Integration Cloud.
    • For a new application, this icon indicates that the application has not been uploaded to Integration Cloud.
    • For an application that already exists on Integration Cloud, this icon indicates that the application on the on-premise Integration Server is not synchronized with the one on Integration Cloud.
    Synchronized with the application that has already been uploaded to Integration Cloud.
  4. When the Upload Application screen appears, from the Select column of the Select Accounts area, select one or more accounts to associate with the application.
  5. Click Upload.
  6. When Integration Server asks you to confirm that you want to upload the application, click OK.

    When you upload the application, the on-premise Integration Server:

    • Uploads the application to Integration Cloud, replacing the existing application.
    • Updates the Last Uploaded Time column of the webMethods Cloud Applications screen to indicate that the application on Integration Cloud is synchronized with the one on the on-premise Integration Server.
    • Shares the service name, service signature, display name, and service comments with Integration Cloud.
    Note: If the application has been uploaded previously to Integration Cloud, uploading the application again overwrites the existing application.

Results

Note: If any account associated with an application is disabled during an upload, Integration Server uploads the application successfully. However, you will be notified to enable the account to serve any requests originating from Integration Cloud.

Deleting Applications

About this task

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

To delete an application

Procedure

  1. Open the Integration Server Administrator if it is not already open.
  2. In the webMethods Cloud menu of the navigation panel, click Applications.
  3. Click the icon in the row that corresponds to the application you want to delete in the Delete column of the webMethods Cloud Applications list.
  4. When Integration Server asks you to confirm that you want to delete the application, click OK.

Editing Applications

About this task

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 Integration Cloud.

To edit an application

Procedure

  1. Open the Integration Server Administrator if it is not already open.
  2. In the webMethods Cloud menu of the navigation panel, click Applications.
  3. Locate the application you want to edit and click on the name in the Name column.
  4. Update the information for the application.
  5. Click Save Changes.
    Note: The updated application is not available for use on Integration Cloud until you upload it to Integration Cloud. Until then, Integration Cloud uses the last version of the application that you uploaded. To upload the application, follow the procedure described in Uploading Applications.