Developing a Custom ASP.NET (HTML) Launch Step Processor

FileNet Open Client provides a fully-functional out-of-the-box (OOTB) ASP.NET HTML Launch Step Processor (...\FnOpenClient\eProcess\Launchers\ HTML\OOTB\FnLaunchProcessor.aspx is the top-level HTML Launch Step Processor ASPX page) that you can use as is, or you can copy, deploy, and customize it according to your business requirements.

Customization can range from relatively simple changes that modify the "look and feel" of the OOTB HTML Launch Step Processor to more complex changes that modify the ASPX page layout and controls for specific business logic requirements, to even more extensive changes involving content integration, modifying access (e.g., by hiding controls), making authentication changes, and so on. You can also, using the Open Client and FileNet Open Client ASPX pages, utilities, Data Providers, User Controls, Factory Controls, plus the .NET Web and Server Controls and classes, create your own customized-from-scratch HTML Launch Step Processor ASPX page and controls.

The following topics describe how to develop a custom HTML Launch Step Processor for Open Client:

HTML Launch Step Processor Page Data Flow

In order to develop a custom HTML Launch Step Processor, it is important to understand the basic HTML Launch Step Processor page data flow. A Process Open Client Launch Step Processor (such as the OOTB FnLaunchProcessor) is invoked by the Personal Workflow Manager (PWM). When an end user in the PWM launches a workflow, the appropriate Launch Step Processor client application for that workflow is launched in a browser popup window.

The following figure illustrates the basic page data flow for the OOTB HTML Launch Step Processor.

As indicated in the figure, when the end user launches a workflow definition, the workflow launcher launches the Launch Step Processor page. The only options an end user can select are to either launch the workflow or to cancel the launch. In either case, the user is redirected back to the Workflow Launcher page.

Types of Customization: Which Controls, Resources, and Files to Use

The following table provides a summary description of the out-of-the-box Process Open Client controls, resources, pages, and other files you will need to modify/use to customize the OOTB Launch Step Processor, according to the type of customization and the example change to be made. For details, click on the link in the table.

Customize

Changes

Files To Use

Description

User Interface Modify the basic "look and feel" of the user interface. ASPX pages, User Process and Open Client Controls, other files as appropriate. Modify the top-level ASPX page, its associated .aspx.vb code-behind file, and other files as needed, for the OOTB HTML Launch Step Processor.
  Change the banner of the OOTB Launch Step Processor.

FnBannerUC.ascx

Modify the FnBannerUC Open Client User Control.

  Change the colors of the OOTB Launch Step Processor.

FnLaunchProcessor.aspx.vb; appropriate User Controls

Modify the OOTB HTML Launch Step Processor ASPX code-behind file and the User control whose color you want to change.
  Change the images in the OOTB Launch Step Processor.

FnLaunchProcessor.aspx.vb; appropriate image files, .gifs, etc.

Modify the OOTB HTML Launch Step Processor ASPX code-behind file and the image files you wish to use/change.
  Modify the page layout or structure of the OOTB Launch Step Processor.

FnLaunchProcessor.aspx; FnLaunchProcessor.aspx.vb; appropriate User Controls

Copy, deploy, and modify the OOTB HTML Launch Step Processor ASPX page and its code-behind file; use the User controls you want to add, change, or delete (see next two items).
  Add new User Controls.

FnLaunchProcessor.aspx; FnLaunchProcessor.aspx.vb; appropriate User Controls

Copy, deploy, and modify the OOTB HTML Launch Step Processor ASPX page and its code-behind file; use the Process, Open Client, Factory, .NET or other controls controls you want to add. This may require customizing business logic in the new FnLaunchProcessor.aspx.vb and other files.
  Hide existing User Controls.

FnLaunchProcessor.aspx; FnLaunchProcessor.aspx.vb

Copy, deploy, and modify the OOTB HTML Launch Step Processor ASPX page and its code-behind file, commenting out or otherwise editing out the existing User controls you do not want.

Customizing the User Interface

For simple customization of the FileNet Open Client OOTB HTML Launch Step Processor user interface, such as changing the banner, changing colors, or images, you can either customize the existing OOTB HTML Launch Step Processor ASPX page (FnLaunchProcessor.aspx), its code-behind file (FnLaunchProcessor.aspx.vb), and the appropriate User Controls according to which items in the Launch Step Processor you wish to modify. For more complex customization of the user interface, you can copy, rename, deploy, and then modify the new ASPX pages, including restructuring and customizing the ASPX page layout.

The following topics provide guidelines on customizing the user interface:

Launch Step Processor ASPX Main Page - User (UI) Control Relationships

The following figure illustrates the relationship between the OOTB Launch Step Processor ASPX Main Page (FnLaunchProcessor.aspx) and the UI User controls that provide the page's "look and feel". Descriptions of the UI User control modules are provided below the figure.

 

