Deploying an Open Client Java Processor
Whether you use the out-of-the-box (OOTB) applets or you are building a customized
Java Step Processor or Launch Step Processor, you will need to deploy the Processor
on the Open Client web server.
Caution If you upgrade to a new FileNet
Open Client Web Services version, you must redeploy all existing custom Step
and Launch Step Processors using the procedure shown here.
To deploy an Open Client Java Step or Launch Step Processor, use the following
procedure:
Note This procedure assumes you have already completed the following
steps.
- You have installed FileNet Open Client on your
Open Client web server.
- You have installed and configured the Sun Microsystems Java SDK 1.3.1 to
use the appropriate FileNet Web Services class library files (be sure you have installed
JDK1.3.1 in its default directory to avoid JiGlue problems and
that you have included both JDK1.3.1 and the FileNet Open Client pw.jar
file in your CLASSPATH).
- You have either modified the OOTB Java Step and Launch Step Processors,
created your own custom Java Processors, or are using the OOTB FileNet Open
Client Java Processors as they are.
The following procedure provides the basic steps to deploy a Java Processor
applet. For details, click on the link for that step in the procedure.
- Compile the Java Step or Launch Step Processor
files.
- Create a JAR file to contain the compiled
Java files. If you are using the existing out-of-the-box Java Step Processor
and Launch Step Processor without any modifications, you can use the existing
pw.jar file (that comes with the Open Client installation) and can
skip this step.
- Sign the JAR file.
- Deploy the JAR file on the FileNet Web Services server.
- Create the workflow.
- Add the Open Client Processor
to the workflow.
Compile the Java Step
or Launch Step Processor Files
Compile the unmodified sample processors by performing the following steps:
- Navigate to the local directory that contains the development files. If
you kept the directory structure the same as the structure on the Web WorkFlo
and Toolkit CD, the <drive>...\Developer Files\vwpanel directory
on your development system will contain the correct directories and files.
- Select the \samplestep directory or the \samplelaunch directory,
depending on whether you are compiling a Java Step Processor or Launch Step
Processor, respectively.
- Select all files and subdirectories in the selected directory. Change the
file attributes from Read-only to Read/Write.
- Open a command prompt, and change directory to the directory containing
the Java Step Processor sample files (for example, \samplestep).
- Compile the Step Processor applet by entering a command similar to the following,
where VWSampleStepApplet.java is the uncompiled sample Java file:
C:\jdk1.3.1\bin\javac -classpath .;C:\Develo~1;%CLASSPATH% VWSampleStepApplet.java
You must either specify the location of the package as part of
the compiler command, as shown here, or alternatively, add the location of the
Java Step Processor files directory to your CLASSPATH.
Similarly, you can compile a Launch Step Processor by entering
a command similar to the following (from the directory containing the uncompiled
sample Launch Step Processor Java file, VWSampleLaunchApplet.java):
C:\jdk1.3.1\bin\javac -classpath .;C:\Develo~1;%CLASSPATH% VWSampleLaunchApplet.java
Creating a JAR File
Each time you customize, compile, or recompile the Java Processors, or create
your own customized Java Processors from scratch, you must create a Java ARchive
(JAR) file to contain the compiled classes. (Refer to the Sun Microsystems JDK
documentation for information on using the Java ARchive tool.)
This procedure assumes you have already customized and compiled your Java Processors
without compiler errors.
To create a JAR file, use the following procedure:
Note You must sign the JAR file (the
Netscape Object Signing Certificate is recommended).
- Open a command prompt, and change to the directory containing your compiled
Step Processor and Launch Step Processor Java files.
- Create a .JAR file that includes the compiled Java files by entering a command
similar to the following (for example, creating the JAR file mynewjar.jar):
C:\jdk1.3.1\bin\jar.exe -cvf mynewjar.jar *.class resources\*.class
images\*.class images\*.gif
In the same window you entered the command line, you should see
progress messages similar to the following:
added manifest
adding: FnApplet.class(in = 2617) (out= 1297)(deflated 50%)
adding: VWSampleStepPanel.class(in = 4222) (out= 2053)(deflated 51%)
adding: resources/VWResource.class(in = 437) (out= 299)(deflated 31%)
adding: images/VWImageLoader.class(in = 1239) (out= 602)(deflated 51%)
adding: images/icon.gif(in = 1432) (out= 1015)(deflated 29%)
adding: images/step.gif(in = 1592) (out= 1260)(deflated 20%)
- If you intend to use several .JAR files, you should compile all of the .JAR
files into a single file and reference only one file; or you can specify multiple
.JAR files using a comma (",") delimiter. Note however, that
not all browsers support multiple .JAR files. If you plan to use several JAR
files, you should place each .JAR file in the same directory as the ASPX file
that contains the applet (that is, for example ...\FnOpenClient\eProcess\StepProcs\
Java\OOTB\FnSPAppletPage.aspx).
Signing the JAR File
You sign a JAR file for Open Client Java Processors in a comparable manner
to signing JAR files for standard FileNet P8 Image Manager. For details, see the topic,
Signing a JAR File.
Deploying the JAR File
on the Process Server
To deploy a custom Java Step or Launch processor, use the following procedure:
- On your FileNet Web Services server, navigate to the <drive>...\Program Files\FileNet\IDM\Web\IDMWSX
directory.
- Create a new directory under the \eProcess\StepProcs\Java directory
(at the same level as the \OOTB directory).
- Copy the FnSPAppletPage.aspx and the FnSPAppletPage.aspx.vb
files from the ...Program Files\FileNet\IDM\Web\IDMWSX\eProcess\StepProcs\Java\OOTB
subdirectory and put the copy into your newly created directory. For Launch
Step Processors, copy the FnLSPAppletPage.aspx and the FnLSPAppletPage.aspx.vb
files from the ...Program Files\FileNet\IDM\Web\IDMWSX\eProcess\Launchers\Java\OOTB
subdirectory. If you are using custom ASPX pages, use the custom ASPX files
instead.
- Rename the ASPX files (if you are using the default ASPX files). Change
the file attribute from Read-only to Read/Write.
- Open the ASPX Step Processor or Launch Step Processor code-behind file (FnSPAppletPage.aspx.vb
or FnLSPAppletPage.aspx.vb). Locate the AppletClassName object that
matches the following line:
plugInCtrl.AppletClassName = "filenet.vw.apps.steps.tabbed.VWTabbedStepApplet"
- Modify this statement to reference the
correct java applet. For example, if your JAR file was created in the \newStep
directory and the applet class is called FnSPApplet,
your parameter statement would be similar to the following:
plugInCtrl.AppletClassName = "newStep.FnSPApplet"
- Save the renamed file.
- Navigate to the ...\FnOpenClient\eProcess\DownLoad directory.
- Place your custom Java Processor JAR file in the \DownLoad directory.
- On your server, navigate to the FileNet Open Client User Control directory
(the default is the <drive>...\Program Files\FileNet\IDM\Web\FnOpenClient\eProcess\UserControl
directory)
- Open the FnPlugInHelperCC.vb file.
- Find the statement where you declare your JAR file variable for the default
pw.jar file. Add your new JAR file to this statement. For example,
if you created the new JAR file, mynewjar.jar, you would modify this
statement from:
Private m_jarArchiveValue As String = "pw.jar"
To:
Private m_jarArchiveValue As String = "pw.jar,
mynewjar.jar"
(Do not delete pw.jar; just add your JAR file.) Close and save the
file.
Note: You can also,
if you wish, place your JAR file in another directory. However, since the JAR
file path is relative to "\FnOpenClient\eProcess\DownLoad", you must
specify the path. If you do this and use unified logon, the folder must have
Anonymous Access Enabled. Remember, as previously indicated, the JAR file must
be signed (for details, see Sign a Jar File).
Once you have deployed
your Processor, you will need to create the workflow
(if you have not already done so) and then add
the Open Client Processor to the workflow.
Creating the
Workflow
If you have not already done so, using the Process Designer,
create a workflow. For details see the Help documentation, Help for Process
Designer.
Adding the
Open Client Processor to the Workflow
Once you have either created a new HTML or Java Step Processor or Launch Step
Processor, or extended an existing out-of-the-box HTML Processor, you will need
to add your custom Processor to the workflow in order for an end user to be
able to use it. You add an Open Client Processor to the workflow on a client
system that can connect to the Open Client web server on which you deployed
the custom Processor.
For details on adding a Processor to the workflow, see Adding
an Open Client HTML or Java Processor to the Workflow.