Acquire Lock
This step acquires a lock on a specified string value. You can use locks to prevent concurrent modification of resources.
Tip:
Applications, components, and generic processes share some process steps. This step applies to application processes, component processes, and generic processes. This step applies to application processes that are associated with application templates.
Upon reaching this step, the process searches for the lock with the specified name and
proceeds as follows:
- Evaluates the lock status: If the lock already exists and the Fail if Lock Exists option is selected, the step fails.
- Creates the lock: If the step does not fail and the lock does not already exist, the process creates the lock.
- Acquires the lock: If no other process is using the lock, the step continues. If the lock is currently in use, the process waits until the lock is released before proceeding.
To release the lock, use the Release Lock step. Also, locks are released automatically when the process finishes. If multiple processes are waiting for the same lock, when the lock is released, the server selects the process that made the earliest request to acquire the lock.
Note: You
can see the active locks by clicking .
| Field | Description |
|---|---|
| Lock Name | A string value that identifies the lock.
Note: Lock Name character limit is 4000.
|
| Fail if Lock Exists | Select this checkbox to fail the step immediately if a lock with the specified name has already been created. |