Configuring an environment for independent DFDL applications

Prepare the system environment in which you want to develop and run your independent applications that use the IBM® DFDL API.

Before you begin

Before you start:

Before you can develop and run Java™ application programs that use the IBM DFDL API, you must install the following prerequisite software on your local computer environment:

  • An IBM Java Development Kit (JDK) at a supported Java level.

    A JDK is not supplied with IBM Integration Bus; you must acquire and install a suitable product yourself. You must use an IBM JDK to develop IBM DFDL independent programs and an IBM Java Runtime Environment (JRE) to run these programs. For information about supported Java levels, see IBM Integration Bus system requirements.

About this task

To set up your computer in preparation for building and running IBM DFDL independent programs, you must configure your class path environment variable so that it includes all the JAR files needed for IBM DFDL. The instructions use the Windows path separator; but apply equally to other operating systems, if you change the separator.

Procedure

Update the class path environment variable:

  1. Add all of the JAR files that are required for IBM DFDL.
    For example:
    set CLASSPATH=%CLASSPATH%;install_dir\server\dfdl\lib\ibm-dfdl.jar
    Repeat this step for each JAR file in your install_dir\server\dfdl\lib directory, where install_dir is the directory that you specified as the installation directory for IBM Integration Bus. Alternatively, to add all of the required JAR files, run the dfdlprofile utility that is provided in your install_dir\server\dfdl\bin directory.
  2. If you want to run and explore the IBM DFDL sample, add the dfdlsample_java.jar JAR file that is provided in your install_dir\server\sample\dfdl directory.
    For example:
    set CLASSPATH=%CLASSPATH%;install_dir\server\sample\dfdl\dfdlsample_java.jar
  3. Add your Java development directory.
  4. Add any other JAR files and directories that you require.

What to do next

Next:
  • Use the tools that are provided by your JDK to build and run your IBM DFDL independent programs.
  • If a system that you want to run your IBM DFDL API independent programs does not have the IBM Integration Bus runtime component installed, you must complete additional configuration steps; see Configuring environments without the integration node component installed.