Managing IBM App Connect Enterprise integration nodes in IBM webMethods Hybrid Integration

To manage an IBM® App Connect Enterprise integration node in IBM webMethods Hybrid Integration, set up a private network connection. webMethods Hybrid Integration uses this secure connection to administer all the integration servers under the integration node.

Before you begin

  • To configure your integration node with a private network connection, you must use App Connect Enterprise version 13.0.5.0 or later.
  • To manage your integration node with integration runtime management, subscribe to webMethods Hybrid Integration.
  • To register a runtime, you must be assigned to an administrator role in webMethods Hybrid Integration.
  • These instructions assume that you already created an integration server under an integration node in App Connect Enterprise. For more information, see Creating an integration server.
Tip: An integration runtime in webMethods Hybrid Integration refers to the runtime environment where you deploy your integrations. This runtime is referred to as an integration server in App Connect Enterprise, and as an integration runtime in IBM App Connect Enterprise as a Service and IBM App Connect in Containers.

About this task

webMethods Hybrid Integration is a unified, hybrid integration platform as a service (iPaaS) that connects APIs, applications, events, data, messaging, and business-to-business (B2B) and electronic data interchange (EDI) transactions. Integration runtime management is a feature of webMethods Hybrid Integration where you can monitor and manage all your runtime environments, whether they're local or remote. Integration runtime management is available in the Hybrid Control Plane of webMethods Hybrid Integration. For more information, see Integration runtime management overview in the webMethods Hybrid Integration documentation.

If you added the App Connect capability to webMethods Hybrid Integration, integration runtimes that you create in the App Connect capability are registered automatically for runtime management. To manage integration servers under an App Connect Enterprise integration node in webMethods Hybrid Integration, create a secure connection between your integration node and webMethods Hybrid Integration. You configure this connection by using a switchclient.json file that you download from the App Connect capability. The default deployment location (switch_deployment_location) in webMethods Hybrid Integration uses a switch server to connect to the configured integration node.

Procedure

The following steps describe how to configure an App Connect Enterprise integration node and how to register it for runtime management in webMethods Hybrid Integration.

  1. Log in to your webMethods Hybrid Integration instance.
  2. In webMethods Hybrid Integration, open the main menu Icon that represents the main menu of webMethods Hybrid Integration and click Integration runtime management.
  3. Click Register runtime, then App Connect runtimes.
  4. Set the Deployment location to switch-deployment-location.
  5. Click Download the configuration.
    The switchclient.json file is saved to your default download location. This file configures your integration node so that it can connect securely to webMethods Hybrid Integration.
  6. In App Connect Enterprise, stop your integration node by running the following command. 
    ibmint stop node nodeName
  7. In the mqsi/components/mynode/config folder of the integration node's work directory, create a switch folder.
    On Windows, the following example shows the switch folder in the default path of the work directory.
    c:\ProgramData\IBM\MQSI\components\nodeName\config\switch\
    On Linux®, the following example shows the switch folder in the default path of the work directory.
    /var/mqsi/components/mynode/config/switch/
  8. Move the downloaded switchclient.json file to the switch folder of the work directory.
    On Windows, the following example shows the switchclient.json file in the default work directory.
    c:\ProgramData\IBM\MQSI\components\nodeName\config\switch\switchclient.json
    On Linux, the following example shows the switchclient.json file in the default work directory.
    /var/mqsi/components/mynode/config/switch/switchclient.json
  9. Start the App Connect Enterprise integration node by running the following command. 
    ibmint start node nodeName
    Note: Even if the callableFlows property is set to enabled in the switchclient.json file for the integration node, callable flows aren't enabled for integration servers that the integration node manages. To enable callable flows for an integration server, you need to attach a private network agent configuration directly to the integration server as well. For more information, see Splitting processing with callable flows in the App Connect in webMethods Hybrid Integration documentation.
    When the integration node starts, it connects to webMethods Hybrid Integration.
  10. In the Register runtime wizard in webMethods Hybrid Integration, click Next.
    The integration servers in the connected integration runtime are listed.
  11. Select one or more integration servers, then click Add runtime.

Results

A tile in webMethods Hybrid Integration represents the registered integration server. To remove the server from webMethods Hybrid Integration, open the tile menu The icon that represents the Actions menu and click Deregister.

You can now use integration runtime management in webMethods Hybrid Integration to manage and monitor your App Connect Enterprise integration servers alongside your other runtimes. You can start and stop servers, view their contents, and start and stop applications in your servers. For more information, see Managing integration runtimes in the webMethods Hybrid Integration documentation.

Troubleshooting: If you don't see your integration servers in integration runtime management, check that the switchclient.json file is in the correct location.
On Windows:
c:\ProgramData\IBM\MQSI\components\nodeName\config\switch\switchclient.json
On Linux:
/var/mqsi/components/mynode/config/switch/switchclient.json

What to do next

To add new resources to the runtime, you can deploy a BAR file.
  1. Click the integration server to open it.
  2. On the Contents tab for the selected integration server, click Deploy.
    The Contents tab of an integration server shows a tile that represents an application that is already deployed to that server. The Deploy button is available to add another BAR file to this integration server.
  3. To select the BAR file to deploy, click Add a BAR file, select the BAR file from your file system, then click Deploy.
    The Deploy a BAR file dialog box has an Add by file field, where you can select or drag a BAR file. The imported file is then listed and you can click Deploy or Cancel.
    Tiles on the Contents tab of the integration server represent the contents of the new BAR file.
    The Contents tab of the integration server shows two tiles that represent applications that are deployed to that server.