eProcess Open Client Web Footprint Directory Contents and Structure

During Panagon Open Client Web Services installation, an eProcess-specific directory structure (...\eProcess) is created as a subdirectory of the overall Open Client directory. The Open Client directory name and location is user-selectable (the default is the ...\Program Files\FileNET\IDM\Web\IdmWSX directory). This directory is extended during Panagon Open Client Toolkit installation to provide a server-side web footprint for Panagon eProcess Open Clients (the IdmWSX directory with its ...\IdmWSX\eProcess subdirectory — or its user-selectable equivalent — is not downloaded to the client).

eProcess functionality for Open Client is provided both in the ...\IdmWSX\eProcess (or its equivalent) subdirectory and in other ...\IdmWSX subdirectories and files. To simplify locating these eProcess-related subdirectories and files, information on the contents and structure of these directories is presented in two tables: one that is specifically eProcess and a second table that includes those ...\IdmWSX (non-eProcess-specific) Open Client subdirectories that contain resources and controls used by eProcess.

The following two tables summarize the eProcess-related directory structures on the web server:

eProcess Web Footprint Directory Contents and Structure

The following table summarizes the eProcess Open Client web footprint directory contents and structure in the ...\IdmWSX\eProcess directory. In addition to the subdirectories shown, the ...\IdmWSX\eProcess directory — or its user-selectable equivalent — also contains a number of files for high level eProcess out-of-the-box ASPX pages, their associated .aspx.vb code-behind files, and an Include file for the JavaScripts to open the popup window (see Miscellaneous Files in the table).

Note For information on .aspx.vb code-behind files, see the ASPX Page description in the eProcess Open Client Overview.

The directory structure shown in this table is relative to the <drive>...\Program Files\FileNET\IDM\Web\IdmWSX\eProcess directory — or its user-selectable equivalent — on the Panagon web server.

\eProcess Subdirectories

Contents

eProcess Files (not a directory; miscellaneous files in the eProcess directory)

Includes the following eProcess high-level ASPX pages and their associated .aspx.vb code-behind files, plus an Include file:

  • FneProcessMain.aspx: Personal Work Manager (PWM) main page.
  • FnBrowseOtherPage.aspx: Page supports the selection of "other" types of attachments, such as a UNC or URL.
  • FnPopupFunctions.inc: Include file for JavaScripts to open the popup window.
  • FnWFLauncher.aspx: Workflow Definition Launcher top-level page.
  • FnWFProperty.aspx: eProcess Workflow Property page.

\DataProvider

Contains a set of VB.NET Data Providers used to provide eProcess-specific functionality to the web application ASPX pages, as follows:

  • FneProcessBaseDP: The base eProcess Data Provider abstract class (inherits FnBase). This class also includes Open Client wrapper classes for corresponding eProcess Data Provider classes to provide eProcess-related functionality, such as setting an FneProcessSession object to a VWSession object, converting an eProcess VWQueueElement to an FnQueueElement, and so on.
  • FneProcessLauncherDP: eProcess public class Data Provider used to provide eProcess Launcher functionality (inherits FneProcessBaseDP).
  • FneProcessPWMDP: eProcess public class Data Provider used to provide eProcess Personal Work Manager functionality (inherits FneProcessBase).
  • FneProcessSessionDP: eProcess public class Data Provider used to handle eProcess authentication, logon and logoff (inherits FneProcessBaseDP).
  • FneProcessStepProcDP: eProcess public class Data Provider used to provide eProcess Step Processor and Launch Step Processor functionality (inherits FneProcessBaseDP).
  • FneProcessUserPrefsDP: eProcess public class Data Provider used to provide base eProcess user preferences support and integration (inherits FnBase)
  • \XML subdirectory: Contains XML-related VB.NET Data Providers and their associated .xsd files.

\DownLoad

Contains the files to be downloaded to the client when the applet starts for the first time. These are:
  • j2re1_3_1-win-i.exe — Java 2 Runtime Environment 1.3.1 executable (required)
  • pw.jar — This JAR file contains the Java API classes and images used by eProcess Open Client applets.
