Installing the Process Development Environment - FileNet Open Client

The PJAC and Toolkit Installation CD includes a "Process Development Environment" for developers. The Process Development Environment for the FileNet Open Client 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, toolkit, and other files.

Subtopics include:

Process Development Environment Overview

The Process Development Environment for FileNet Open Client 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 Image Manager, FileNet Open Client, and the Process Engine and that you have run the PJAC installer and have installed PJAC for FileNet Open Client (for information, see the PJAC Installation Guide on the Process Documentation for FileNet Image Manager CD).

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. Locate the ...\Developer Files folder.

    Note The locations listed in this topic may vary from the actual location on the Installation CD. For the latest information, see the Process Installation Guide for FileNet Image Manager or Release Notes or Readme documentation on the 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.

  3. Copy the ...\Developer Files folder, and all its subdirectories, to your local drive. Maintain the relative directory structure of the directories.
  4. Configure the JiGlue COM Bridge on your development system (the Process Development Environment for FileNet Open Client requires the JiGlue COM Bridge to instantiate COM objects; i.e., allows you to make Win32 calls under ASP.NET that are equivalent to native Java statements). For information, see Configuring the JiGlue COM Bridge.
  5. Change the file attributes for all of the files in the newly created directory structure from Read-only to Read/Write.
  6. 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 (e.g., by creating a batch file to include pw.jar in the CLASSPATH). 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.
  7. 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 an Open Client web 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.

  8. Verify that the <drive>...\Program Files\FileNet\IDM\Web\FNOpenClient\eprocess directory on your FileNet Open Client server (or your development system, if the same) contains the subdirectories containing the Java and ASPX samples and associated files, as shown in the Process Development Environment Contents table below (these files were installed during FileNet Open Client installation).

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 web 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.

In addition, during FileNet Open Client installation, a Process-specific directory structure (...\eprocess) is created as a subdirectory of the overall Open Client directory. The Open Client directory name and location is user-selectable (the default is the ...\Program Files\FileNet\IDM\Web\FNOpenClient directory). This directory is extended during FileNet Open Client Toolkit installation to provide a server-side web footprint for FileNet Open Client (the ...\FNOpenClient directory with its ...\FNOpenClient\eprocess subdirectory — or its user-selectable equivalent — is not downloaded to the client).

Note The directories and contents listed in this topic may vary from the latest version downloaded from the FileNet FTP site or on the PJAC and Toolkit Installation CD and the FileNet Open Client Installation CD. For the latest information, see the Process Installation Guide for FileNet Image Manager and the FileNet Open Client Developer's Guide documentation or Release Notes or Readme.

Included with the Process Development Environment are a set of out-of-the-box Java and HTML Step Processor applet and application files (see table below). These applets and applications provide a model of how to use the Process Java APIs, FileNet Open Client, and the JiGlue COM Bridge and are available for customization. Also included are a number of files for high level Process application out-of-the-box ASPX pages, their associated .aspx.vb code-behind files, and an Include file for the JavaScripts to open the popup window. For additional information on these and other Open Client ASPX, ASCX, JSP, etc. files used to support Process applications, see the FileNet Open Client Developer's Guide Help documentation. For information on the Process Java Applets Connectivity (PJAC) files used to provide Process Engine connectivity for Open Client, see PJAC Files for Open Client.

The default Process Development Environment for FileNet Open Client consists of the following directories and files:

Directory Description of Contents
On the PJAC and Toolkit Installation CD in the ...\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 Help for Process Developers and also the Java Step Processor UI Toolkit API JavaDoc Help, both on the Process Documentation for FileNet Image Manager CD.

jiglue.dll: The dynamic link library used to enable Java - COM communication (also called the JiGlue COM Bridge); also may be found in the ...\FileNet\IDM\PWBin directory.

jiglue.tlb: The JiGlue type library; also may be found in the ...\FileNet\IDM\PWBin directory.

\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.

FileNet Open Client web footprint for Process under the ...\FileNet\IDM\Web\FNOpenClient\ — or its user-selectable equivalent — directory:

\eprocess

Contains the following Process high-level ASPX pages and their associated .aspx.vb code-behind files (not listed), plus an Include file (FnPopupFunctions.inc); these files are provided by the FileNet Open Client web application:

FnBrowseOtherPage.aspx: Page supports the selection of "other" types of attachments, such as a UNC or URL.

FnPopupFunctions.inc: Include file for JavaScripts to open the popup window.

