Installing the Process Development Environment - FileNet Web Services

The PJAC and Toolkit Installation CD includes a Process Development Environment for developers. The Process Development Environment for the FileNet Web Services web application consists of a set of JAR files that contain the Java API runtime classes, Process API samples, sample HTML and Java Step Processor applets/applications (available for customization), and library and toolkit files.

Subtopics include:

Process Development Environment Overview

The Process Development Environment for FileNet Web Services consists of (for further details, see Process Development Environment Contents below):

Process Development Environment Installation Procedure

Prerequisites: This procedure assumes that you have already installed FileNet Web Services and the Process Engine and that you have run the PJAC installer and have installed PJAC for FileNet Web Services.

To install the Process Development Environment on your development system, use the following procedure (if you are working on a web server on which PJAC has been installed, much of this procedure has already been done by the PJAC installer):

  1. Insert the PJAC and Toolkit Installation CD into the CD-ROM drive on your system.
  2. On the CD, locate the ...\FileNet\IDM\Web\IDMWS\Developer Files folder.

Note The locations listed in this topic may vary from the actual location on the Installation CD. If you have difficulty locating the ...\Developer Files folder, search for the MainSample.java file on the Installation CD. This should help you find the ...\Developer Files\Samples\API folder location on the CD.

  1. Copy the ...\FileNet\IDM\Web\IDMWS\Developer Files folder, and all its subdirectories, to your local drive. Maintain the relative directory structure of the directories.
  2. If you are developing a COM application and plan to use the JiGlue COM Bridge to instantiate COM objects (allows you to make Win32 calls that are equivalent to native Java statements), configure the JiGlue COM Bridge on your development system; for information, see Configuring the JiGlue COM Bridge.
  3. Change the file attributes for all of the files in the newly created directory structure from Read-only to Read/Write.
  4. If you have not already done so, install and configure the Sun Microsystems JDK on your development system, being sure to configure the CLASSPATH to specify the pw.jar location (typically either by creating a batch file to include pw.jar in the CLASSPATH, or if you are developing using an IDE — such as IntelliJ IDEA, JBuilder, etc. — by adding pw.jar to your global or project setting). For details on installation, configuration, and which JDK to use, see Configuring the Java Runtime Environment (JRE). If you are developing on multiple Process Engine servers and/or if you are implementing the (optional) Process Analyzer on another machine, be sure that you have installed and configured the JRE and copied the pw.jar file on each of these machines.
  5. Verify that your local drive now contains the following files with Read/Write properties in your ...\Developer Files directory:
    pw.jar
    vwpanel.jar
    jiglue.dll (needed in order to use the JiGlue COM Bridge for a COM application)
    jiglue.tlb (needed in order to use the JiGlue COM Bridge for RAD development)
    The contents of the ...\Developer Files\Samples directory

    Note If you are not on a FileNet Web Services server, in order for JiGlue to work correctly, the pw.jar file and the JiGlue library files must be in the same directory. The JiGlue jiglue.dll and jiglue.tlb library files can also be found in the ...\FileNet\IDM\PWBin directory.

  6. Verify that the <drive>...\Program Files\FileNet\IDM\Web\IDMWS\Redist directory on your FileNet Web Services server (or your development system, if the same) contains the subdirectories containing the Java and HTML (ASP) samples and associated files, as shown in the Process Development Environment Contents table below (these files were installed during FileNet Web Services installation on the web server).

Process Development Environment Contents

If you followed the default Process Engine installation procedure, have run the PJAC installer, and followed the installation procedure above, the Process Development Environment files should be located on your FileNet Web Services server (or your development system, if the same) in a directory structure contained in the <drive>...\Program Files\FileNet\IDM\Web\IDMWS\Redist directory and on your development system in a directory structure contained in the <drive>...\Developer Files directory, respectively.

As shown in the table below, included with the Process Development Environment are a set of default Java and HTML Step Processor applet and application files. These applets and applications provide a model of how to use the Process Java APIs, FileNet Web Services, and the JiGlue COM Bridge (HTML only) and are available for customization.

The default Process Development Environment directory structure for FileNet Web Services consists of the following directories and files:

Directory Description of Contents

On the PJAC and Toolkit Installation CD under the ...\FileNet\IDM\Web\IDMWS\Developer Files directory:

\Developer Files

Contains the following development files:

pw.jar: Contains the Process Engine Java API runtime classes, plus client classes, Task Manager classes, third party classes [e.g., for Xerces], etc. The pw.jar file should reside on the Process Engine server (if there are multiple Process Engines, pw.jar should be on each Process Engine), each client, and if used, on the Process Analyzer.

vwpanel.jar: Includes the information and Java Step Processor UI Toolkit classes which may be used for Rapid Application Development (RAD) drag-and-drop functionality to customize the user interface in a Java Integrated Development Environment (IDE), such as IDEA, JBuilder, etc. For information on how to use these Toolkit packages and classes, see the Java Step Processor UI Toolkit API JavaDoc documentation.

jiglue.dll: The dynamic link library used to enable Java - COM communication (also called the JiGlue COM Bridge).

jiglue.tlb: The JiGlue type library.

\Developer Files
\Samples

Includes the following subdirectories:

\API: Contains sample Process Java API files that may be used to create, launch, complete, display, save log information, etc. for a workflow and that illustrate how to use the Process Java APIs.

\vwpanel: Contains the sample Java Step Processor application files (in the ...\vwpanel\samplestep subdirectory) and Java Launch Step Processor sample files (in the ...\vwpanel\samplelaunch subdirectory) along with the image files (.gif files) needed for the default user interface.

\Utils: Contains a Java class that allows you to view or remove entries from the Java (Remote Method Invocation) RMI registry.

On the FileNet Web Services server under the <drive>...\Program Files\FileNet\IDM\Web\IDMWS\Redist directory:

 

\Redist

Default HTML (ASP) Step Processors:

Includes the following ...\Redist subdirectories containing the HTML (ASP-hosted) Step Processor and Launch Step Processor samples:

\WF_Step\html: Contains sample HTML (ASP) Step Processor files.

\WF_Launcher\html: Contains sample HTML (ASP) Launch Step Processor files.

\WF_Html_Toolkit: Contains shared files for the sample HTML (ASP) Step and Launch Step Processors. Subdirectories include:

  • \Core: Includes the essential .ASP, .INC (server-side includes), and .JS (Javascript script) files used in the sample HTML Step Processor and Launch Step Processor. The files in this subdirectory are used for defining objects, initializing processor state, and enabling workflow processing.
  • \Images: Includes images (.gif files) used in the sample HTML Step Processor and Launch Step Processor.
  • \UI: Includes .ASP files used to format the sample HTML Step Processor and Launch Step Processor user interface and define the sample HTML Step and Launch Step Processor user interface behavior.
  • \Utility: Includes client-side (.JS) and server-side (.ASP) files for calling utility functions for quick sorting, property type checking, and XML streaming.
ASP container files for the sample Java Step Processor applets:

Includes the following ...\Redist subdirectories containing the ASP container files for the sample Java Step Processor and Launch Step Processor applets:

\WF_Step\tabbed\step_main.asp: ASP container file for the sample Java Step Processor applet.

\WF_Launcher\tabbed\launcher_main.asp: ASP container file for the sample Java Launch Step Processor applet.