Setting up the User-defined Extension sample

Print these instructions before you start because you must close the IBM Integration Toolkit in Step 4.

To set up both the SearchFilter and the NumCompute samples, complete the following steps:

1. Import the sample. This action adds the following directories to the workspace:
   • UDESampleCCode. This directory contains the source code for the NumCompute node.
   • UDESampleJavaCode. This directory contains the source code for the SearchFilter node.
   • UDESampleLibraries. The Java library for the SearchFilter node is stored in the top level of this project. The C libraries for the NumCompute node are stored in subfolders according to platform.
   • UDESampleMessageFlowProject. This directory contains two sample message flows and two .mbtest files. One message flow and one .mbtest file are available for each of the samples. This project also contains a BAR file containing compiled message flows for both the SearchFilter sample and the NumCompute sample.
   • UDESamplePlugInNodeProject. This directory contains the node definitions for the SearchFilter and NumCompute nodes so that they are displayed in the message flows and the node palette.
   The "Import and partially setup the sample" option adds the preceding directories to the workspace and causes approximately nine errors and two warnings. These errors and warnings are expected, and most are resolved when you complete Steps 5 and 6. However, two warnings might remain:
   • An entry for UDESampleJavaCode.jar is required in bin.includes.
   • The folder "META-INF/" does not exist in the workspace.
2. Export the project UDESamplePlugInNodeProject as a deployable plug-in.
   1. In the Application Development view, right-click the project UDESamplePlugInNodeProject and select Package, then Plug-in JARs.
   2. Click Browse to select a directory location on your machine. Click Finish.
   3. Navigate to the hard-drive location of the exported plug-in and copy the .jar file that is under the plug-ins directory. Paste the .jar file to install_dir/plugins/.

   This step displays the nodes in the message flows and the node palette.

   On Linux: If you are running the Toolkit as a non-root user, you must set the following file permissions:

   • cd install_dir/plugins/UDESamplePlugInNodeProject
   • chmod 666 *
   • chmod 755 icons
3. Cut and paste this set up information to Notepad (on Windows), or to an editor of your choice (on Linux), or print out this page, before you perform the next step.
4. Close the IBM Integration Toolkit.
5. Restart the Toolkit, specifying the -clean option. On Windows, start the Toolkit by using the launcher.bat file, which is found in the product installation directory, and add -clean to the end. Alternatively, modify the menu shortcut with the same change. You can also run the command eclipse -clean from the command line in the product installation directory.
   On Linux, run the eclipse -clean command (./eclipse -clean) from the command line in the product installation directory. You must use the -clean option whenever you make any changes to user-defined extensions (UDEs) so that the changes are picked up by the message flow node palette.
6. If the errors remain in the Toolkit, clean all the projects in the workspace
   1. In the window that opens, click Project > Clean.
   2. Ensure that Clean all projects is selected, click OK.
7. Locate the UDESampleLibraries folder in the Application Development view.
8. Expand the appropriate platform specific subfolder until you can see both the .jar file and the relevant .lil file.
9. Press and hold Ctrl and select the .lil and .jar files.
10. To export the UDESampleJavacode.jar file and the relevant NumComputeNode.lil file into a temporary directory, click File > Export > General > File system, click Next.
11. In the To directory enter the details of the directory into which you want to export the files, for example, on Windows C:\UserLibraries, or on Linux /tmp/userLibraries, click Finish. If you enter the name of a directory that does not exist, the directory is created for you automatically. You must have permission to write to the directory that you select.
12. In the IBM Integration command console (for Windows), or a terminal window (for Linux), run the mqsiprofile command, then enter the following command at the command prompt:

    mqsistop IB9NODE

13. At the prompt, enter the following command:

    mqsichangebroker IB9NODE -l <directory_from_step_11>

14. At the prompt, enter the following command:

    mqsistart IB9NODE

15. Click the Integration Nodes view.
16. Expand IB9NODE.
17. Locate the UDESampleMessageFlowProject folder in the Application Development view, expand Broker Archives until you can see the UDESampleArchive.bar file.
18. Deploy the UDESampleArchive.bar BAR file by dragging it onto the UDESampleExecutionGroup integration server.

The BAR file contains compiled message flows for both the SearchFilter and the NumCompute samples. You can see two deployed message flows within UDESampleExecutionGroup.

You can now run the samples. See Running the User-defined Extension sample.

Back to sample home