UnLock

The UnLock activity is used to clear the lock on the tuple with a specified key. Only the thread that locked the tuple can clear the lock on the tuple.

General

In the General tab, you can specify the activity name, a space connection, and whether to enable the Aysnc Operation option.

The following table describes the fields in the General tab of the UnLock activity:

Field Module Property? Description
Name No Specifies the name to be displayed as the label for the activity in the process.
Space Connection Yes Click the icon to select a space connection that defines how the application joins the space.

Tuples are unlocked in the space with the defined distribution role of the selected space connection.

If no matching space connections are found, click Create Shared Resource to create one. See Creating a Metaspace Connection for details.

Async Operation No Select this check box to enable the asynchronous operation. After this check box is selected, the SpaceResultHandler activity is triggered. This check box is not selected by default.

Description

In the Description tab, you can enter a short description for the UnLock activity.

Advanced

In the Advanced tab, you can specify the amount of time that an Unlock operation waits.

The following table describes the fields in the Advanced tab of the UnLock activity:

Field Module Property? Description
Lock Wait(milliseconds) Yes Specifies the amount of time in milliseconds an Unlock operation waits for the lock to be cleared if the tuple has been locked.

The value of the Lock Wait(milliseconds) field overwrites the value in the Lock wait (milliseconds) field, which is specified in the Advanced tab of the Space shared resource. The default value of -2 or a null value indicates that the value set in the Lock wait (milliseconds) field is not overwritten.

Space Result Handler Key Yes Specifies the key of the SpaceResultHandler activity, which is used for the asynchronous operation.

This field is displayed only when you select the Async Operation check box in the General tab of the UnLock activity.

Input

In the Input tab, you have to provide the key values of tuples to be unlocked in the space.

Note: You have to input all the keys specified in the space. Nullable keys are optional.

The following table describes the fields in the Input tab of the UnLock activity:

Input Item Data Type Description
The following fields are the child fields of the UnLockOptions node.
lockWait Integer Indicates the amount of time in milliseconds that the unlock operation waits for the lock to be cleared if the tuple has been locked. The value of the lockWait field overwrites the value in the Lock wait (milliseconds) field, which is specified in the Advanced tab of the Space shared resource.
Note: The default value of -2 or a null value indicates that the value set in the Lock wait (milliseconds) field is not overwritten.
spaceResultHandlerKey String Indicates the key of the SpaceResultHandler activity, which is used for the asynchronous operation. The value of the spaceResultHandlerKey field overwrites the value in the Space Result Handler Key field, which is specified in the Advanced tab of the UnLock activity.
Note: This field is displayed only when you select the Async Operation check box in the Configuration tab.
Closure Any of the following data types:
  • Boolean
  • Char
  • Short
  • Integer
  • Long
  • Float
  • Double
  • Blob
  • String
  • Datetime
Indicates the closed data transferred to the SpaceResultHandler activity during the asynchronous operation.

This field is displayed only when you select the Async Operation check box in the Configuration tab of the UnLock activity.

Output

In the Output tab, you can find the operation results.

The following table describes the fields in the Output tab of the UnLock activity:

Output Item Data Type Description
The ResultList node contains the following fields:
HasError Boolean Indicates whether the results have errors.
  • The value is true when one or more results have errors.
  • The value is false when no error occurs.
Result Any of the following data types:
  • Boolean
  • Char
  • Short
  • Integer
  • Long
  • Float
  • Double
  • Blob
  • String
  • Datetime
Indicates the results that contain the following items:
  • Status: The ActiveSpaces status code returned by TIBCO ActiveSpaces functions. See TIBCO ActiveSpaces Java API Reference for more information.
  • Tuple: This field lists the tuples that have been unlocked in the associated space. A result list can contain one tuple or none.
  • HasError: (Boolean value) The value of true indicates that an error is returned. The value of false indicates that no error is returned.
  • Error: The error returned by TIBCO ActiveSpaces during the tuple processing.

Fault

In the Fault tab, you can find the error code and error message of the Unlock activity. See Error Codes for more detailed explanation of the errors.

The following table describes the errors in the Fault tab of the UnLock activity:

Error Schema Element Data Type Description
msg String The TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces error message.
msgCode String The TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces error code.
ASStatus String The status code returned by TIBCO ActiveSpaces functions.

See TIBCO ActiveSpaces Java API Reference for more information.