close

Filter

loading table of contents...

Deployment Manual / Version 2406.1

Table Of Contents

3.6 Workflow Server Properties

workflow.archive.endpoint-url
Type String
Default http://localhost:41080/studio
Description

Endpoint of the process archive in the in-memory setup.

workflow.archive.password
Type String
Description

Password to use for process archiving at the endpoint in the in-memory setup.

workflow.archive.username
Type String
Description

Username to use for process archiving at the endpoint in the in-memory setup.

workflow.blob-cache-size
Type org.​springframework.​util.​unit.​DataSize
Default 32MB
Description

The size of the main disk cache of the UAPI

workflow.blob-streaming-size-threshold
Type org.​springframework.​util.​unit.​DataSize
Default 128KB
Description

The minimum size of streamed blobs

workflow.blob-streaming-threads
Type Integer
Default 2
Description

The number of streaming threads

workflow.domain
Type String
Description

The server's domain name

workflow.heap-cache-size
Type org.​springframework.​util.​unit.​DataSize
Default 20MB
Description

The size of the main memory cache of the UAPI

workflow.ior-url
Type String
Description

The Content Server's IOR URL

workflow.localization.auto-merge.legacy-list-merge
Type Boolean
Default false
Description

Configures whether an old but backwards-compatible merge algorithm for merging list properties should be used. This also applies to struct lists. If true, merge conflicts are reported if there are any changes in overlapping regions of list values. This also includes changes in nested property values, for example if there are changes in translatable properties and those properties aren't excluded with workflow.localization.auto-merge.translatable=false, or if the AutoMergeStructListMapKeyFactory is configured to merge a struct list as map, and some non-key properties have changed. An example for the latter would be a conflict caused by removing a link in a master content and a changed annotation property for that link in the derived content. If false, an improved merge algorithm is used for list values, which tries to avoid merge conflicts in more cases.

workflow.localization.auto-merge.translatable
Type Boolean
Default true
Description

Configures if translatable properties are automatically merged in translation workflows. If true, changes of translatable properties in a master content are also merged to derived content items by translation workflows, if there are no conflicting changes and the properties haven't been excluded otherwise. Opposed to non-translatable properties, merge conflicts for translatable properties are typically resolved silently in favor of the derived content and do not generate a warning for the user. There are some exceptions, especially when using the legacy list merge algorithm (see property workflow.localization.auto-merge.legacy-list-merge). Even if set to true, translatable properties can still be excluded from auto-merge, for example with extensions:automerge="false" in the document type definition or with a custom implementation of com.coremedia.translate.workflow.AutoMergePredicateFactory.

workflow.map-role
Type Map<String,String>
Description

Role mappings are used to replace group names in a process definition file by other group names without having to actually modify the textual definition

workflow.max-cached-blob-size
Type org.​springframework.​util.​unit.​DataSize
Description

The maximum size of cached blobs

workflow.navigatethrough
Type Boolean
Default true
Description

Whether to enable navigate through cache of the UAPI. This cache is used for computing read rights on folders in case no explicit read rights are defined and read rights on subfolders force read rights on folders on the path to these folders. Because these computations are expensive and sometimes unnecessary, this flag allows you to ignore navigate-through rights in the Workflow Server.

workflow.password
Type String
Default workflow
Description

Define a password for the connection with the Content Management Server.

workflow.pool.queue-size
Type Integer
Default 0
Description

Pool queue limit.

workflow.pool.threads-max
Type Integer
Description

Pool thread max limit.

workflow.pool.threads-min
Type Integer
Default 0
Description

Pool thread min limit.

workflow.server.adapters.directory
Type String
Default com.coremedia.workflow.impl.server.adapters.directory.UnifiedUserManagerAdapter
Description

The directory service adapter.

workflow.server.adapters.persistence
Type String
Default com.coremedia.workflow.impl.server.adapters.persistence.GenericRDBMSAdapter
Description

The persistence adapter.

workflow.server.allow-live
Type Boolean
Default false
Description

Whether to allow connecting to a live Content Server

workflow.server.archive.persistence
Type String
Default elastic-core
Description

Persistence option where archived workflow processes are stored. By default, Elastic Core is used for storage in MongoDB or in its in-memory replacement. Set this to "sql" to store archived processes in the Workflow Server's relational database.

workflow.server.archive.retry-exceptions
Type List<String>
Default [java.io.IOException, com.mongodb.MongoTimeoutException]
Description

List of exception classes that indicate temporary problems when archiving a workflow process. If one of these exceptions is thrown directly or as cause of another exception in com.coremedia.workflow.common.actions.ArchiveProcessFinalAction, then the Workflow Server will retry archiving with some delay as configured in properties workflow.server.retry-final-actions.*.

workflow.server.enable-workflow-converter
Type Boolean
Default false
Description

This flag allows you to enable the workflow converter while starting Workflow Server

workflow.server.final-actions-max
Type Integer
Default 10
Description

The maximum number of threads executing FinalActions of finished processes. This setting can be changed at runtime with the JMX attribute 'FinalActionsMax'.

workflow.server.remote-action-handler
Type String
Default com.coremedia.cotopaxi.workflow.BuiltInRemoteActionHandler
Description

