Using the Open Client Out-Of-The-Box ASP.NET (HTML) Applications

FileNet Open Client provides a complete fully-functional set of "out-of-the-box" (OOTB) ASP.NET HTML applications, including a Launcher (launches the workflow definition), a Personal Work Manager (PWM), a Step Processor, and a Launch Step Processor. These Processors are hosted by .NET Web Forms which are provided to the client in response to an HTTP request. The .NET Web Forms comprise the ASPX pages and their associated VB.NET-based code-behind files, which are available for customization.

Topics on using the OOTB HTML Processors include:

Process Open Client OOTB ASP.NET HTML Processors

The following OOTB HTML Processors and their associated code-behind files are available for customization (these are all located in the Process directory or one of its subdirectories; the default location is ...\Program Files\FileNet\IDM\Web\FnOpenClient\eProcess):

OOTB HTML File

Default Directory Location

Description

FneProcessMain.aspx ...\FnOpenClient Top-level ASPX page and its associated .aspx.vb code-behind file for the out-of-the-box HTML Personal Work Manager (PWM). This is the main ASPX page for the Process Engine.
FnWFLauncher.aspx ...\FnOpenClient Top-level ASPX page and its associated .aspx.vb code-behind file for the out-of-the-box Workflow Definition Launcher (launches a workflow definition).

FnStepProcessor.aspx

..\FnOpenClient\eProcess\StepProcs\ HTML\OOTB Top-level ASPX page and its associated .aspx.vb code-behind file for the out-of-the-box HTML Step Processor.

FnLaunchProcessor.aspx

..\FnOpenClient\eProcess\Launchers\ HTML\OOTB Top-level ASPX page and its associated .aspx.vb code-behind file for the out-of-the-box HTML Launch Step Processor.

 

Customizing the OOTB HTML Processors Basic Procedure

When customizing the OOTB HTML Processors, use the following basic procedure:

  1. Copy the existing OOTB top-level ASPX page and its code-behind .aspx.vb file to an appropriate directory on the FileNet P8 Image Manager web server. You may create this directory within the FileNet Open Client Web Footprint directory structure (for example, the ...\Program Files\FileNet\IDM\Web\FnOpenClient\applications directory or its user-selectable equivalent directory) or whereever it is appropriate.
  2. Rename the copied file (most developers prefer to use a name associated with the function for that step; for example: LoanOfficerApproval.aspx and LoanOfficerApproval.aspx.vb).
  3. Open the ASPX file in your IDE or text editor. If you are not using Visual Studio, you will need to change the file attribute from Read-only to Read/Write.
  4. Customize the ASPX file, its code-behind .aspx.vb file, User Controls, and if needed, the FneProcessSessionDP Data Provider according to your business requirements. Customization can range from relatively simple changes that modify the "look and feel" of the OOTB HTML Step Processor to more complex changes that modify the layout and controls for specific business logic requirements, to even more extensive changes involving content integration, accessing different data sources, modifying access (for example, by hiding controls), making authentication changes, and so on.

    Use the Process-specific Open Client VB.NET-based User control .ascx files and their associated .ascx.vb code-behind files to customize the Processor's user interface. You may use these controls in conjunction with Control Factory controls and the .NET server controls (and associated .NET classes) to provide the presentation layer (the "View" part of the MVC model) that provides the user interface. Open Client User controls (the file names are fairly self-explanatory) include controls for attachments, plugins, a base User control class (FnStepProcBaseUC.ascx), data fields, general info, milestones, reassignments, workgroups, and so on.

    For details on customizing the OOTB HTML Step Processor, see Developing a Custom HTML Step Processor. For details on customizing an HTML Launch Step Processor, see Developing a Custom HTML Launch Step Processor. For general guidelines on creating/modifying ASPX pages, see Developing ASPX Pages for Open Client, elsewhere in the Open Client Developer's Guide.

  5. Once you have completed the ASPX page, its associated code-behind file, any User Controls you have used or modified, etc., you must deploy your Processor on the web server. For details, see Developing a Custom HTML Step Processor: Basic Customization and Deployment Procedure.
  6. Once you have deployed your application, you will need to add the new Open Client Step Processor, or Launch Step Processor, etc. to the workflow. For details, see Adding an Open Client HTML or Java Processor to the Workflow.