A message flow that you create in IBM® App Connect Enterprise or IBM Integration Bus can complete many different actions. If any of those actions are labor-intensive, you can split them from the main flow and complete them somewhere else.
For example, some parts of a message flow might logically belong in a specific location: if your flow queries an on-premises database, performance is better if that part of the flow remains on premises. But if part of your flow queries a website multiple times, performance might be improved by running that part of the flow in the cloud. You can call the cloud-based flow from your on-premises flow, and the flow in the cloud doesn’t use any of your on-premises resources.
These callable flows also facilitate reuse because they can be called by multiple message flows. You can deploy both flows to App Connect Enterprise or Integration Bus, or you can run them in an integration server in App Connect on IBM Cloud™. You can also run one flow in App Connect on IBM Cloud, and the other flow on premises in App Connect Enterprise or Integration Bus.
If your callable flows are both deployed to your on-premises system, or both running on an integration server in App Connect on IBM Cloud, they can communicate with each other as soon as you deploy them. But if you’re splitting processing between your on-premises system and App Connect on IBM Cloud, you have to configure secure connectivity between them. Your flows can then communicate by using a Switch server and connectivity agents. The Switch server is a special type of integration server on premises that routes data. The connectivity agents contain the certificates that your flows require to communicate securely with the Switch server.
The following instructions describe how to create a communication link between flows that you’ve split between App Connect on IBM Cloud and App Connect Enterprise or Integration Bus. You can split your flows into multiple callable flows, but for simplicity, this tutorial assumes that you’re creating just two flows: a calling flow and a callable flow.
First, find or create everything you need:
- Develop your split message flows in the IBM App Connect Enterprise or Integration Toolkit (see Developing synchronously callable message flows in the App Connect Enterprise documentation).
- Deploy the flows that you want to run on-premises to an App Connect Enterprise or Integration Bus integration server.
- Upload the BAR file that contains the flows that you want to run in the cloud to App Connect on IBM Cloud (see Running your IBM App Connect Enterprise solutions in IBM App Connect on IBM Cloud).
Next, configure connectivity between your split flows:
- In App Connect on IBM Cloud, open the hamburger menu , expand Manage, then click Callable flows.
If you’ve not configured callable flows before, the list will be empty, and the status of connectivity is “Connectivity paused”.
- Click Connect callable flows.
A dialog box opens to set up your agent.
- Click Download the configuration.
- For App Connect Enterprise, save the agent configuration file (
agentx.json) to the following location on the computer where App Connect Enterprise is installed:
(If you don’t see this directory, you’ll need to create the work directory for your integration server by running the
mqsicreateworkdircommand in App Connect Enterprise. For more information, see Configuring an integration server in the App Connect Enterprise Knowledge Center.)
- For Integration Bus, save the agent configuration file (
agentx.json) to the same computer where Integration Bus is running. Start an IBM Integration Bus command environment, then run the following
mqsichangepropertiescommand for the integration server that contains your callable flow.
mqsichangeproperties integrationNodeName -e integrationServerName -o ComIbmIIBSwitchManager -n agentXConfigFile -p filepath\agentx.json
mqsichangeproperties integrationNodeName -e integrationServerName -o ComIbmIIBSwitchMan
- In App Connect on IBM Cloud, click Test your agent to ensure that your flows that are split between the cloud and on premises can communicate with each other. If the test is successful, close the dialog box.
- Click Restart.
The status should change to “Started”.
Youâ€™ve configured secure communication between your split flows on premises and in the cloud. You’re now ready to start the integration server that contains your split flows. You can then see details of your split flows on the Callable flows page.
If you can’t find what you want, or have comments about this tutorial, please either add comments to the bottom of this page or send us your comments by email.