The remote action handler.

workflow.server.retry-final-actions.delay.initial
Type Duration
Default 1s
Description

The initial time interval to wait before retrying the execution of a workflow final action after it failed for the first time. The value must be >= 1 millisecond. The initial interval is multiplied with the configured multiplier for each retry attempt (exponential back-off) until the configured maximum has been reached. This setting is ignored if the exception provides a different value in method RetryableActionException#getDelayBeforeRetry.

workflow.server.retry-final-actions.delay.max
Type Duration
Default 1h
Description

The maximum time to wait before retrying a failed execution of a workflow final action. The duration must be larger or equal to the specified initial time to wait. This setting is ignored if the exception provides a different value in method RetryableActionException#getDelayBeforeRetry.

workflow.server.retry-final-actions.delay.multiplier
Type BigDecimal
Default 2
Description

Multiplier for exponential back-off. The value must be >= 1.0. This setting is ignored if the exception provides a different value in method RetryableActionException#getDelayBeforeRetry.

workflow.server.retry-final-actions.delay.random-factor
Type BigDecimal
Default 0.1
Description

Factor to randomize the effective delay. The value must be >= 0.0 and < 1.0. Use 0.0 for no randomization. For example, a value of 0.1 creates effective delays in the range of plus/minus 10 percent of the computed delay. This also means that the actual delay can be up to 10 percent above the configured max value. This setting is ignored if the exception provides a different value in method RetryableActionException#getDelayBeforeRetry.

workflow.server.retry-final-actions.enabled
Type Boolean
Default true
Description

Whether the execution of workflow final actions will be retried if a com.coremedia.cap.workflow.plugin.RetryableActionException was thrown. If set to false, retries after these exceptions are disabled completely and this cannot be overridden in the implementation of the RetryableActionException. This setting can be changed at runtime with the JMX attribute 'FinalActionsRetryEnabled'.

workflow.server.retry-final-actions.max-retries
Type Integer
Default -1
Description

The maximum number of retry attempts, after a final action has failed with a com.coremedia.cap.workflow.plugin.RetryableActionException for a finished process instance. When the maximum number of retry attempts is reached, then the action will be skipped and the process instance will be deleted without successful execution of the failed final action. A value of -1 means unlimited retries. A value of 0 disables retries. This setting is ignored if the exception provides a different value in method RetryableActionException#getMaxRetries.

workflow.server.session.reaper-timeout
Type Integer
Default 60
Description

The interval of the session reaper checks.

workflow.server.session.timeout
Type Integer
Default 300
Description

The timeout until an inactive session is closed.

workflow.server.standalone
Type String
Description

Possible values: 'true'|'false'|'embedded'

workflow.server.sweeper.concurrent
Type Boolean
Default false
Description

The concurrent sweep mode.

workflow.server.sweeper.delay
Type Long
Default 0
Description

The sweep delay.

workflow.server.termination-timeout-seconds
Type Integer
Default 30
Description

Timeout for waiting on running threads on shutdown

workflow.server.tx.idletimeout
Type Integer
Default 30
Description

Transaction handler idle timeout.

workflow.server.tx.max
Type Integer
Default 20
Description

Limits the maximum number of database connections.

workflow.server.tx.retry-on-connection-loss
Type Boolean
Default false
Description

If 'true', will retry failed transactions due to a database connection failure. Before retrying, the DB connection will be renewed. This can also be useful in clustered databases to cope with failover switch.

workflow.server.tx.retry-on-connection-loss-delay
Type Duration
Default 15s
Description

Time to wait before a new attempt is made after a transaction failed due to database connection failure. Must be larger than zero.

workflow.server.tx.retry-on-read-only-db
Type Boolean
Default false
Description

If 'true', will retry failed transactions due to a read-only database. Before retrying, the DB connection will be renewed. This can be useful when running on a clustered database (e.g., Amazon Aurora) that dynamically assigns writer and reader instances to cope with failover switch. This is currently only supported on MySQL and MariaDB.

workflow.server.tx.retry-on-read-only-db-delay
Type Duration
Default 5s
Description

Time to wait before a new attempt is made after a transaction failed due to a read-only DB. Must be larger than zero.

workflow.server.uapi.connect-retry-delay-seconds
Type Long
Default 10
Description

The delay in seconds the Workflow Server waits between retries to connect to the Content Server when starting.

workflow.server.uapi.session-pool.max-idle-count
Type Integer
Default 1000
Description

The maximum number of idle sessions to keep in the Content Server session pool.

workflow.server.uapi.session-pool.max-idle-time-m-s
Type Long
Default 60000
Description

The time in milliseconds after which an idle session of the Content Server session pool should be closed.

workflow.server.uapi.session-pool.max-open-count
Type Integer
Default 1000
Description

The maximum number of sessions to hold at any time (busy + idle) in the Content Server session pool.

workflow.serviceindicator
Type String
Description

The server's service indicator

workflow.user
Type String
Default workflow
Description

Define a user for the connection with the Content Management Server.

workflow.working-dir
Type String
Default var/tmp
Description

Working directory of the workflow-server used to handle custom classes uploaded to the server. Path can be absolute or relative to user.dir system-property.

Table 3.31. Workflow Server Properties


Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.