Workflow system advanced properties

Advanced properties enable you to fine-tune your workflow system. Usually, you will add an advanced property only when instructed by IBM® Software Support. Advanced properties are added on either the workflow system or the server level.

Cached Entry Timeout workflow system property

The Cached Entry Timeout workflow system property sets the interval (in hours) for refreshing entries in the workflow user and group cache. The Cached Entry Timeout property is set in the Advanced tab with a default value of 4 hours. A value of 0 indicates that entries are not automatically updated. If no timeout value is entered, the timeout defaults to every 4 hours. You can modify the value for this property, but you cannot delete it.

When the workflow system needs to access a user or group record for runtime processing, the cache memory is checked for this record. If the record is not in memory or the record in memory is stale, the workflow system checks the database. In a similar manner, if the record is not in the workflow system database or the database record is stale, the workflow system refreshes the record from the directory service. Accessing the directory service is the most costly process during a record refresh. Each record, whether in memory or in the database, has a time stamp of the last update. The time stamp is used to determine whether or not a record is stale. In this case, a record is considered stale when the time stamp of the last update is older than the number of hours specified in the Cached Entry Timeout property value.

Tuning the Cached Entry Timeout property enables you to maximize performance for your business environment. The workflow system caches a user or group name the first time it is retrieved from the directory service during processing of a workflow, eliminating the need to access the directory service again when a user or group is subsequently referenced in a workflow. How often you update the user cache entries is based on how often there are changes to your directory service (that is, adding or deleting users and groups, or modifying group memberships).

  • If the directory service changes frequently and you want to synchronize cached entries at set intervals, set the Cached Entry Timeout property value to the desired interval.
  • If you want to disable automatic cache memory refresh with the directory service, set the Cached Entry Timeout property value to 0. Use the vwtool environment command to reconcile selected entries.
Note: Refreshing many entries (several hundred or more) in the cache at the same time can cause performance to degrade briefly on the workflow system server. This can occur when internal processing requires a large number of users to be accessed at the same time at a point when the timeout has occurred. To preclude many entries from becoming stale, use the CacheSyncInterval property, which sets the interval of synchronizing the workflow system database with the directory service. The workflow system environment records are updated with the directory service asynchronously, which reduces the access of the directory service during run time.

CacheSyncFixupEmail workflow system property

Set the CacheSyncFixupEmail property to synchronize email addresses in the workflow system environment records to match the email addresses found in the directory server.

Set this property to a value of TRUE, T, or 1 to specify that email addresses are automatically synchronized. Set this property to a value of FALSE, F, or 0 (zero) to specify that email addresses are not automatically synchronized. The default value is TRUE.

For a workflow system upgraded from version 5.0 or earlier:
  • If the CacheSyncFixupEmail property value was explicitly specified, the upgrade retains the explicit setting.
  • If the CacheSyncFixupEmail property value was not explicitly specified, it defaults to FALSE (to maintain the same default behavior as before the upgrade).

CacheSyncInterval workflow system property

The CacheSyncInterval property sets the number of seconds between workflow environment record refresh operations (for example, enter 90 for 90 seconds).

The workflow system runs a background process that periodically refreshes the workflow system environment records so that the data is always current in the database. The optimal number of records refreshed at the refresh interval is determined by an algorithm to keep all of the cached environment records current.

The background process eliminates the delay of accessing the directory service provider for current data when needed. The background process calculates the number of records to refresh for each refresh interval based on the number of user environment records, the Cached Entry Timeout value, and the CacheSyncInterval value. This process refreshes environment records that are at least 80% to expiration on each refresh interval, thereby skipping records that do not require refreshing.

The CacheSyncInterval property setting defaults to 120 seconds. If you set the value to 0, the cache refresh operation is disabled.

CacheUseExpiredIfNecessary workflow system property

The CacheUseExpiredIfNecessary workflow system property defines how the Content Platform Engine server, upon receiving an on-demand request to access a user or group environment record, refreshes an out-of-date memory environment record.

If you set the CacheUseExpiredIfNecessary property to false, the Content Platform Engine database is updated according to the interval specified by the CachedEntryTimeout property. If a cached database record is older than the value that is specified by the CachedEntryTimeout property, the Content Platform Engine server updates the cached record from the Content Platform Engine database. Otherwise, if CacheUseExpiredIfNecessary is set to true, the Content Platform Engine server does not attempt to update an out-of-date cached database record. The default value for CacheUseExpiredIfNecessary is true.

This property is available only in IBM Content Cortex Version 5.2.1.0-P8CPE-IF002 or later.

CCEPOWSBrokerServletURL workflow system property

The CCEPOWSBrokerServletURL property defines the URL and port where WSDL queries and POST requests to the process orchestration framework are sent.

The P8BPMWSBroker servlet serves as a proxy and uses the value of the CCEPOWSBrokerServletURL property to forward requests and responses to the CCEPOWSBroker servlet. The CCEPOWSBrokerServletURL property specifies the process orchestration endpoint.