As indicated in the figure, the UI Controls do not directly access the Process Open Client Launch Step Processor Data Provider (and other Data Providers, as needed). Instead, the ASPX page retrieves the data from the Data Provider for the UI controls. (The Data Provider provides an abstraction layer between the ASPX page and the FileNet Web Services server; for additional information, see Process Open Client Architecture). If a change needs to be persisted, the ASPX page requests the UI control to provide an updated set of data, which the ASPX page uses to update the data to the Data Provider. This approach fulfills the intent of the model by decoupling the user interface from the data, thereby enhancing the developer's ability to reuse the UI controls when customizing.

For additional information about the UI Modules (User Controls) shown in this figure, see the next topic below, Open Client Launch Step Processor User Controls.

Open Client Launch Step Processor User Controls

The UI Modules shown in the figure above are described in the following table:

Notes

  1. Open Client User Controls are implemented as .ascx files and their associated .ascx.vb code-behind files. (For brevity's sake, the code-behind files — which have the same file name as the .ascx file, except for the .vb extension — are not shown in the table.)
  2. FileNet Open Client User Controls that provide related functionalities (such as the base Process User Control, the Java plug-in control, and other controls) are not shown in the figure; these User Controls are however, included in the table below.
  3. For additional information on Open Client User Controls, classes, and interfaces (such as IFnStepUIModel) referenced in the table, see User Interface Customization below.

UI User Control Module

User Control

Description

General Information UI Module

FnStepProcGeneralInfoUC.ascx

Implements the Process HTML Launch Step Processor General Information page User Control; inherits FnStepProcBaseUC; implements IFnStepUIModel.

Fields UI Module

FnStepProcDataFieldsUC.ascx

Implements the Process HTML Launch Step Processor Data Fields page User Control; inherits FnStepProcBaseUC; implements IFnStepUIModel.

Workflow Groups UI Module

FnStepProcWorkGroupsUC.ascx

Implements the Process HTML Launch Step Processor Workflow Groups page User Control; inherits FnStepProcBaseUC; implements IFnStepUIModel.

Milestones UI Module

FnStepProcMilestones.ascx

Implements the Process HTML Launch Step Processor Milestones page User Control; inherits FnStepProcBaseUC; implements IFnStepUIModel.

Attachments UI Module

FnStepProcAttachmentsUC.ascx

Implements the Open Client attachments page User Control; inherits FnStepProcBaseUC; implements IFnStepUIModel.

Folder View UI Module

FnFolderViewUC.ascx

Implements the Open Client attachments Folder View page User Control; inherits System.Web.UI.UserControl and FnBaseUC.

List View UI Module FnListViewUC.ascx Implements the Open Client attachments List View page User Control; inherits System.Web.UI.UserControl and FnBaseUC.

Banner UI Module

FnBannerUC.ascx

Provides the Open Client Banner User Control; inherits FnBaseUC and System.Web.UI.UserControl.
Current Path UI Module fnpathuc.ascx Provides the Open Client Banner User Control; inherits FnBaseUC and System.Web.UI.UserControl.
Instruction UI Module

FnBannerUC.ascx

Provides the Open Client Banner User Control and sets the Instruction UI Module; inherits FnBaseUC and System.Web.UI.UserControl.
Toolbar UI Module FnToolBarUC.ascx Provides the Toolbar User Control; inherits FnBaseUC and System.Web.UI.UserControl.
Tab Bar UI Module FnTabBarUC.ascx Provides the Tab bar User Control; inherits FnBaseUC and System.Web.UI.UserControl.
Additional User Controls FnStepProcBaseUC.ascx Implements the base Open Client Launch Step Processor User Control; inherits FnBaseUC.
  FnStepProcAttachmentEditorUC.ascx Implements editing (e.g., finalize page) for the Open Client General Information page User Control (FnStepProcGeneralInfoUC.ascx); inherits FnStepProcBaseUC; implementsIFnStepUIModel.
  FnStepProcOtherAttachmentUC.ascx Implements the Open Client User Control for each additional attachment page (such as, obtaining the current attachment value); inherits FnStepProcBaseUC; implements IFnStepUIModel.
  FnStepProcArrayEditUC.ascx Implements the Open Client Launch Step Processor data field page User Control; inherits FnStepProcBaseUC; implements IFnStepUIModel.
  FnPlugInUC.ascx Generates HTML tags for the Java Plug-in; inherits System.Web.UI.UserControl.

 

Customizing and Deploying an HTML Launch Step Processor

Customizing and deploying the OOTB HTML Launch Step Processor is quite similar to customizing the User Interface of the FileNet Open Client OOTB HTML Step Processor, except that the OOTB HTML Launch Step Processor ASPX page (FnLaunchProcessor.aspx) and its associated code-behind .aspx.vb file are located in the ...\FnOpenClient\eProcess\Launchers\ HTML\OOTB\ directory on the web server. For details, see Developing a Custom HTML Step Processor.