Modifying the Default HTML Step Processor
This topic describes how to customize the default HTML Step Processor (step_main.asp)
included with the FileNet Web Services HTML Step Processor Toolkit (for Toolkit
information, see Using the FileNet
Web Services HTML Step Processor Toolkit). The procedure provided with this
topic assumes that you have already set up your development system for ASP development
(for information, see Setting Up Your
System for Process ASP Development).
While there is no requirement for you to use an Integrated Development Environment
(IDE) for developing your ASPs, many developers find using Microsoft's Visual
InterDev or Visual Studio helpful. An alternative to using Visual InterDev or
Visual Studio is working directly in the <drive>...\Program Files\FileNet\IDM\Web\IDMWS
directory structure on your FileNet Web Services/PJAC for FileNet Web Services
server. If you know your ASP development requirements and you want to make minor
changes to specific files, working directly in the directory structure may be
sufficient for your needs. The primary disadvantage is that you will be working
in an active web server directory structure, which may make it more difficult
to identify and correct errors.
The default HTML Step Processor included with the HTML Step Processor Toolkit
is designed to use certain shared files which are located in the ...\Program
Files\FileNet\IDM\Web\IDMWS\Redist\WF_Html_Toolkit directory and the
\Redist\Toolbar directory on the FileNet Web Services server.
You should not modify any of the files in the ...\WF_Html_Toolkit or
\Redist\Toolbar directories without first familiarizing yourself
with the following topics:
Caution Modifying any of these shared
Toolkit files may cause problems with or a failure of the default HTML Step
Processor included with the HTML Step Processor Toolkit.
To customize the default HTML Step Processor, use the following procedure:
- Create a new directory under the ...\Program Files\FileNet\IDM\Web\IDMWS\Redist\WF_Step
directory (at the same level as the \HTML directory). If you are using
Visual InterDev or Visual Studio, add a new folder.
- Name the directory (typically according to the function of the step this
Step Processor is designed to accomplish). This procedure will use the sample
directory name \new_HTML_Step.
- Copy the contents of the ...\Redist\WF_Step\html directory into the
\new_HTML_Step directory.
- Rename the step_main.asp file (for example to newstep_main.asp).
If you are not using Visual InterDev or Visual Studio, remember to change
the file attribute from Read-only to Read/Write.
- Open the newstep_main.asp file.
- Modify the newstep_main.asp file and other related ASP files as needed.
Typical changes may, for example, include:
- Modifying the user interface; for details, see Modifying
HTML Step Processor Toolkit User Interface Files. Note that the default
step_main.asp file includes the colorOpt
variable for controlling the default color of the Step Processor tabs. The
default colorOpt
value is a hexadecimal value of "#657FD2"
(corresponding to the RGB color model). The variable is passed to the stepInfo.asp,
tab.asp, and tabContent.asp
files.
- Modifying the frames/frameset; for details, see HTML
Step Processor Relationships.
- Modifying functions; e.g., for determining and initializing Step Processor
field values, for specifying toolbar behavior, for retrieving, parsing,
and restructuring XML strings, including XML Step Element strings, XML strings
from the client, attachments, properties, etc.; for details, see Modifying
the Default HTML Core Files.
- Modifying JavaScript functions for creating and working with client objects
and attachments; for details, see Modifying
HTML Step Processor Toolkit Core Script Files.
- Modifying sorting functions on the client (e.g., if your Step Processor
will require users to sort field arrays) or the server (e.g., if your Step
Processor will require a single sorting operation to be distributed for
numerous users); for details, see Modifying
the HTML Step Processor Toolkit Utility Files.
- Be sure to include/reference the appropriate FileNet Web Services files
in your ASP(s). For example, the InitApplication.asp to initialize
your Step Processor by setting VWSession variables, constants, cookie states,
etc. (must be in your top-level ASP), the InitPage.js to initialize
your ASP (should be included in every one of your ASPs), and so on. Normally,
you should not need or want to modify these included/referenced files; for
details, see FileNet
Web Services Files Referenced By Process Applications. Similarly, be
sure to include/reference the appropriate PJAC files. For example, Attachment.js
to enable clients to view attachments, isPWLogon.asp
to get Process session (VWSession) information for a Step Processor currently
in session or if no session exists to prompt the user to log on, and so
on. Normally, you should not need or want to modify these included/referenced
files; for details, see PJAC
Files Referenced By Process Applications.
- Using the Process Java APIs to customize one or more Step Processor operations.
For example, customizing queries to User and/or Work queues, customizing
workflow data update operations (such as updating data field values, parameters,
workflow groups, response options for the user, etc.), and so on. For details,
see Basic Step Processor Operations.
Note See HTML Step
Processor Relationships for additional information on HTML Step Processor
file dependencies and the frameset implemented in the default step_main.asp.
See HTML Step Processor Toolkit Files
for information on the location and contents of the HTML Step Processor
Toolkit.
- If you need to modify any of the files in the \WF_Html_Toolkit directory,
copy the needed files into the new directory (e.g., \new_HTML_Step)
created for the new Step Processor.
- Change all calls and references to the file(s) that comprise the new Step
Processor.
- If you have not already fully done so, deploy your HTML Step Processor by
copying all files to above-indicated directories on the FileNet Web Services
server.
- Add the new Step Processor (e.g., newstep_main.asp) to the workflow.
This consists of using the Process Configuration Console to register the new
Step Processor, then using the Process Designer to specify the new Step Processor
for this step. For details, see Adding
a Custom Step Processor to the Workflow.
- Test your new Step Processor pages from your application development server.