Skip navigation FileNet logo
  Open Client Developer's Guide
  Search  |  Index  |  Glossary   |  
Open menu Overview
Open menu Open Client Architecture
Close menu Developing for Process
  Open menu Process Overview
  Open menu Preparing for Development
  Open menu HTML Step and Launch Processors
  Java Processors
  Component-Integrator Work Performer
  Close menu Deploying Process Applications
    HTML Step Processors
    Close menu Java Step Processors
      Compiling Java Files
      Creating the JAR File
      Signing the JAR File
      Deploying the Java Application/Applet
      Configuring the Server for the Web Application
    Adding Step Processors to Workflow
Open menu Error and Exception Handling
Open menu Customizing the Framework
Globalization / Localization
Open menu General Information
   

Adding an Open Client HTML or Java Processor to the Workflow

Note: Before you add the processor to the workflow, the workflow must have already been created using the FileNet Process Designer. For details see the Help documentation, Help for Process Designer.

Once you have either created a new HTML or Java Step Processor or Launch Step Processor or extended an existing out-of-the-box Processor, you must add your custom Processor to the workflow for the end user to use it. You add an Open Client Processor to the workflow on a client system that can connect to the Web server on which you deployed the Process Open Client.

Caution: If you upgrade to a new Process Engine, Open Client, or PJAC for Open Client version, you must redeploy all existing custom Step and Launch Step Processors (for additional information, see Deploying an Open Client Java Processor).

Note: If you add the new HTML Step Processor or Launch Step Processor while Designer is running, the new Processor will not be available until the next time you start Designer. Stop Designer before adding a custom Processor to the Workflow. (Refer to Configure Step Processors under the Management tab of the Configuration Console Help for additional information on adding Step Processors or Launch Step Processors to a workflow.)

The steps for adding a custom Step Processor or Launch Step Processor are essentially similar for both HTML and Java Processors. The primary difference is that for HTML Step Processors and Launch Step Processors applets hosted in ASPX, you need not specify the package in the Class Name field (see below).

Note: Perform the following steps on a client system that can connect to the Process Engine server on which you installed the JAR file containing the Step Processor files. This procedure assumes you have already set the Web application properties for either this isolated region or VWServices (see Configuring the Server for the Web Application).

Adding a Step or Launch Step Processor application/applet to the workflow consists of two basic steps:

  1. Registering the Step Processor
  2. Adding the Processor to the Workflow

Each of these steps is described below.

Registering the Step Processor

Use the Process Configuration Console to register a custom step or launch Step Processor as follows:

  1. Connect to your Process Engine server, and select Process on the FileNet Open Client page to open the Configuration Console
  2. Click on the Tools tab and select Process Configuration Console; for information, see Help for Process Configuration Console on the Process Documentation for FileNet Image Manager CD.
  3. Log on to the proper region. Locate and select the router associated with the region.
  4. Highlight and right-click the router name.
  5. Select Properties. From the Isolated Region Properties dialog box, select the Step Processor Info tab.
  6. Click add and enter the following step definition information:
    • Type: Enter either Step or Launch.
    • Name: Enter the name you want to display in the Designer.
    • Language: Enter HTML for all Step Processors that are HTML. Enter Java only when specifying a Java or JSP application.
    • Location: Enter the location and name of the file for the modified JSP or HTML file.
    • Width: Enter the width in pixels.
    • Height: Enter the height in pixels.
    • Class Name: Enter the class name only if you specified Java earlier. The class name is the package name containing the modified .JAR file. For example, if the .JAR was created in the \newStep directory and the class is called newStepApplet, the package name is newstep.newStepApplet.
  7. Click OK, and commit the changes.
  8. Close Configuration Console.
  9. Open Designer. The newly added Step Processor or Launch Step Processor should now display as one of the available Step Processor options.

Adding the Processor to the Workflow

Use the Process Designer to add a custom Processor to the workflow as follows:

  1. Open the Process Designer by selecting Process on the FileNet Open Client page, then on the Tools tab,select Process Designer; for information, see Help for Process Designer on the Process Documentation for FileNet Image Manager CD.
  2. Select the step on the map for which this Step Processor is to be added.
  3. Click the General tab in the Properties pane.
  4. Under Step Processor, select the custom Step Processor as the Processor for this step.

For additional information, see Help for Process Designer > Steps > General steps > General properties.