Workflow Queue Cleanup Command Line Utility
The Workflow Queue Cleanup command line utility allows you to delete unused workflow queues that have been configured for queue pooling or have been configured as dedicated queues. This is particularly helpful if there are unused queues requesting database connections.
The utility performs the following checks when validating whether to delete a queue:
• Check any existing queue entries for the workflow queue that has been specified in the search string to be deleted. If there are any queue entries for a queue, it is not deleted.
• Search for any open processes associated with the queue that has been specified in the search string to be deleted. If there are any open processes associated with a queue, it is not deleted.
If a queue does not have any existing queue entries or open processes, the utility stops the queue, disables it, and then deletes it.
If a new queue entry is created for a queue that has been deleted with this utility, the deleted queue is restored.
 |
PTC recommends that you manually stop and disable the queue that is to be deleted before running the workflow queue cleanup utility.
|
Running the Workflow Queue Cleanup Utility
Run the following command in a Windchill shell using administrative credentials:
windchill wt.workflow.utility.WfQueueCleanup -match=<SearchString> -user=<AdminID> -password=<Password> -delete
A WFQueueCleanup_<E_MMM_dd_yyyy_HH_mm_ss_ms>.log file is generated in the <Windchill>\logs folder.
Arguments are not required. However, the following are available:
|
-match=<string>
|
Search for matching workflow queues:
• Use an asterisk (*) for wildcard searches.
• The utility only searches against workflow queues that are configured for queue pooling or configured as dedicated queues.
These queues use the following naming scheme:
◦ WfSharedPropagationQueue<number>
◦ WfSharedUserWorkQueue<number>
◦ WfPropagationQueue_<identity>
◦ WfUserWorkQueue_<identity>
If no search string is included, all workflow queues that are configured as dedicated queues or configured for queue pooling are returned.
If the -delete option is not included, a report is generated in the <Windchill>\logs folder that lists the matching workflow queues. If the -delete option is included, matching workflow queues are deleted.
|
|
-user=<ID>
-password=<password>
|
Administrator credentials.
If this argument is not specified in the command, you receive a prompt to supply user credentials.
|
|
-delete
|
Include this argument to delete unused workflow queues that match the search string provided in the -match argument.
If this option is not included, a report is generated in the <Windchill>\logs folder that lists the matching workflow queues.
Only queues that have no associated open processes or pending queue entries are deleted.
|
|
-usage
|
Display a list of valid options.
|