Developing subflow user-defined nodes in a static library

You can develop a subflow user-defined node in a static library to extend the function of IBM® App Connect Enterprise.

About this task

Two roles of users exist, who can use the capability of subflow user-defined nodes that are developed in a static library: subflow user-defined node authors and subflow user-defined node consumers.
  • Subflow user-defined node authors are developers of IBM App Connect Enterprise who want to develop, test, and package a subflow user-defined node that is used for a specific purpose. Subflow user-defined node authors do the following tasks:
    • Develop and test subflow user-defined nodes.
    • Package and distribute subflow user-defined nodes.
As a subflow user-defined node author, you develop a subflow user-defined node by first creating a subflow in a static library. Then, add nodes in the subflow so that the subflow serves a specific purpose. You then test the subflow user-defined node by adding the subflow to a message flow and testing the message flow. After you verify the behavior of the subflow user-defined node, you generate a packaged subflow user-defined library from the static library that contains the subflow user-defined node that you developed. The packaged subflow user-defined library is in the form of a .zip file, which you distribute to subflow user-defined node consumers who want to install your subflow user-defined node to use in message flows.
As a subflow user-defined node author, if you develop a subflow as a user-defined node within a static library, you have the following benefits:
  • You can include other resources, such as ESQL, maps, subflows, and message models within the function of a subflow user-defined node.
  • During development, you can use the flow debugger to step into the subflows.
  • During development, you can use the IBM App Connect Enterprise web user interface to view the internal structure of the subflow.
Subflow user-defined node consumers are developers of IBM App Connect Enterprise message flows who want to use subflow user-defined nodes in their message flows.
As a subflow user-defined node consumer, if you install a subflow that is packaged as a user-defined node within a static library, you have the following benefits:
  • The subflow node icons appear in the palette and you can include them in your message flows.
  • The contents of the user-defined-node are hidden. The IBM App Connect Enterprise Toolkit and the IBM App Connect Enterprise web user interface display the subflow as a single node.
  • You can deploy message flows that use subflow user-defined nodes as source deployment. It is not necessary to compile them inline to produce a cmf in the BAR file.
  • You can use subflow user-defined nodes in subflows, so that you can use their features, and other features such as REST APIs and integration services, in subflows.
  • The contents of the user-defined subflow node are automatically packaged within the BAR file for applications that use the user-defined subflow node.

For a demonstration of how to create a subflow user-defined node by using the IBM App Connect Enterprise Toolkit, see the following video: Creating and using a subflow user-defined node.

Procedure

As a subflow user-defined node author, develop, test, package, and distribute a subflow user-defined node by completing step 1 to step 4:

  1. Developing a subflow user-defined node from a subflow in a static library
  2. Testing a subflow user-defined node
  3. Packaging a subflow user-defined node by generating a packaged subflow user-defined library
  4. Distributing a packaged subflow user-defined library

As a subflow user-defined node consumer, install or uninstall a user-defined node by completing step 5 and step 6:

  1. Installing a subflow user-defined node
  2. Uninstalling a subflow user-defined node