Lock: acquire

Plugin ID: eca_lock_acquire

Available since: 1.1.0

Acquires a lock.

Fields

Lock name — config key: lock_name

The name identifies a lock, that may be shared by multiple processes. The lock will be automatically released when this ECA process is finished.
This field supports tokens.

Type: textfield · Required: yes · Default: empty string

Lock timeout in seconds — config key: lock_timeout

This timeout is used as a maximum time threshold. When exceeded, the lock is automatically released for other processed again.
This field supports tokens.

Type: number · Required: yes · Default: 20

Wait for lock until timeout exceeded — config key: lock_wait

When checked, this action automatically retries acquiring the lock, until the specified timeout above exceeded.

Type: checkbox · Required: no · Default: true

Name of token — config key: token_name

Optionally define a token name to store the result of lock acquisition. The result value is 1 when acquisition was successful, and is set to 0 when it was not successful. Please provide the token name only, without brackets.

Type: textfield · Required: no · Default: empty string