Requirements - EnterWorks_Process_Exchange_(EPX) - 10.6

EnterWorks EPX Programmers Reference

Product type
Product family
Precisely EnterWorks > EnterWorks Process Exchange (EPX)
Product name
Precisely EnterWorks
EnterWorks EPX Programmers Reference
Topic type
Programming Reference
First publish date

Currently, all custom applications developed for EPX must be written in Java. To develop and run application software to use with EPX, you need the following:

  • The EPX client libraries installed on your development machine. These are available as part the EPX installation when the option to install EPX documentation is selected.

  • The EPX API examples, which are available in the examples\api directory of an EPX installation.

  • The EPX public API documentation, Javadoc format, which is available in the docs\javadoc directory of an EPX installation.

  • The JDK, Version 1.5.0, or an integrated development environment (IDE) that supports JDK 1.5.

Finally, EPX should be installed and running properly. (Refer to the release notes and the Installation and Configuration guide for information about how to install and start the server.)

The collection of API examples that are provided in the EPX installation can be compiled using the build.bat command file on Windows platforms. The API examples can be executed using the run.bat command file on Windows platforms. These files are located in the examples\api directory of an EPX installation. When the option to install EPX documentation is selected, the file setenv.bat or a Windows platform is also included in the installation of EPX on your development machine. All the necessary jar files needed to utilize the various packages or facades are already defined inside the setenv.bat. In order to compile the examples, there are a few changes that need to be made to the file setenv.bat on Windows platforms. The file is located in the examples directory of an EPX installation and are as follows:

  • Change the environment variable EPX_HOME to match the base installation directory of your EPX installation. For example, C:\Enterworks\EPX on Windows platforms.

  • Change the environment variable EXAMPLE_JDK_HOME to match the base installation directory of your Java Software Development Kit (SDK) installation. For example, C:\JDK1.5 on Windows platforms.

  • Make sure that the < EPX_HOME>/bin directory is included in the classpath. This is needed to make it possible to find an EPX server to log in.

To make use of the EPX APIs, these are the jar files included in the file setenv.bat on Windows platforms with their corresponding directories:

  • < EPX_HOME>/lib/eclient.jar

  • < EPX_HOME>/lib/esm.jar

  • < EPX_HOME>/lib/soap/soap.jar

  • < EPX_HOME>/lib/soap/mail.jar

  • < EPX_HOME>/lib/soap/castor-xml.jar

  • < EPX_HOME>/lib/soap/activation.jar

  • < EPX_HOME>/jboss/client/jbossall-client.jar

  • < EPX_HOME>/jboss/client/jbosssx-client.jar

  • < EPX_HOME>/boss/client/jnp-client.jar

  • < EPX_HOME>/jboss/client/log4j.jar

  • < EPX_HOME>/tomcat/common/lib/servlet.jar

  • < EPX_HOME>/lib/enterworks-commons-0.5-SNAPSHOT

Note: Users can modify the settings for the setenv.bat file if they wish to add or delete libraries.

If using JRE:

  • < EPX_HOME>/jre/lib/rt.jar

Before continuing, it is advisable to set up your environment and compile the public API examples. In order to compile the examples, change directories to the examples directory on your EPX installation and type the following commands based on your platform:

  • Windows:

C:\> cd C:\Enterworks\EPX\examples\api

C:\Enterworks\EPX\examples\api> build.bat