HTML Step Processor Toolkit Files

The FileNet Web Services HTML Step Processor Toolkit files are included in the ...\Program Files\FileNet\IDM\Web\IDMWS\Redist\WF_Html_Toolkit directory and the \Redist\Toolbar directory, both of which were installed on the FileNet Web Services server. The Toolkit contains shared files for the sample HTML (ASP) Step and Launch Step Processors.

The \WF_Html_Toolkit directory contains the following subdirectories (also included is the \Redist\Toolbar directory); for details on the contents of these subdirectories, click on the link or see below:

Directory\Subdirectory Contains Description
\Core Core Shared Files Includes the basic shared .ASP, .INC (server-side includes), and .JS (Javascript) files used in the default Step Processor and Launch Step Processor.
\Images .gif image files Contains the GIF images for the user interface for the default HTML (ASP) Step and Launch Step Processors. If you are modifying the user interface of the default HTML Processors, you may add your own images to this subdirectory, but it is recommended you not delete any .gif files.
\UI User Interface Files Contains the .ASP files used to format the default Step Processor and Launch Step Processor user interface.
\Utility Utility Files Contains client-side and server-side files for calling utility sorting functions.
...\Redist\Toolbar Toolbar Shared Files Contains the FileNet Web Services .ASP files that implement the toolbar icon and stored search functionalities for the default HTML Step and Launch Step Processors.

Core Shared Files

The following table describes the files in the \WF_Html_Toolkit\Core directory. These files are the basic shared .ASP, .INC (server-side includes), and .JS (Javascript) files used in the default Step Processor and Launch Step Processor. The files in this subdirectory are used for defining objects, initializing the Step Processor state, and enabling workflow processing. These files may be extended for additional functionalities, but you should not delete the files or any of the existing content of these files.

Note For additional information, see the Modifying Core Files topic.

File name

Description

att.js

Implements functions for creating a client-side attachment object and defines the associated methods for the object. Checks for the attachment type: document, folder, and stored search. Uses some of the FileNet Web Services client-side, Javascript API objects to work with attachments.

launchStepElementInit.asp

Retrieves the Launch step information and initializes the Launch Step Processor system field values for the user interface components. References work groups and attachment functionality. Uses loadAtt.inc, loadFields.inc, and loadWorkGroup.inc to initialize the attachment properties.

launchStepProcessor.asp

Implements functions for parsing and processing XML strings for Launch Step Processor operations (like launch and cancel). The implemented functions assume that a Process Session (a VWSession object) is already instantiated.

loadAtt.inc

Server-side Include file. Implements general functions for loading and displaying attachment objects (including attachment properties).

loadFields.inc

Server-side Include file. Implements general functions for loading, displaying, and sorting system data fields arrays.

loadWorkGroup.inc

Server-side Include file. Implements general functions for loading and displaying work group arrays.

step.js

Implements functions for creating and working with client-side work group objects, Step Element objects, Step Information objects, and Step parameter objects. The functions define all of the associated methods for these objects.

stepElementInit.asp

Retrieves the Step information and initializes the Step Processor system field values for the user interface components (like F_StepDescription, F_Originator, F_LaunchDate, etc.). References work group and attachment functionality. Uses loadAtt.inc, loadFields.inc, and loadWorkGroup.inc to initialize the attachment properties.

stepProcessor.asp

Implements functions for parsing and processing XML string from Step Processor operations (like Save, Cancel, Reassign, Return, etc.). The implemented functions assume that a Process session (VWSession) object already exists.

stepProcessorAttHelper.asp

Implements helper functions for getting and saving attachments.

stepProcessorFieldHelper.asp

Implements helper functions for working getting field values and working with field arrays.

stepProcessorWGHelper.asp

Implements helper functions for saving workgroup information.

toolbarHelper.asp

Implements helper functions for both Step Processor and Launch Step Processor user interface toolbar components (like Save, Cancel, Move, Cancel Launch, etc.)

User Interface Files

The following table describes the files in the \WF_Html_Toolkit\UI directory. This directory contains the shared .ASP files used to format the default Step Processor and Launch Step Processor user interface and define user interface behavior. These files may be extended for additional functionalities, but you should not delete the files or any of the existing content of these files.

Note For additional information, see the Modifying User Interfaces Files topic.

File name

Description

arrayEdit.asp

Implements functions for checking, displaying, and editing field arrays. The embedded form posts the information to the dataField.asp file.

attachment.asp

Container file. Implements a frameset for presenting the attToolbar.asp and attachmentTable.asp files.

attachmentTable.asp

Provides a table for displaying attachment. The file implements Javascript functions for getting attachment names, item information, attachment IDs, and the name of the library storing the attachment.

attToolbar.asp

Implements functions for creating an attachment toolbar and working with the changing toolbar state.

dataField.asp

Receives array data from the arrayEdit.asp file. Provides a table for editing non-array values and displaying field array information.

generalInfo.asp

Provides a table to display general step information, like the subject or comments. Implements functions used in the General tab.

milestone.asp

Provides support for displaying milestone-related message and status information.

reassign.asp

Implements a dialog box that allows a participant or tracker to reassign the workflow step to a new participant.

resource.asp

Defines localizeable strings that are shared by the HTML Step Processor, HTML Launch Step Processor, and HTML milestone tracker components.

stepInfo.asp

Displays general step information (like the subject, sender information, origination time, reception time, comments, and responses).

tab.asp

Implements functions for selecting the Attachments, Data Fields, Workflow Groups, General, and Milestone tabs.

tabContent.asp

Container file. Implements logic for selecting the page(s) associated with the selected tab.

toolbar.asp

Works with toolbarHelper.asp, which implements all of the button event handlers, and ToolbarButton.asp files to implement functions to display a toolbar for the following operations: Complete, Save, Move, Cancel, Reassign, Return, Status, and Help.

workGroup.asp

Provides a table to display workgroup information, like workgroup name and workgroup participants. Implements a function for calling the workGroupEdit.asp.

workGroupEdit.asp

Provides a dialog box for displaying and updating workgroup information.

Utility Files

The following table describes the files in the \WF_Html_Toolkit\Utility directory. This directory contains shared client-side (.JS) and server-side (.ASP) files for calling utility functions for quick sorting, property type checking, and XML streaming. These files may be extended for additional functionalities, but you should not delete the files or any of the existing content of these files.

Note For additional information, see the Modifying Utility Files topic.

File name

Description

utility.js

Client-side file that implements Javascript utility functions for working with field values. This JavaScript defines functions for sorting, checking, and converting strings to XML.

utility.asp

Server-side .ASP file that implements VBScript utility functions for working with field values. This ASP defines functions for sorting, checking, and converting strings from XML to HTML.

Toolbar Shared Files

The following table describes the toolbar files in the \Redist\Toolbar directory. This directory contains the shared FileNet Web Services .ASP files that implement the toolbar icon and stored search functionalities for the default HTML Step and Launch Step Processors. You should not delete these files or any of the existing content of these files.

File name

Description

ToolbarButton.asp

Implements toolbar icon functionality for FileNet Web Services applications. This .ASP is referenced by HTML Step Processor and Launch Step Processor user interface components, such as attToolbar.asp.

ToolbarStoredSearch.asp

Implements toolbar stored search functionality for FileNet Web Services applications. This .ASP is referenced by HTML Step Processor and Launch Step Processor user interface components.