Installing user-defined extension runtime files on an integration server

Install the compiled runtime files for your user-defined extension on the integration server on which you want to test its function. If your user-defined node uses a custom compiler, install the user-defined node plug-in to the integration server on which you want to deploy the node.

Before you begin

Create and compile your user-defined extension using the procedure described in Compiling a Java user-defined node or Compiling a C user-defined extension.
- The files that have been created for extension created in C depend on the operating system:
  A dynamic link library (DLL), named with a file type of .lil.
  
  A shared object, again with a file type of .lil.
- For Java nodes, a Java Archive file (JAR), with a file type of .jar (on all operating systems).
If you have created a user-defined node, you must also complete the task that is described in Creating the user interface representation of a user-defined node in the IBM App Connect Enterprise Toolkit.
If your user-defined node contains a custom compiler, you must package your user-defined node project; see Packaging and distributing a user-defined node project.

About this task

This task instructs you to stop and restart integration servers. This action is required in all cases, although if you do stop and restart an integration server, you should ensure that anyone with an interest in a particular integration server is made aware that recent changes have been made.

This task is applicable to user-defined nodes written in Java or C only. If your user-defined node contains a custom compiler, you must install the compiled runtime files and the user-defined node plug-in to the integration server. If your user-defined node does not contain a custom compiler, install only the compiled runtime files to the integration server.

To install runtime and user-defined node plug-in files on the integration server:

Procedure

Stop the integration server on which you want to install your compiled or packaged user-defined extension file (files with extension .lil, .jar, .par, .pdb, or .lel)
This is required in all cases, there are no exceptions.
Create a directory if you do not already have one for this purpose.

For example:

C:\Work\Development\Demo\Plugins\bin

CAUTION:
Do not put the .lil, .jar, .par, .pdb, or .lel files in the IBM App Connect Enterprise installation directory, because they might be overwritten.
Put your user-defined file in the directory, and make sure that the integration server has access to it.
For example, on Linux® use the chmod 755* command on the file. If your user-defined node contains a custom compiler, put your user-defined plug-in file in the same directory.
Restart the integration server to implement the change and to ensure that the existence of the new file is detected.
Repeat the previous steps for every integration server that needs the user-defined extension file and user-defined node plug-in file. If all of your integration servers are on the same operating system type, you can build the user-defined extension file once and distribute it to each of your systems.

If you have a cluster that includes Linux and Windows integration servers, you must build the user-defined extension files separately on each operating system type.

On Windows, the .pdb file provides symbolic information that is used when stack diagnostic information is displayed in the event of access violations or other software malfunctions.
For C user-defined extensions, store the .pdb file in the same directory as the .lil file to which it corresponds.
Add the directory to the LILPATH by updating the server.conf.yaml configuration file.

For example:

lilPath: C:\Work\Development\Demo\Plugins\bin

Results

The integration server loads the user-defined extension files during initialization. After loading the files, the integration server calls the registration functions in the user-defined extension and records what nodes or parsers the user-defined extension supports.

A C user-defined extension implements a node or parser factory that can support multiple nodes or parser types. For more information, see Node and parser factory behavior. Java users are not required to write a node factory.