Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

How to use the Lock and Roll feature for managing RuleSet Versions

Updated on September 10, 2021


The RuleSet Stack gadget simplifies following the best practices of RuleSet locking and application versioning.  The gadget provides a summary of the locking status of the RuleSet versions in your application, as well as the Lock and Roll button.

Suggested Approach

Best practices for RuleSet versioning include:

  • Only the highest version of a RuleSet should be unlocked.
  • All development should occur only in the highest version.
  • Once locked, a RuleSet version should not later be unlocked.

In addition, a RuleSet version can not be locked if any rules in that version are checked out.


  1. Click the Pega Button and select Pega button> Application > Structure > RuleSet Stack.
  2. Observe the icons in the Current Application section, under the Locked column.RulSet List
  • If the column contains a locked (Locked Icon) or unlocked (Unlocked Icon) icon, and there are no rules currently checked out, then the RuleSet is ready for you to use the Lock and Roll function.
  • If the column contains an unlocked warning (Unlock Warning Icon) icon, then a version lower than the highest is unlocked. You will be able to use the Lock and Roll function on this lower RuleSet version to lock, but not to roll (increment). Click the unlock warning icon to view a list detailing the currently unlocked versions. Once the lower versions are locked, you can again use the roll portion of the Lock and Roll function on the highest RuleSet version.
  • If  the column contains a warning icon (Warning Icon), then the RuleSet version does not exist, but is included in your application. Check your application to determine if the version of the RuleSet was incorrectly entered, or if the RuleSet was incorrectly entered. Once this error is corrected, then you can run the Lock and Roll function on this RuleSet version, if needed.
  • Click the Lock and Roll button. The Application Lock and Roll window appears.Application Lock and Roll
  • In the Lock column, check the box next to the RuleSets which are to be locked. If a RuleSet is currently locked, has a lower unlocked version, or does not exist, the corresponding icon will appear instead of a checkbox.
  • In each unlocked RuleSet you selected for locking, a text box appears under the Password column.  Enter a password for the RuleSet version. Note that the password entered in the Password text box will appear in plain text to ensure the password is entered correctly.
  • In the Roll column, check the box next to the RuleSets which are to be rolled to a higher version. If the RuleSet is not locked or selected to be locked, the check box for this RuleSet will not be available.
  • Observe the value in the Roll to Version column. By default, the value in this column will be the next highest patch version from the current RuleSet. If you are rolling a selected RuleSet is to a higher minor or major version, change this value to the appropriate version number.
  • Select the Application update option from the list below the RuleSets appropriate for the environment in which your development is taking place. For more information on these options, see the Application Structure help topic.
  • Click the Run button.
  • You may need to log out and back in to the application before the new version of any incremented RuleSets become visible.


    Have a question? Get answers now.

    Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

    Did you find this content helpful?

    Want to help us improve this content?

    We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

    Close Deprecation Notice
    Contact us