Specialized Administration > Site Maintenance > Queue Management > Understanding Background Queues > Background Queue Details > Configuring Background Queues and Related Properties
Configuring Background Queues and Related Properties
This section describes how to configure a background method server, the properties for background queues, background queue logs, and other related properties.
Configuring Method Servers for Background Queues
The Windchill property settings allow you to configure a separate method server dedicated to running background queues.
To start up two method servers where one is dedicated to executing background queue entries, use the xconfmanager to ensure that the following properties in wt.properties are set:
#Services to be monitored by the StandardServerMonitor
wt.manager.monitor.services=MethodServer BackgroundMethodServer

#Number of Servers to start
wt.manager.monitor.start.MethodServer=1
wt.manager.monitor.start.BackgroundMethodServer=1

#Queue default execute setting
wt.queue.executeQueues=false
Setting wt.queue.executeQueues=false ensures that queue entries do not execute on the method servers. To override this setting for the background server you want dedicated to executing background queue entries, set the same property to true on the startup command for the background server. This property is set to true for the default background method server.
Under most circumstances, a single background method server is sufficient for processing background queues. If your site requires high availability of queue processing or you just want multiple background method servers for processing queue entries, you can set up multiple background method servers and then establish queue groups on each method server.
For information about setting up high availability queue processing, see High Availability Queue Processing.
For information on setting up multiple background method servers and queue groups, see Configuring Background Method Servers.
Background Queue Properties
The properties in the following table are defined in the wt.properties file. Use the properties described in the table to configure background queues:
Property
Description
wt.manager.cmd.param.5
Globally defines queue groups to a method server when running a single background method server.
Default is Default.
For additional information, see Configuring Background Method Servers.
wt.manager.cmd."+ServiceName+"param.5
Assigns queue groups for a specific background method server (ServiceName) when running more than one background method server.
For additional information, see Configuring Background Method Servers.
wt.queue.execEntriesCount
Specific to process queues, defines the number of entries queried from the queue to be executed. This property also controls the thread pool size for pool queues if not specifically defined for these queue types.
Default is 6.
wt.queue.executeQueues
Establishes whether a method server is used to execute background queues. Set this property to false when you do not want a method server to execute any background queues. Setting this property to false overrides any wt.queue.queueGroup property that is set.
Default is false.
wt.queue.max.processQueues
Sets the maximum number of process queues that the queue service creates before throwing an exception.
Default is 25.
wt.queue.max.scheduleQueues
Sets the maximum number of schedule queues that the queue service creates before throwing an exception.
Default is 16.
wt.queue.PoolQueue."+queueName+".threadPoolSize
Specific to pool queues, defines the number of entries queried from the queue to be executed. This property also controls the size of the thread pool for this pool queue. You should configure this property for existing pool queues.
wt.queue.removeCompleted
Specifies whether successfully completed entries are removed from the Windchill database. If they are not removed, they can overflow the database storage capacity.
Default is true (to remove).
If you want to retain the queue-specific property wt.queue.removeCompleted.<QueueName>, set the property to true by specifying the queue name. If you do not set the queues-specific property wt.queue.removeCompleted.<QueueName>, then the completed queueEntry in the specified queue is removed by default.
wt.queue."+queueName+".removeFailedEntries
Determines whether failed entries are automatically removed.
Default is false (to not remove).
wt.queue."+queueName+".exceptionRetries
Determines whether failed execution entries are retried. These retries occur back to back, with no wait time.
Default is 0.
Background Queue Log Properties
Logging for queues is configured using the log4jMethodServer.properties file located in codebase/WEB-INF. These properties can also be set in jConsole.
Remember that when these properties are set in the log4j file, the level of logging must be specified as one of the following values:
• TRACE
• WARN
• INFO
• ERROR
• FATAL
• OFF
Property
Description
wt.queue.processingQueue.queueName
Provides debug information specific to the actual polling threads.
Default is false.
wt.queue.queueWatcher verbose
Provides information related to the control of a specific queue. Each queue has an associated queue watcher.
Default is false.
wt.queue.scheduleQueue queueName
Provides general schedule queue information that can be used to debug problems.
Default is false.
Other Background Queue-Specific Properties
There are other Windchill properties specific to queuing. The following table includes two examples:
Property
Description
wt.index.defaultQueueInterval
Specifies the number of seconds in the time-out interval of the index queue polling thread.
Default is 60.
wt.index.useQueue
Specifies whether indexing tasks are moved to the background queue. If this property is set to false, indexing tasks are processed immediately.
Default is true.
See properties.html for descriptions of all available properties.
To add supported properties to a property file (in this case, the wt.property file) or change values for existing properties, use the xconfmanager utility. For details, see Using the xconfmanager Utility.
Was this helpful?