Configure custom step processors

Use Process Configuration Console to configure and add new step processors. A step processor is used to complete a step in a workflow. A launch processor is designed specifically to launch a workflow. FileNet provides two sample HTML step processors and two launch processors that are configured during installation and available to the workflow author for use in a workflow definition. The default step processor and launch processor display the parameters on the initial page; the other step processor and launch processor display parameters on separate pages.

To make a custom step processor available for use in a workflow definition, you must configure the processor in the Step Processor Info tab in Process Configuration Console. Once configured, the step processors display in the list of available step processors or launch processors in Process Designer for the workflow author to assign to steps or launch steps.

To configure a user-defined processor

  1. Select the isolated region you want to modify and click Properties on the toolbar.
  2. Select the Step Processor Info tab.
  3. To add a new step processor, click Add. Enter the following parameters and descriptions as appropriate for your processor.
     
    Column Parameter Description

    Type

    Specify the entry as a step processor or launch processor. In addition, you can specify one of each type as the default processor for the step or launch step. Process Designer automatically selects the appropriate default step processor when a new step is created. In addition, Process Engine uses the default step or launch processor at runtime if the processor defined in the workflow no longer exists.

    Name

    Enter a name that identifies the step processor or launch processor in the list of available step or launch processors in Process Designer. We suggest that you use a name that describes both the function and language (HTML or Java™ technology) of the processor. Each step and launch processor within the isolated region must have a unique name.

    NOTE  Once you commit this change, you cannot change the name of the step processor.

    Language

    Specify the language used by the developer to create the processor.

    Location

    Specify the location on the Application Engine where the processor web pages reside. Double-click Location to open the Step Processor Info Location dialog box.

    Height

    An integer value that specifies the height, in pixels, of the processor display window. You can experiment with this to find the optimal setting for your processor.

    Width

    An integer value that specifies the width, in pixels, of the processor display window. You can to experiment with this to find the optimal setting for your processor.

    Class name

    The package name of the Java application associated with a Java-based processor. This value does not apply to HTML-based processors.

  4. To delete a processor, select the row of the processor you want to delete and click Delete.

    NOTE  You can delete a newly defined step processor before you commit it to the server. Once you commit a step processor, you cannot delete it, although you can modify the definition. In addition, you cannot delete step processors that are created automatically when the region is initialized.

  5. Click OK.
  6. Click Commit on the toolbar to apply this change to your isolated region. You can commit the changes immediately, or you can wait until you have finished all your changes. See NOTES in the side bar.

Sample Java step processor and launch processor for FileNet P8 Platform

The installation process for FileNet P8 Platform installs a FileNet-provided HTML step processor and HTML launch processor. FileNet also provides sample Java step processor and launch processor that must be configured to make them available to the workflow author. See below for instructions for configuring the FileNet-provided Java step processor and launch processor. You can use these HTML and Java samples as is; optionally, a developer can modify these FileNet-supplied step processors or create new ones. See Help for Process Development for further information.

To configure the FileNet-provided Java step processor, use the following entries:

  • Type: Step
  • Name: JavaStepProc (FileNet)    [or any name you like]
  • Language: Java
  • Location: java/ootb/WcmStepProc.jsp
  • Width: 800
  • Height: 600
  • Class: filenet.vw.apps.steps.tabbed.VWTabbedStepApplication

To configure the FileNet-provided Java launch processor, use the following entries:

  • Type: Launch
  • Name: JavaLaunchProc (FileNet)   [or any name you like]
  • Language: Java
  • Location: java/ootb/WcmLaunchSP.jsp
  • Width: 800
  • Height: 600
  • Class: filenet.vw.apps.launchers.tabbed.VWTabbedLaunchStepApplication

NOTE  The Java launch processor and step processor are installed and configured automatically with Process Java Applets and Connectivity (PJAC). The files are in the following locations:

Java step processor  

   FileNet Web Services

   FileNet Open Client

 

tabbed/step_main.asp

java/ootb/FnSPAppletPage.aspx

Java launch processor  

   FileNet Web Services

   FileNet Open Client

tabbed/launcher_main.asp

java/ootb/FnLSPSppletPage.aspx

NOTES 

Modifications to processor entries take effect as soon as you commit the changes. Workflows already in progress that use the modified processors will use the revised settings for the next applicable step.

If you modify the Step Processor Info while Process Designer is running, the new information is not available until the next time you start Process Designer.