Skip to end of metadata
Go to start of metadata


You can use locks to prevent a job starting while another job is running. You can find the information about locks at

Locks are defined in files in the hot folder (live). Lock file names follow the convention:

  • the name of the lock followed by .lock.xml.
    E.g. lockSample.lock.xml

To use locks, you have to:

  1. declare a lock
  2. assign the lock to the required jobs


A typical lock declaration would be:

To assign the lock to your jobs use:

Two job chains using the jobs

Scope of locks

  • Where are lock files saved?
    • Locks are stored directly in the live folder or any sub-folders.
  • How do you reference locks in jobs?
    • Locks are identified by their path:
      • this is made up of the folder where the lock is stored and of the name of the lock.
    • Locks that are located in the same folder as the job can be addressed using the lock's name (omitting the folder).
  • Example:
    • Lock Location
      • Folder live/project_a contains a set of jobs and a lock named my_lock_a
      • Folder live/project_b contains a set of jobs and a lock named my_lock_b
    • Lock Usage
      • job_a from the folder named project_a can reference the lock from its folder using for example:
        • <lock.use name="my_lock_a" exclusive="true"/> 
      • Job job_b from folder project_b can be configured to use its local lock in a similar manner. 
      • Should it be necessary to prevent jobs job_a and job_b from runnig in parallel then they have to use a common lock. This is achieved by referencing a common lock, e.g. job job_b could use a reference to my_lock_a from the folder project_a like this:
        • <lock.use name="/project_a/my_lock_a" exlcusive="yes"/>
      • Caveat: It is possible to use the same lock name in different folders to represent different locks. Jobs using relative lock addressing (i.e. just the locks' name) and omitting the folder name would reference the lock in their local folder. Consider using absolute lock addressing if you want jobs from different folders to make use of the same lock. 
      • Hint: Locks that are located directly in the live folder can be addressed with a leading slash as follows:
        • <lock.use name="/my_global_lock" exclusive="yes"/>