Clearing Locked Work Queue Items

The following command instructs the iProcess background process to perform an instruction. This is a command line option only.

Note 

This command requests confirmation from the user (with an “Are you sure you want to do this” message), but this may be suppressed with a -y flag on the end of the command line enabling it to be run from a batch file.

You can unlock work queue items that have been marked as locked by a user and not unlocked after use. A work item is locked when it is opened. The iProcess Suite uses two types of lock:

• Short lock  This is the standard lock normally set by TIBCO iProcess Workspace. A short lock is removed when a user keeps or releases a work item. In the event that short locks are left behind because, for example, the iProcess Workspace crashed, the only way to remove the short lock is to re-start the iProcess Engine or use the following command.
• Long lock  A lock that is persistent and can only be removed using sal_llock_frm_init() by the user holding the lock. Long locks are not normally used by TIBCO iProcess Workspace, but may be set by SAL SDK programs or the TIBCO iProcess Objects Client. Re-starting the iProcess Engine has no effect on long locks, so a work item locked in this way remains inaccessible to every iProcess user until it is manually unlocked.

To unlock a work item, use the following command. You must have a MENUNAME of ADMIN to be able to use this command. See "Managing iProcess Users" in TIBCO iProcess Workspace (Windows) Manager's Guide for more information about iProcess attributes.

swutil UNLOCKMAIL queuename reqid:hostname [/t]

where:

• queuename is the work queue that contains the work item you want to unlock. Either specify a queue name or use:
— ALL  to specify all work queues.
— $UNDELIV   to specify the Undelivered Work Items queue.

Note 

As well as being logged in as the IPEADMIN user, to use this option you must have access to the specified work queue. (To access a group queue, you must be either a member of that queue or a participant. To access another user’s queue, you must be a participant of that queue.)

• reqid:hostname is the unique identifier (for example, 10245:node1) of the work item that you want to unlock.

Note 

You can find the reqid and hostname values by using the command plist –mv queuename. The value for reqid is displayed under the RQID heading and the value for hostname is displayed under the Host heading.
• /t is an optional parameter which should be used if queuename is a test queue.

The swutil UNLOCKMAIL command returns the following error codes:

Error Code

Description

0

No error item unlocked successfully

4

Invalid parameter(s) supplied

6

Internal system error

7

Specified work item was not locked

11

One of the following happens:

• Specified work item could not be found in queuename.
• queuename is invalid.
• You do not have access to queuename.

64

You do not have ADMIN as your MENUNAME