Introduction

Properties are divided into sections; click on a section header to open it to display the properties. Click the Save button at the bottom of the page to save the properties. These properties are saved to file workflow.properties in the ebaseConf folder of the web application e.g. UfsServer/tomcat/webapps/ufs/ebaseConf/workflow.properties.

The icon shown to the left of a property indicates that the server must be restarted before a property change is activated. Changes to all other properties are effective immediately.

Click More Info.. at the right-hand side of each property to display help for that property.

Workflow Properties

Label	Property Name	Requires Restart	Description
Assignment Handler	Workflow.AssignmentHandler	Yes	Specifies the class name of the implemented workflow assignment handler. In most cases this will be the default assignment handler provided with the system com.ebasetech.ufs.xi.workflow.XIAssignmentHandler. This property must match the corresponding property configured for each Ebase Xi Designer system using designer preferences workflow tab. Additional properties for class com.ebasetech.ufs.xi.workflow.XIAssignmentHandler are configured in the XI Assignment Handler Properties section below. Click here for more details of the Xi Assignment Handler and how it works. Click here for more details on assignment handlers in general.
Security Handler	Workflow.SecurityHandler	Yes	Specifies the class name of the implemented workflow security handler. In most cases this will be the default security handler provided with the system com.ebasetech.ufs.workflow.security.example EbaseSecurityHandler. This property must match the corresponding property configured for each Ebase Xi Designer system using designer preferences workflow tab. Two workflow security handlers are shipped with the distributed Ebase Xi system and can be configured here: · com.ebasetech.ufs.workflow.security.example EbaseSecurityHandler: provides minimal security checking– all users are allowed to create new workflow jobs and display a task list without any security check. In addition if a workflow process or node does not have a security expression configured, all other actions are also allowed. If the workflow process or node does have a security expression only users with a matching authorization will be given access. · com.ebasetech.ufs.workflow.security.example EbaseStrictSecurityHandler: provides a higher level of security checking - all users are allowed to create new workflow jobs without any security check, but all other actions require security authorization. See also Configuring Workflow Security Authorizations.
Remote Workflow Server URL	Ufs.RemoteWorkflowUrl	Yes	Specifies the URL of the workflow API servlet on a remote server. This property allows requests for new workflow jobs to be passed to a workflow engine running on the remote server. When not specified, all requests for new workflow jobs are passed to the workflow engine on the same server. This property must have the format: http protocol://host[:port]/webapp/WorkflowAPIServlet e.g. http://workflowhost:3030/ufs/WorkflowAPIServlet This parameter can be useful in the scenario where a server system handling user requests exists in a DMZ and a workflow server is running inside an inner firewall. Workflow requests for new jobs can be passed through to the workflow server using HTTP or HTTPS.
Process Attributes Cache Size	Workflow.processAttributesCacheSize	Yes	The maximum number of jobs whose process attribute values are cached in memory. The default value is 2000. Setting this to -1 disables the workflow process attributes cache. This cache can be an important factor in maintaining consistently good responses for a workflow task list application. See optimizing workflow tasklist performance for more information.
Workflow Queue Sleep Time	Workflow.queueSleepTime	No	The number of milliseconds that the workflow queue processor waits between polls of the workflow queue database e.g. a value of 100 means that the database will be polled roughly 10 times per second. Specifying a high value can result in sluggish performance of the workflow system. The default value is 250.

Workflow Server Error Recovery Options

Label

Property Name

Requires

Restart

Description

Default Error Recovery Process

default.error.recovery.process

The name of the workflow default error recovery process. This can be overridden for individual workflow processes using workflow process properties. This process receives control whenever a runtime failure of a workflow job occurs e.g. a script failure. The following parameters are passed into the process when an error occurs:

· FAILEDPROCESSNAME – the name of the process for which a task enactment has failed

· FAILEDTASKNAME – the name of the task enactment which has failed

· FAILUREREASON – a text string describing the reason for failure. This will typically be the error message generated by the workflow system.

· TARGETEMAIL – see next property

Error Recovery Email Address

error.recovery.email.recipient

This email address is passed to the error recovery process when a runtime failure of a workflow job occurs e.g. a script failure. It can be used as a notification mechanism that a failure has occurred that requires manual intervention. See previous property.

Xi Assignment Handler Properties

These properties supply options for the Xi Assignment handler and apply only when this class - com.ebasetech.ufs.xi.workflow.XIAssignmentHandler - is configured in the Assignment Handler property of the Workflow Properties section above. Click here for more details of the Xi Assignment Handler and how it works.

Label	Property Name	Requires Restart	Description
Default Xi Assignment Service Web Service Name	Assignment.WebService	Yes	The web service name of the default Xi Assignment System Service. If not specified the default is ebaseAssignmentService. This service will be invoked on the local server using a special internal URL.
Xi Default Assignment Type	Assignment.defaultType	No	The default assignment type. This is used when there is an error calling the workflow assignment System Service or if the service fails to return valid assignment criteria. Supported values are Role and User (the default is Role). When Role is specified, failing tasks are assigned to the role specified in the following property. When User is specified, failing tasks are assigned to the single user specified in the following property.
Xi Default Assignment Type Value	Assignment.defaultValue	No	See previous property. The default is WFADMIN if not specified.