Skip to main content

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

Creating a toggle

Updated on November 15, 2021

To enable or disable functionality that is under development, or to control access to a feature, create a toggle. When you create a toggle, a when rule for the toggle instance is created by default.

You can also associate a toggle instance with an external project management application, so that you can identify and remove toggles after development is complete.

  1. In the header of Dev Studio, click ConfigureSystemReleaseToggles.
  2. Click Create new toggle.
  3. Complete the following fields to configure the toggle for your application.
    • Application context – Select the application for which you want to create a toggle. By default, the toggle is associated with the rulesets in this application.
    • Toggle identifier – Enter a unique identifier for the toggle. This identifier cannot contain spaces or special characters.
    • Optional: Description – Enter a description for the toggle.
    • External ID – Enter the epic ID that is associated with this toggle. This field is required if you have the Project Management Framework (PMF) enabled for the Pega Platform. If you are not using PMF or another project management application, or if you are using a third-party project management application, this field is optional.
  4. Select the users to whom the toggle applies. Although you can select more than one option, the option that is more inclusive supersedes the other options.
    • Enable toggle for all – Select this option to apply the toggle to all users of the application.
    • Only my access group – Select this option to apply the toggle to all users in your access group.
    • Only myself – Select this option to apply the toggle to the logged-in operator.
  5. Select the development branch and application ruleset to which the when rule for the toggle applies. These options are available when the Toggle will be referenced by rules check box is selected. This check box is selected by default. You can use the when rule to enable or disable functionality while it is being developed and tested.
    If you clear the Toggle will be referenced by rules check box, a when rule is not created for the toggle. Instead, you can manage the toggle by using the toggle data instance in the rules of your application.
  6. Click Submit.
  • Reviewing and editing toggles

    To keep the list of available toggles accurate, review, edit, and potentially delete the toggles in your applications. For example, at the end of a release you can review and delete the toggles that you want to retire.

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