\Help
Contains the eProcess Open Client Help Files.
\Images
Contains the .GIF-formatted icon graphics used by the eProcess Open Client out-of-the-box HTML Processors, including those used for email notifications.
\JS
Contains the JavaScript file (FnWindowHelper.js) used to open browser popup windows.
\Launchers

Contains the subdirectories that contain the top-level ASPX files for the out-of-the-box HTML and Java Launch Step Processors, as follows:

  • \HTML\OOTB: Contains the top-level ASPX page (FnLaunchProcessor.aspx) and its associated .aspx.vb code-behind file for the out-of-the-box HTML Launch Step Processor.
  • \Java\OOTB: Contains the top-level ASPX page (FnLSPAppletPage.aspx) and its associated .aspx.vb code-behind file for the out-of-the-box Java Launch Step Processor.
\Login

Contains the eProcess session login-related and token-related ASPX pages and their associated .aspx.vb code-behind files.

\Popups
Contains the eProcess general popup window ASPX page (FnAppletPage.aspx) and its associated .aspx.vb code-behind file.

\SP_Toolkit

Contains the utility files used for handling step elements for the out-of-the-box HTML Step and Launch Step Processors . This subdirectory contains ASPX pages (and their associated .aspx.vb code-behind files) used for editing arrays, attachments, and so on. This directory also contains a \Utility subdirectory, which contains the utility.js JavaScript file used with these pages.

\StepProcs

Contains the subdirectories that contain the top-level ASPX files for the out-of-the-box HTML and Java Step Processors, as follows:

  • \HTML\OOTB: Contains the top-level ASPX page (FnStepProcessor.aspx) and its associated .aspx.vb code-behind file for the out-of-the-box HTML Step Processor.
  • \Java\OOTB: Contains the top-level ASPX page (FnSPAppletPage.aspx) and its associated .aspx.vb code-behind file for the out-of-the-box Java Step Processor.
\UserControl

Contains the eProcess-specific Open Client VB.NET-based User control .ascx files and their associated .ascx.vb code-behind files that, in conjunction with Control Factory controls and the .NET server controls (and associated .NET classes), provide the building blocks of 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 additional information on User controls, see eProcess Open Client Components.

Open Client Web Footprint Directories Containing Resources and Controls Used By eProcess

The following table summarizes the subdirectories (other than the eProcess subdirectory) in the Open Client web footprint directory that contain resources and controls used by eProcess. In addition to the subdirectories shown, the IdmWSX directory — or its user-selectable equivalent — also contains a variety of files to provide general Open Client (non-eProcess-specific) functionality, such as a batch file (build.bat), the Open Client Main.aspx file, a makefile, a license .licx file, a generic Cascading Style Sheet (FnStyleSheet.css) for the HTML pages, and so on.

The directory structure shown in this table is relative to the <drive>...\Program Files\FileNET\IDM\Web\IdmWSX directory — or its user-selectable equivalent — on the Panagon Web server.

Note The ...\IdmWSX directory includes additional Open Client subdirectories not shown; this table is eProcess-specific and only includes those subdirectories that contain files used by eProcess. Nor does this table include the ...\IdmWSX\eProcess directory described above (see eProcess Web Footprint Directory Contents and Structure).

Directory

Contents

\Resources

Contains localization recode-behind files to provide US English, German, and Japanese user interface language localization and their associated XML .resx files (created with the VS.NET XML designer). This folder also includes the following subdirectories:

  • \bin: Contains the IdmWSX resources DLL (idmwsxRS.resources.dll).
  • \De: Contains the idmwsxRS.txt plain text file for localized strings for German.
  • \En-us: Contains the idmwsxRS.txt plain text file for localized strings for US English.
  • \Ja: Contains the idmwsxRS.txt plain text file for localized strings for Japanese.
\UserControl

Contains the general Open Client VB.NET-based User control .ascx files and their associated .ascx.vb code-behind files. Also contains subdirectories that contain Open Client user interface-related controls, such as property-related controls, document authoring and folder-related User controls, and Control Factory (low-level basic) controls.

