Edit the file <MQWFDir>/WebClient/WebClient.properties
to
specify the settings for the servlet. The following tables list the
available settings with their possible values. Note that the servlet does not
require this configuration file, however, if you want to use it, you must set the
ConfigurationFile
initialization parameter in the servlet setup
of your servlet container to point to this file. If your servlet container supports
Servlet API V2.2, this is done by editing the
<MQWFDir>/WebClient/webpages/WEB-INF/web.xml
file.
The WebClient.properties
file is divded into named sections,
which start with a [SectionName]
line. All properties
following this line are part of section SectionName up to the start
line of the next section. The remainder of this page contains the sections used by the
Web Client itself. If you are writing your own extensions, you can add further
actions to the WebClient.properties
file. For more details, see
customizing the Web Client. There
may be more sections in the WebClient.properties
file provided, which
belong to Web Client samples and are not described here. Refer to the samples
for a description of their properties.
This section contains settings for the Web Client's servlet.
Setting | Default Value | Description |
---|---|---|
RootURI | /MQWFClient | The root URI of the Web Client's web application. Normally, this
can be determined through the Servlet 2.1 APIs so you only need to
set this property if your application server does not support that.
If in doubt, enable logging and check the
resulting servlet.log file. The assumption is that
<servletName>=<rootURI>+<servletPath> holds. |
DocumentRoot | <MQWFDir>/WebClient/webpages | The document root directory of the Web Client's web application.
Normally, this can be determined through the Servlet 2.1 APIs so
you only need to set this property if your Application server does
not support that. If in doubt, enable logging
and check the resulting servlet.log file. Look for the
line reading
Root URI: <rootURI> is <documentRoot> . This
setting is also useful if the Application server does not support
seperate document root directories for each Web application. |
OwnsHttpSessions | true | This setting controls whether the Web Client owns (that is, creates
and invalidates) the HttpSession objects it uses to
store session information between client requests. If this
setting is set to false , the Web Client servlet's
context is responsible for managing the HttpSession
object. See also
com.ibm.workflow.servlet.client.Main. |
AgentName | MQWFAGENT | The name of the Java Agent that is used to connect to the Workflow system. |
AgentLocator | LOC_LOCATOR | The locator policy to find the Java Agent. This setting can be one of these: LOC_LOCATOR, JNDI_LOCATOR, RMI_LOCATOR, OSA_LOCATOR, IOR_LOCATOR, or COS_LOCATOR. LOC_LOCATOR is the preferred method of accessing the MQSeries Workflow Java APIs, because it eliminates the communication layer between the Java APIs and the Java Agent. For JNDI, the AgentNamingFactory and AgentProviderURL have to be set as well. |
AgentConfiguration | The configuration ID to be used for the Java Agent. If this setting
is used, the Servlet.AgentLocator setting will be forced
to LOC_LOCATOR. |
|
AgentNamingFactory | The name of the naming factory class. This setting is only needed when using JNDI_LOCATOR. | |
AgentProviderURL | The URL where the Java Agent has been registered. This setting is only needed when using JNDI_LOCATOR. | |
LogoffOnDestroy | true | This setting controls that the servlet logs off all currently logged-on users when the servlet is unloaded by the servlet container. Generally, this setting shouldn't be changed. |
Logfile | Control logging for the servlet. If set, all major events are written into the logfile specified. Use only forward slashes when specifying the path even on non-Unix platforms. Note that it is not possible to delete/move the log file while the Web server is running. | |
DateFormat | dd.MM.yyyy | The format for the generated date fields. For more information about what the possible values are, see the JDK documentation for class java.text.SimpleDateFormat. |
TimeFormat | HH:mm:ss | The format for the generated time fields. For more information about what the possible values are, see the JDK documentation for class java.text.SimpleDateFormat. |
CommandHandler | The name of a class implementing the CommandHandler interface, which is used to handle custom commands or to extend built-in commands. | |
DefaultViewer | com.ibm.workflow.servlet.client.DefaultViewer | The name of a class implementing the Viewer interface, which is used to create the customizable pages. The DefaultViewer class provides backward compatibility with HTML templates. The JSPViewer uses JSPs instead of HTML template files to create the response pages. |
These values are used to log on to the Workflow system in a so-called 'Web user' scenario.
Setting | Default Value | Description |
---|---|---|
StarterUserID | The user ID used to log on to the Workflow system. If this user ID or the password are missing, it is not possible to use the 'Web user' feature. | |
StarterPassword | The password for the specified user ID. | |
StarterSystemGroup | The system group, in which the processes should be started. | |
StarterSystem | The system within a system group, in which the processes should be started. |
There are settings to control which areas of the Web Client are
enabled. If an area is disabled, it cannot be accessed from the
drop-down navigator in the Web Client. Note that these settings are
also respected by JSPViewer
.
Setting | Default Value | Description |
---|---|---|
EnableWorklists | true | Enable access to worklists. |
EnableTemplatelists | true | Enable access to templatelists. |
EnableInstancelists | true | Enable access to instancelists. |
AutoRefresh | false | This setting controls if a list will be refreshed automatically
after an item has changed. If set to false , only the
item that has changed is refreshed. If the item has been deleted, it is
removed from the list. |
PageAfterLogoff | {_HTMLDir_}/Logon.html | The URL of the page that should be displayed after the Client is logged off. The default is to display the logon page again. |
GenerateForms | true | If set to true, a form will be generated from the input container when the HTML template file to start a process (Viewer.createAndStartInstanceResponse()) or the HTML template file to start an activity (Viewer.checkOutWorkItemResponse()) does not exist. If set to false, an exception will be thrown instead. |
You can specify settings for components that are used indirectly by the Web Client, for example, if you are using IIOP instead of LOC_LOCATOR to connect to the Java Agent. This means, that the Inprise VisiBroker ORB is used and your configuration might require to set properties for VisiBroker. For example, a non-standard port could be used or the address of a server could be in a different subnet from the one, in which the OSAgent is running.
The Web Client supports this by setting Java System properties in its
init
method. All properties in the [System]
section
are passed on. For example, you can configure Inprise VisiBroker by
adding the following properties to the WebClient.properties
file:
ORBagentAddr=9.164.42.16
ORBagentPort=15000