When a user (workflow participant or Tracker) opens a step assignment,
a pop-up window containing the Step Processor UI displays. How the
correct Step Processor is selected for display, and how the URL for
the Step Processor UI is supplied to the Web application is the subject
of this topic.
Before a Step Processor can be opened it must be registered, added
to the workflow, and deployed. For information, see Adding a Custom Processor to the
Workflow and Deploying Java™ Applications, or Deploying HTML Applications.
Note: Information used for the algorithm and the URL is
provided by the VWAttributeInfo class.
Algorithm Used for Opening
a Step Processor
The algorithm used for opening a Step Processor
is as follows:
- Attempt to use the current Web application (defined by either
the applet or HTML page) to retrieve the Step Processor location and
URL template (see below). If the result is null, proceed to next step.
- Attempt to the current Web application setting to retrieve the
location, URL template and Web server base URL information (user preferences
first, then isolated region, then global setting). If a suitable data
set cannot be found, proceed to next step.
- Iterate through the remaining registered Web applications to find
the first available set of location, URL template, and Web server
base URL information (region settings override global settings). If
a suitable set cannot be found, proceed to next step.
- If opening from an applet, use the Java Step
Processor supplied as part of the Process Engine distribution (otherwise,
the application does not have enough information to open a Web page). The supplied Java Step
Processor is located on the Application Engine host
in filenet_installation_directory\Workplace\eprocess\stepprocs\java\ootb.
If
opening from an HTML page, the isolated region's default Step Processor
is used.
Supplying the URL for a Step
Processor
When a Step Processor is launched, a corresponding
URL is constructed (using the default URL template or your own URL
template), as follows (in sequential order):
Note: The Web server
URL, the Step Processor JavaServer Pages (JSP) location, and the URL
Template need to match (for the same Web application, based on the
registered settings).
- Web Server URL. The current Web server URL if it is the same Web
application. If it is a different Web application, the registered
settings are used.
- Location. The current location if it is the same Web application.
If it is a different Web application, the Step Processor information
values are used.
- Queue name (passed in).
- Work object number (passed in).
- Step name (passed in).
An example of a completed URL, is as follows:
http://your _server/Workplace/eprocess/stepprocs/java/mystep/step_main.jsp?queueName=Inbox&wobId=FA3454543AD231FDD3453&stepName=Test
where Workplace is the Web application, mystep is
the parent directory and step_main.jsp is the Step Processor's
(View) JSP page.