Installing Panagon eProcess Toolkit

Panagon eProcess Web WorkFlo and WorkFlo Services ships with an eProcess toolkit for developers. The Panagon eProcess Toolkit consists of the API classes, API samples and utilities, developer guide documentation, and API reference documentation for both the eProcess Java APIs and the Java UI Toolkit APIs.

This topic describes:

Panagon eProcess Toolkit Installation

Install the Toolkit development files by performing the following steps:

  1. Insert the Panagon Web WorkFlo and Toolkit CD into the CD-ROM drive on your system.
  2. On the CD, locate the \Developer Files folder.
  3. Copy the \Developer Files folder, and all the sub-directories, to your local drive. Maintain the relative directory structure of the directories.

Tip While no location requirements exist for the toolkit you should copy the directory structure to the root directory on your development system. Adding the directory to the root speeds up compile time for Java applications, makes registering files easier, and makes finding the appropriate reference documentation much easier.

  1. Change the file attributes for all of the files in the newly created directory structure from Read-only to Read/Write.
  2. If you have not already done so, install the Java Software Development Kit (SDK). For details on which JDK to use for your development environment and how to install and configure it for eProcess, see the Configure the Java SDK topic in this guide.
  3. Configure the Java SDK to use the appropriate files. If you are developing COM-based application, configure the JiGlue COM Bridge on the development system.

Refer to the eProcess Required Tools and Languages topic for more information on the languages, tools, and technologies you must be familiar with before developing applications for Panagon Web WorkFlo and WorkFlo Services.

Panagon eProcess Toolkit Contents

This section describes the Panagon eProcess Toolkit directory structure and contents. If you followed the installation instructions (above) the eProcess Toolkit files should be located on your development system in a directory structure contained in the \Developer Files directory. By default the \Developer Files directory structure contains the following directories and files:

Directory

Contents

\Developer Files

Contains the following development files:

  • pw.jar: contains the eProcess API runtime classes.
  • vwpanel.jar: includes the information and classes necessary to use Rapid Application Development (RAD), drag-and-drop functionality in a Integrated Development Environment (IDE), such as Visual Cafe, JBuilder, Forte, etc.
  • jiglue.dll: dynamic link library used to facilitate COM to Java communication (also called the JiGlue COM Bridge).
  • jiglue.tlb: the JiGlue type library.

Note The eProcess Swing-based runtime control components are included in the pw.jar file. However, if you want to use drag-and-drop RAD programming in your IDE to customize the user interface with these Swing-based eProcess controls, you must add vwpanel.jar to your IDE.

Developer Files\
Documentation

Includes the following directories:

  • \Developer Guide: contains the Panagon eProcess Developer's Guide (this document) HTML and image files. Open \Developer Guide\eprocess_dg_start.htm to begin viewing the document.
  • \JavaDoc\JavaAPI: contains the eProcess API JavaDoc documentation for the eProcess API classes. Open \JavaDoc\JavaAPI\index.html to begin viewing the reference documentation.
  • \JavaDoc\UI_Toolkit_API: contains the UI Toolkit JavaDoc documentation for the User Interface Toolkit Swing-based eProcess controls. Open \JavaDoc\UI_Toolkit_API\index.html to begin viewing the reference documentation.

Tip The UI Toolkit JavaDoc documentation is useful if you plan to create or extend Java Step Processors or Launch Step Processors using the Swing-based eProcess controls that come with the Panagon eProcess Toolkit.

Developer Files\
Samples

Includes the following directories:

  • \API: contains Java sample files that demonstrate how to create, launch, complete, display, and save log information for a workflow.
  • \vwpanel: contains the Java Step Processor samples files (in the \samplestep subdirectory) and Java Launch Step Processor sample files (in the \samplelaunch sub-directory) along with the image files needed to run the compile and run the samples.
  • \Utils: contains a Java class that allows you to view or remove entries from the RMI registry.

Step Processor and Launch Step Processor Toolkit Files

To modify the Step Processors or Launch Step Processors a developer must first know how to use the eProcess APIs. One way of looking at the Step Processors and Launch Step Processors is to view them as specialized applications that make extensive use of the eProcess APIs, existing Panagon Web Services components, and the JiGlue COM Bridge (HTML versions only).

This section separately lists the toolkit files for both ASP (HTML) and Java Processors:

Toolkit files for ASP processors

Some eProcess Toolkit files for ASP development were installed on your Web WorkFlo server under the following directory structures (if the default location was selected during Panagon Web Services and Web WorkFlo installations):

Note The directories in the following table are relative to the <drive>...\Program Files\FileNET\IDM\Web\IDMWS directory structure on the Web WorkFlo server.

ASP files

Location

Step Processor
files:

\Redist\WF_Step\html

Launch Step Processor
files:

\Redist\WF_Launcher\html

Shared
files:

\Redist\WF_Html_Toolkit

These files are used by the Step Processors and Launch Step Processors shipped with Panagon Web WorkFlo. You need not install additional files to see these ASP eProcess Toolkit files operate.

Refer to the HTML Processor Toolkit Overview topic for more information on understanding the default structure of the ASP-based Step Processor and Launch Step Processor files. The HTML processors use the JiGlue COM Bridge and Panagon Web Services Javascript objects. You must understand how to use these development elements to modify the HTML processors successfully.

Toolkit files for Java processors

The Java Step Processor (<drive>...\Developer Files\Samples\vwpanel\samplestep) and Launch Step Processor (<drive>...\Developer Files\Samples\vwpanel\samplelaunch) samples, along with the UI Toolkit JavaDoc documentation (<drive>...\Developer Files\Documentation\\JavaDoc\UI_Toolkit_API), constitute the Java Processor development toolkit.

Additionally, ASP containers for the Java applet versions of the Step Processor and Launch Step Processors are provided, as follows:

Note The directories in the following table are relative to the <drive>...\Program Files\FileNET\IDM\Web\IDMWS directory structure on the Web WorkFlo server.

Applet container files

Location

Step Processor container file:

\Redist\WF_Step\tabbed\step_main.asp

Launch Step Processor container file:

\Redist\WF_Launcher\tabbed\launcher_main.asp