lock

A lock secures an object or ruleset version to prevent changes.

Several locking mechanisms are available:

• You can lock a ruleset version with passwords, preventing any changes to the rules associated with that ruleset or version.
• A requestor can acquire temporary exclusive access to an instance, preventing other requestors from updating or deleting it.
• You can lock an application rule (Rule-Application rule type) with a password, preventing others from changing that rule instance until they enter the password.

Ruleset version locking

When a rule belongs to a locked ruleset version, a lock icon appears at the upper left of the form.

Securing a ruleset or ruleset version is reversible. A password might be required to unlock a locked rulesetor ruleset version.

Object locking

A requestor can lock an open instance if the instance belongs to a concrete class that has Allow Locking? selected in the class rule, and it has ever been saved and committed to the PegaRULES database. Locks are retained until a Commit method occurs.

Object locks are implemented separately from the locking mechanism supplied by the database software (such as Oracle) that supports the PegaRULES database.

To view object locks held by your own requestor session, select Designer Studio > Process and Rules > Tools > Work Admin > My Locks.

Testing for locks

To test whether a work item is locked, an activity can call the standard activity Work-.WorkLock, which attempts to lock the work item. If it fails to acquire a lock, the SuccessInfo parameter is negative, indicating that the work item is already locked. The FailureInfo parameter provides additional detail.

To test whether an object (other than a work item) is locked, use one of several methods in the PublicAPI LockManagerInterface.

Related terms

Open topic with navigation