Open Client User controls (the .ascx files and their associated .ascx.vb code-behind file names are fairly self-explanatory) include controls for base controls, banner, current location, custom pager, folder view, list view, login, numeric, pager, preferences, search template, search, tab bar, text box, and tool bar User controls, plus a date-picker JavaScript, and a Cascading Style Sheet (Styles.css).

The subdirectories in this folder include:

  • \Author: Contains document authoring-related and folder-related User control .ascx files and their associated .ascx.vb code-behind files for control functions such as: Checkin document, Copy document, Move document, Delete document, Add a folder, Move a folder, Remove a folder, and so on.
  • \ControlFactory: Contains the VB.NET-based Control Factory control .ascx files and their associated .ascx.vb code-behind files. These controls are used to provide display, editing, and validation functionalities for low-level user interface components. Factory controls are loaded via LoadControl() and are supplied either to a user control or directly to the specific eProcess ASPX page. This subdirectory includes base and utility Control Factory controls, plus specific single-value and multi-value controls. These specific Control Factory controls in this subdirectory (the file names are fairly self-explanatory) include:
    • Single-value Controls:
      • FnTextBoxUC.ascx
      • FnFloatUC.ascx
      • FnDateTimeUC.ascx
      • FnNumericUC.ascx
      • FnCheckBoxUC.ascx
      • FnFileSelectUC.ascx
      • FnComboBoxUC.ascx
      • FnListBoxUC.ascx
      • FnIndexedDDLUC.ascx
      • FnSpinnerUC.ascx
    • Multi-value Controls:
      • FnTextBoxUC.ascx
      • FnFloatUC.ascx
      • FnDateTimeUC.ascx
      • FnNumericUC.ascx
      • FnCheckBoxUC.ascx
      • FnFileSelectUC.ascx
      • FnComboBoxUC.ascx
      • FnListBoxUC.ascx
      • FnIndexedDDLUC.ascx
      • FnSpinnerUC.ascx
  • \Properties: Contains properties-related User control .ascx files and their associated .ascx.vb code-behind files for control functions (the file names are fairly self-explanatory) such as: general property page properties, custom properties, document version properties, CS security properties, IS security properties, folders filed in properties, Apply button page properties, and finalize function security properties.
For additional information on User controls, see eProcess Open Client Components.
\Util

Contains a variety of useful VB.NET-based utilities, including:

  • Fncache.vb — Provides .NET cache management for the .NET Web Form.
  • fndatetime.vb — Helper class to convert ISO datetime to a standard datetime string.
  • FnDocumentOp.vb — Provides common document operations, such as opening a document, checking out and opening a document, etc.
  • FnError.vb — Provides error management.
  • fnpagestate.vb — Provides page state management, such as saving user input and persisting it to a previous page.
  • FnPrefUtil.vb — Handles IdmWSX preference settings.
  • FnQueryString.vb — Handles query strings, URL substrings, etc.
  • FnRegExpUtil.vb — Provides US standard Reg Exp as default.
  • FnResourceManager.vb — Provides localized resource management, like getting a string from a localized resource file.
  • fnsecutl.vb — Handles security-related objects.
  • fnsessionutil.vb — Provides a utility class to verify whether a user is logged on.
  • FnStringUtil.vb — Provides a utility class for handling strings.
  • FnToolBarData.vb — Handles base operations for the ToolBarData classes.
  • FnTreeView.vb — Handles tree views.
  • FnUiDataUtil.vb — Handles miscellaneous UI data elements, such as banner elements, navigation elements, URL objects, etc.
  • FnUiUtil.vb — Provides miscellaneous UI utility functions, such as handling line attributes, etc.
  • FnVBLog.vb — Provides .NET log wrapper classes.
\XML

Contains XML-related files used by Open Client Data Providers to provide XML data (via XSLT transformation) for the ASPX page. These files include:

  • The XSL Style Sheets (for Folder view, List view and Annotation).
  • The XSD file for the transformation (FnUiDataClasses.xsd).
  • VB.NET files to provide the XML content as a dataset for the Folder view, List view and Annotation view.