Deploying Applications for FileNet Workplace

In order to run a Java application or applet for FileNet Workplace, you must deploy it on your Application Engine server.

Caution If you upgrade to a new FileNet Workplace or Process Engine version, you must redeploy all existing custom applications and applets. Existing applications/applets, including all Java Step Processors and Launch Step Processors, should be recompiled and then redeployed using the procedure below. If you get compiling errors, correct your custom Step Processor applications/applets, for example, by comparing them to the new version's sample Java Processors (see Java Step Processor Sample Files and Java Launch Step Processor Sample Files).

To deploy a Java application/applet, such as a custom Java Step or Launch Step Processor, on the Application Engine server, use the following procedure (for details, click on the step):

Note This procedure assumes that you have already installed the Process Development Environment (for information, see Installing the Process Development Environment and click on the appropriate link according to which FileNet web application you are using), have installed and configured the Java Runtime Environment (JRE), have compiled your application files, and have created and signed (with a Netscape Object Signing Certificate) a JAR file for your application/applet.

  1. Copy the new JAR file to the Application Engine server.
  2. Create a JSP event page.
  3. Create a corresponding JSP view (User Interface) page.
  4. Configure the server for the web application.
  5. Add the new Step Processor application/applet to the workflow.

Copy the JAR file to the Application Engine Server

If you want to add a Java application/applet JAR file, e.g., for a custom Step or Launch Step Processor, once and use it for a number of different Step Processors, etc., perform the following steps:

  1. Copy the JAR file containing your custom Java application/applet.
  2. On the Application Engine server, navigate to the ...\Workplace\download directory.
  3. Place your JAR file in the ...\download directory.

Note All Process applications, including out-of-the-box, sample, and custom Step Processor applications, must be registered using the Configuration Console. For information, see Process Engine Administration Help.

Create a JSP Event Page

This procedure explains how to create a JSP event page as part of the process of adding a Java application/applet, such as a customized Step Processor, to the Application Engine server, which in turn makes it available to Process Engine. Creating a JSP event page for a Launch Step Processor is a similar process, although the locations and file names are different (these differences are indicated in the procedure below).

Note This procedure assumes familiarity with the Application Engine Workplace framework, which is based on the Model-View-Controller (MVC) approach in a J2EE platform environment. Refer to the Web Application Toolkit Guide for additional information on the JSP event and view (UI) page structures and interaction.

  1. Navigate to the ...\Workplace\eprocess\stepprocs\java directory on your Application Engine server.

    Note For Launch Step Processors, go to the ...\Workplace\eprocess\launchers\java directory.

  2. Create a new directory under the appropriate \java directory. (For example, the new directory structure under the existing structure might be ...\Workplace\eprocess\stepprocs\java\custom1. The next might be ...\java\custom2 and so on.)
  3. Copy the ...Workplace\eprocess\stepprocs\java\ootb\WcmStepProc.jsp file. Place the copy into the new directory.

    Note For Launch Step Processors, copy the ...\Workplace\eprocess\launchers\java\ootb\WcmLaunchSP.jsp file.

  4. Rename the file to reflect the function of the new processor. (For example, myCustomStepProcessor.jsp.)
  5. Change the attribute of the renamed file from read-only to read/write.
  6. Open the renamed file and find the following statement:

    <%String jarVersionValues = com.filenet.wcm.toolkit.util.WcmBuildStamp.jarVersion + ", " +
    filenet.vw.toolkit.utils.VWBuildStamp.jarVersion;%>

  7. Change it to specify your jar file version. For example:

    <%String jarVersionValues = com.filenet.wcm.toolkit.util.WcmBuildStamp.jarVersion + ", " +
    filenet.vw.toolkit.utils.VWBuildStamp.jarVersion + ", " + "2.0.0.0";%>

  8. Add your JAR file version information.
  9. You then modify a number of statements in the <%---UI Beans---%> section, as indicated in this step and the steps which follow. First find the following statement in the <%---UI Beans---%> section:
  10. <jsp:setProperty name="plugInModule" property="appletClassName" value="filenet.vw.apps.steps.tabbed.VWTabbedStepApplet" />

    Modify this line to reflect the name of the package you used when compiling your sample Step Processor. For example, if your JAR file was created in the \newStep directory and the applet is named newStepApplet, your statement would be similar to:

    <jsp:setProperty name="plugInModule" property="appletClassName" value="newstep.newStepApplet" />

  11. On the next line, you should see the following statement:

    <jsp:setProperty name="plugInModule" property="jarArchiveValues" value="wcm.jar, eProcess.jar" />

    Modify this statement to add the name and location of the new JAR file. For example, if your custom jar file is named newSteps.jar, your statement would be:

    <jsp:setProperty name="plugInModule" property="jarArchiveValues" value="wcm.jar, eProcess.jar, newSteps.jar" />

  12. Note 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. Alternatively, you can specify multiple JAR files using a comma (",") delimiter. Not all browsers support multiple JAR files. Also note that the JAR file must be signed (for details, see Signing a Jar File).

  13. Save and close the file.

Create a View Page

Create a JSP View page that corresponds to the JSP Event page you just created (see above), as follows:

  1. Navigate to the ...\Workplace\UI-INF\jsp\ui\eprocess\stepprocs\java\ directory on your Application Engine server.

Note For Launch Step Processors, navigate to the ...Workplace\UI-INF\jsp\ui\eprocess\launchers\java directory.)

  1. Create a new directory under the appropriate ...\java directory. Give it the same directory name as the directory containing the JSP event page.
  2. Copy the ...\Workplace\UI-INF\jsp\ui\\eprocess\stepprocs\java\ootb\WcmStepProc.jsp file. Put the copy in the newly created directory.

Note For Launch Step Processors, copy the ...\Workplace\UI-INF\jsp\ui\eprocess\launchers\java\ootb\WcmLaunchSP.jsp file.

  1. Rename the file to name the exact name, including the exact same case, of the JSP event page file name. For example, if you named the event page myCustomStepProcessor.jsp, you must name this file myCustomStepProcessor.jsp as well.
  2. Change the attribute of the renamed file from read-only to read/write.
  3. Open the renamed file, and locate the following statement:

    WcmString topic = new WcmString("server.WcmStepProc_jsp.topic", "Java Step Processor");

  4. Change the display name for the custom Step Processor by changing the text stored in the topic variable. For example, if you want to change the name to My Custom Step Processor, make the statement match the following sample.

    WcmString topic = new WcmString("server.myCustomStepProcessor_jsp.topic", "My Custom Step Processor");

  5. Save the renamed file.

At this point, you are ready to configure the server for the web application and add the new or updated Step Processor to the workflow.