FnWFLauncher.aspx: Workflow Definition Launcher top-level page.

FnWFProperty.aspx: Process Workflow Property page.

\eprocess\DataProvider

Contains a set of VB.NET Data Providers used to provide Process-specific functionality to the web application ASPX pages, as follows:

FneprocessBaseDP: The base Process Data Provider abstract class (inherits FnBase). This class also includes Open Client wrapper classes for corresponding Process Data Provider classes to provide Process-related functionality, such as setting an FneprocessSession object to a VWSession object, converting an Process VWQueueElement to an FnQueueElement, and so on.

FneprocessLauncherDP: Process public class Data Provider used to provide Process Launcher functionality (inherits FneprocessBaseDP).

FneprocessPWMDP: Process public class Data Provider used to provide Process Personal Work Manager functionality (inherits FneprocessBase).

FneprocessSessionDP: Process public class Data Provider used to handle Process authentication, logon and logoff (inherits FneprocessBaseDP).

FneprocessStepProcDP: Process public class Data Provider used to provide Process Step Processor and Launch Step Processor functionality (inherits FneprocessBaseDP).

FneprocessUserPrefsDP: Process public class Data Provider used to provide base Process user preferences support and integration (inherits FnBase)

\XML subdirectory: Contains XML-related VB.NET Data Providers and their associated .xsd files.

\eprocess\download

Contains PJAC-supplied files to be downloaded to the client when the applet starts for the first time. These are:
  • j2re1_x_x-win-i.exe — Java 2 Runtime Environment executable (required); for example: j2re1_4_0-win-i.exe.
  • pw.jar — This JAR file contains the Java API runtime classes and images used by FileNet Open Client Process applets.

\eprocess\Images

Contains the .GIF-formatted icon graphics used by the FileNet Open Client Process out-of-the-box HTML Processors, including those used for email notifications.

\eprocess\JS

Contains the JavaScript file (FnWindowHelper.js) used to open browser popup windows.

\eprocess\Launchers

Contains the subdirectories that contain the top-level ASPX files for the out-of-the-box HTML and Java Launch Step Processors, as follows:

  • \HTML\OOTB: Contains the top-level ASPX page (FnLaunchProcessor.aspx) and its associated .aspx.vb code-behind file for the out-of-the-box HTML Launch Step Processor.
  • \Java\OOTB: Contains the top-level ASPX page (FnLSPAppletPage.aspx) and its associated .aspx.vb code-behind file for the out-of-the-box Java Launch Step Processor.

\eprocess\Login

Contains the Process session login-related and token-related ASPX pages and their associated .aspx.vb code-behind files.

\eprocess\Popups

Contains the Process general popup window ASPX page (FnAppletPage.aspx) and its associated .aspx.vb code-behind file.
\eprocess\PWM Contains Personal Work Manager ASPX pages (and associated aspx.vb code-behind files) to provide notifications on a user's work items by displaying a list of user and work queues, querying and displaying queue contents, etc. for the out-of-the-box Personal Work Manager.

\eprocess\SP_Toolkit

Contains the utility files used for handling step elements for the out-of-the-box HTML Step and Launch Step Processors . This subdirectory contains ASPX pages (and their associated .aspx.vb code-behind files) used for editing arrays, attachments, and so on. This directory also contains a \Utility subdirectory, which contains the utility.js JavaScript file used with these pages.

\eprocess\StepProcs

Contains the subdirectories that contain the top-level ASPX files for the out-of-the-box HTML and Java Step Processors, as follows:

  • \HTML\OOTB: Contains the top-level ASPX page (FnStepProcessor.aspx) and its associated .aspx.vb code-behind file for the out-of-the-box HTML Step Processor.
  • \Java\OOTB: Contains the top-level ASPX page (FnSPAppletPage.aspx) and its associated .aspx.vb code-behind file for the out-of-the-box Java Step Processor.

\eprocess\UserControl

Contains the Process-specific Open Client VB.NET-based User control .ascx files and their associated .ascx.vb code-behind files that, in conjunction with Control Factory controls and the .NET server controls (and associated .NET classes), provide the building blocks of the presentation layer (the "View" part of the MVC model) that provides the user interface.

Open Client User controls (the file names are fairly self-explanatory) include controls for attachments, plugins, a base User control class (FnStepProcBaseUC.ascx), data fields, general info, milestones, reassignments, workgroups, and so on.