Engine Properties
This section describes properties that control the behavior of the process engine.
bw.engine.autoCheckpointRestart
This property controls whether checkpointed process instances are automatically restarted when a process engine restarts. By default, this property is set to true
, indicating that checkpointed process instances should automatically be restarted. You can set this property to false
, and any checkpointed process instances can later be recovered using the Job Recovery dialog in TIBCO Administrator. This allows you to handle any resource availability problems such as database recovery or bringing up a web server before handling the process instance recovery.
For more information about process instance recovery, see Managing Recoverable Process Instances.
bw.engine.dupKey.enabled
This property controls whether duplicate detection is performed. true
(the default) indicates the process engine will check for identical duplicateKey values. false
indicates duplicateKeys
when specified are ignored.
For more information about duplicate detection, see TIBCO ActiveMatrix BusinessWorks™ Process Design.
bw.engine.dupKey.timeout.minutes
This property specifies how long (in minutes) to keep stored duplicateKeys
. The default is 30 minutes. 0 indicates the duplicateKey is removed when the job is removed. However, if bw.engine.enableJobRecovery=true, the job is not automatically removed after a failure so the duplicateKey will remain as long as the job remains. Such a job can be restarted or purged later. -1 indicates to store duplicateKey values indefinitely. Any positive integer greater than 0 indicates the number of minutes to keep stored duplicateKeys.
For more information about duplicate detection, see TIBCO ActiveMatrix BusinessWorks™ Process Design.
bw.engine.dupKey.pollPeriod.minutes
Specifies the number of minutes to wait before polling for expired duplicateKey
values.
For more information about duplicate detection, see TIBCO ActiveMatrix BusinessWorks™ Process Design.
bw.engine.enableJobRecovery
This property specifies whether checkpoint data for process instances that fail due to unhandled exceptions or manual termination should be saved. Saving the checkpoint data allows the process instance to be recovered at a later time. By default, this property is set to false indicating that checkpoint data for failed process instances is not saved. Setting this property to true saves checkpoint data for failed process instances and these process instances can be recovered at a later time using the Job Recovery dialog in TIBCO Administrator.
For more information about process instance recovery, see Managing Recoverable Process Instances.
bw.engine.stats.dir
This property specifies the location of the process instance and activity statistic files when statistics storing is enabled. The default location of this property is <
engineWorkingDir
>/stats
.
For more information about statistic collection, see Storing Process Instance and Activity Statistics.
bw.engine.jobstats.enable
This property controls process instance statistic collection. The default value of this property is false
indicating that statistics for each process instance should not be stored. Setting this property to true
enables the gathering of statistics for each process instance.
For more information about statistic collection, see Storing Process Instance and Activity Statistics.
bw.engine.jobstats.rollover
This property specifies the maximum size (in bytes) for process instance statistic files. Once a file reaches the specified size, a statistics are written to a new file. The default value of this property is 1024 (1 MB).
For more information about statistic collection, see Storing Process Instance and Activity Statistics.
EnableMemorySavingMode or EnableMemorySavingMode.<processName>
Memory saving mode can reduce the memory used by actively running process instances as well as potentially improve the performance of checkpoints. By default, memory saving mode is disabled, but you can enable garbage collection on specific process instances by setting the EnableMemorySavingMode.<
processName
>
property to true
. You can enable memory saving mode for all process instances by setting the EnableMemorySavingMode
property to true
.
For more information, see TIBCO ActiveMatrix BusinessWorks™ Process Design.
Engine.dir
When the process engine is configured to use local file for storage, this property controls the location of the process engine storage. By default, this is set to <
TIBCO_Home
>/tra/domain/<
domainName
>/application/<
appName
>
. Normally, you should not need to change the default location of engine storage. For more information, see Configuring Storage for TIBCO ActiveMatrix BusinessWorks Processes.
Engine.ShutdownOnStartupError
By default, checkpointed process instances are restarted when the engine restarts, and if the engine encounters errors during startup, the restarted process instances continue to be processed and may eventually be lost depending upon the type of error at startup. You can specify that the process engine should shutdown if any errors are encountered during startup so that checkpointed jobs are not lost in the event of an error. The custom engine property named Engine.ShutdownOnStartupError
controls this behavior. By default, the value of the property is false
, but setting it to true
shuts the engine down if errors are encountered when the engine starts.
For more information about the Checkpoint activity, see TIBCO ActiveMatrix BusinessWorks™ Palette Reference.
Engine.StandAlone
Under some situations, a unique constraint violation is thrown when using a database as the data manager for process engines. Set this property to false
if you encounter this situation.
Engine.StepCount
This property controls the max number of execution steps unless inside a transaction for a job before an engine thread switch occurs. The default value of this parameter is 20.
Frequent thread switching can cause engine performance degradation, but when a process instance keeps the tread too long, this may cause less concurrency for executing process instances (and therefore inefficient use of CPU). Therefore, it is difficult to determine the correct value for this property. The default value is sufficient for most situations, but if your process definitions contain a large number of activities and especially if they contain a large number of activities in iteration loops, you may benefit from setting this property to a higher value.
Engine.ThreadCount
This property controls the number of threads available for executing process instances concurrently. The default value is 8.
On a multi-CPU machine, the ThreadCount value can be increased.However, too many threads can cause resource contention. Hence you need to experiment with it to decide on a higher ThreadCount value.