The invoke and reply operations from a web service WSDL is handled by the CCEPOWSBroker servlet on the target server.

The CCEPOWSBrokerServletURL property value is required. Set the CCEPOWSBrokerServletURL property value to a URL that has the following syntax:

http://server_name:port_number/name
For example:
http://cmint3b:9080/ibmccepo

CCEPOWSPublicListenerURL workflow system property

Use the CCEPOWSPublicListenerURL property to specify a public address for a process orchestration endpoint.

The CCEPOWSPublicListenerURL property is intended for a high availability server environment. Invoke, receive, or reply operations from a web service can be accepted through the public server, which in turn directs the responses to a specified server. The CCEPOWSPublicListenerURL property defines the public URL that accepts responses from a web service. The web service responses are passed to the server defined by the CCEPOWSBrokerServletURL property.

A CCEPOWSPublicListenerURL property value is optional and by default is the same value as CCEPOWSBrokerServletURL. Set the CCEPOWSPublicListenerURL property value to a URL with the following syntax:

http://public_server_name:port_number/name
For example:
http://publicServer:####/publicName

DBCREATEPEVIEWS workflow system property

The DBCREATEPEVIEWS property can be set to automatically create database views that are not case sensitive. The database views are automatically created or re-created whenever there are committed changes to the workflow system database through a workflow or schema. Non-case-sensitive database views are automatically created or re-created for all local queues, rosters, and event logs for the current isolated region.

To enable non-case-sensitive database view creation, set the property to a value of 1. The default value is 0.

DBCREATEVWVIEWS workflow system property

The DBCREATEVWVIEWS property can be set to automatically create database views that are case sensitive. The database views are automatically created or re-created whenever there are committed changes to the workflow system database through a workflow or schema. Case-sensitive database views are automatically created or re-created for all local queues, rosters, and event logs for the current isolated region.

To disable case-sensitive database view creation, set the property value to 0. The default value is 1.

SQLServerStoredProcWait workflow system property

The SQLServerStoredProcWait property sets a timeout value for requests from the workflow system to an external database that are made by using the DbExecute system function.

The timeout value is the number of seconds before timing out (for example, enter 120 for two minutes). The default value is 3600 (one hour).

POBootstrapUser workflow system property

The POBootstrapUser workflow system property specifies the user name that is used by the CCEPOWSBroker servlet for interaction with the Content Platform Engine.

If a user name is not specified, then the Content Engine system user, cpe_system_user, that is specified through the IBM Administration Console for Content Platform Engine (ACCE) is used for the interaction. You set the value of POBootstrapUser in ACCE.

The POBootstrapUser property value is used in the following process orchestration functions:
  • Generating WSDLs
  • Invoking web services
  • Receiving SOAP requests for web services calls
  • Starting workflows that are based on SOAP requests

POReplyRetryCount workflow system property

The POReplyRetryCount workflow system property is used to specify the number of times to retry when a work object remains locked when a web services reply is received. The default value is 10.

POReplyRetrySleepInMs workflow system property

The POReplyRetrySleepInMs workflow system property sets the number of milliseconds between retries when waiting for a work object to become unlocked. The default is 1000 ms.

WSRMAcknowledgementIntervalInMs workflow system property

The WSRMAcknowledgementIntervalInMs workflow system property sets the interval in milliseconds for acknowledgment of the receipt of a message between a reliable messaging source and a reliable messaging destination.

Web Services Reliable Messaging is a web services protocol that ensures the reliable exchange of messages between systems. If the reliable messaging source does not receive an acknowledgement that the message was received by the reliable messaging destination, the acknowledgement request is sent again at the specified interval until an acknowledgment is received. The default value is 200 milliseconds.

WSRMBaseRetransmissionIntervalInMs workflow system property

The WSRMBaseRetransmissionIntervalInMs workflow system property sets the interval in milliseconds for retransmitting an unacknowledged message between a reliable messaging source and a reliable messaging destination.

Web Services Reliable Messaging is a web services protocol that ensures the reliable exchange of messages between systems. If the reliable messaging source does not receive an acknowledgement that the message was received by the reliable messaging destination, the message is retransmitted again at the specified interval until an acknowledgment is received. The default value is 5000 milliseconds.

WSRMInactivityTimeoutInMs workflow system property

The WSRMInactivityTimeoutInMs workflow system property sets the interval in milliseconds to time out inactive sequences between a reliable messaging source and a reliable messaging destination.

The Web Services Reliable Messaging inactivity timeout value has no effect on the standard messaging timeout value. The default value is 240000 milliseconds.

MaxBlobSize workflow system property

The MaxBlobSize workflow system property sets the maximum size for a BLOB object in the workflow system.

Setting the value for MaxBlobSize too high can cause the workflow system to run out of memory. For example, if you set MaxBlobSize to 1 GB on a 32-bit system, and then two 1 GB BLOBs are allocated at the same time, you will receive an out of memory error.