Application Structure landing page

The Application Structure landing page helps you manage and understand the rulesets, rules, access groups and operators that make up your application. Additional options quickly show you referencing applications, allow you to invite collaborators to the development process, and (for those with permission) give you access to other applications on the system.

Access this landing page by selecting the > Application > Structure menu item.

The following tabs are available on this landing page:

Ruleset Stack
Ruleset Prerequisites
Referencing Applications
Access Groups & Users
Other Applications

Ruleset Stack tab

This tab lists the rulesets and ruleset versions that make up your current application including those inherited from any built-on applications. It also allows you to lock versions and roll (increment) them to higher versions.

The display is organized by Current Application followed by the Built on Application(s) and is filtered by ruleset and version, lock status, total number of rules, and number of checked out rules.

To open an application rule in the list, click its name.

Field	Description
RuleSet	The rulesets and versions in the application. To open a ruleset, click its name.
Lock	Contains an icon indicating the lock status of ruleset versions for the application. — Indicates that the version for any given ruleset is locked. Also indicates a locked application rule. — Indicates that the version for any given ruleset is unlocked. Also indicates an unlocked application rule. — Warns you that a locked ruleset version has lower unlocked versions. Click the icon to view a list that shows you which versions are unlocked. To lock an unlocked version, select it in the list, and its rule form opens where you can lock the version. As a best practice, leave only the highest version of a ruleset unlocked. If the warning condition exists, you cannot roll (increment) a lower unlocked version using Lock and Roll functionality. — Warns you that this ruleset version does not exist but appears in your application rule. To correct, remove the version. Click an icon to open a window that displays a list of versions, and for each version, the lock status and the number of total and checked out versioned and non-versioned rules such as ruleset, class, organization instances, and so on.
Checked Out	The total number of checked-out versioned and non-versioned rules.
All Rules	The total number of versioned and non-versioned rules. Click a number to open a window listing the rule types and counts comprising the total. Click a row (including Total) in the list to drill down to a list of rule instances comprising a rule type.
Lock and Roll	Click to display the Application Lock and Roll window where you can review, lock current ruleset versions, and roll (increment) versions in a single step. You can optionally update your current application rule to reflect the new versions, or create a new application rule that contains the new ruleset versions.
Package and Export	(For the Current Application only.) Click to start the Application Package wizard, to create a product rule for this application. See About the Application Package wizard.

In the window, select the application ruleset versions you want to lock and roll to a higher version.

Field	Description
Lock	Check the check box to indicate you want to lock the ruleset version and roll to a new version. Locking prevents a developer from saving new rule instances to this version, or updating or deleting existing instances. A icon appears if there is a condition that might prevent you from locking the ruleset version. For example: A higher locked version exists or a version currently has rules checked out. A icon appears if the ruleset version is already locked.
RuleSet Version	The ruleset and current version. Click next to the Prerequisites label to display the Current and New prerequisites for the version. To open the rule form for a current ruleset and version, click its name in the Current list. When you lock a ruleset version and select the Roll check box, you can modify the new prerequisites. By default, they are the same as the current ones. You can select different prerequisites, add additional ones, and delete ones from the New list. To add another ruleset version to the list, click . To open the rule form for a ruleset in the New list, click next to its name. To delete a ruleset from the New list, click next to its name.
Password	Appears when you select the Lock check box. Enter the password for the ruleset Version.
Roll	Displays when Lock is checked. Check if you want to roll the ruleset to a higher version.
Roll to Version	Displays the version that the ruleset will be rolled to unless you indicate another version number. Defaults to the next logical number in the ruleset numbering sequence.
Description	Current description of the ruleset version.
Run	Select an option to run against the selected ruleset versions. Do not update my application — Locks and rolls the versions without updating the application RuleSet list. Update my Application to include the new RuleSet Versions — Locks and rolls the versions and updates the current application ruleset list. Prompts with an application description (current by default, which you can edit). Also prompts for a password if the current application is locked. Enter the application password. Create a new version of my Application — Locks and rolls the versions and creates a new application rule. Prompts with the new application version (one increment higher by default, which you can edit), and with an application description (current by default, which you can edit). Also prompts for a password if the current application is locked. Enter the application password.

Ruleset Prerequisites tab

This tab displays a tree view of rulesets and versions and their prerequisites in the current application.

Click to expand the tree to show the prerequisite rulesets and versions. A version in blue text indicates that it is listed as a top-level version in the application ruleset list.
Click the name of a ruleset in the tree to open and view its ruleset form.
Rulesets using Application-Based Validation (ABV) do not have prerequisites.

Referencing Applications tab

This tab lists other applications that reference the current application.

Field	Description
Name and Version	This (referencing) application name and version.
Access Groups	The total number of access groups associated with this application.
Operators	The total number of operators associated with the access groups.
RuleSet	This application ruleset.

Access Groups & Users tab

Use this tab to:

See the list of access groups that provide access to the current application.
See the list of users that belong to an access group.
Invite people to collaborate in developing this application.

Field	Description
Invite Collaborator	Click to invite people (via email) to collaborate in developing the application. For example, a Lead Business Analyst can invite other business analysts to edit and add specifications and requirements to the in-progress application. They might also invite subject matter experts to review the specifications. Upon clicking the link, the Invite Collaborator window opens for you to specify the information needed to send email invitations to the invitees. See Invite Collaborator window — Inviting collaborators.
Access Group	The name of an access group referenced by the application. Select a name to see the list of users that reference that access group, and so have that level of access into the application.
Operator Name	The names of operators who reference the access group.
Operator ID	The IDs of operators who reference the access group.

Other Applications tab

Administrators (operators with the PegaRULES:SysAdm4 role or a role based on that role) can use this tab to lock and roll applications in the Pega 7 system other than those in the ruleset Stack of the current application. For example, when upgrading a Pega 7 it is considered best practice to lock all applications and create new ruleset versions before resuming development.

This page displays all applications in the system that contain an unlocked ruleset version and lists the rulesets and ruleset versions that make up each application including those inherited from any built-on applications.

To open an application rule in the list, click its name.

Field	Description
RuleSet	The rulesets and versions in the application.
Lock	Contains an icon indicating the lock status of ruleset versions for the application. — Indicates that the version for any given ruleset is locked. Also indicates a locked application rule. — Indicates that the version for any given ruleset is unlocked. Also indicates an unlocked application rule. — Warns you that a locked ruleset version has lower unlocked versions. Click the icon to view a list that shows you which versions are unlocked. To lock an unlocked version, select it in the list, and its rule form opens where you can lock the version. As a best practice, leave only the highest version of a ruleset unlocked. If the warning condition exists, you cannot roll (increment) a lower unlocked version using Lock and Roll functionality. — Warns you that this ruleset version does not exist but appears in your application rule. To correct, remove the version. Click an icon to open a window that displays a list of versions, and for each version, the lock status and the number of total and checked out versioned and non-versioned rules such as ruleset, class, organization instances, and so on.
Checked Out	The total number of checked-out versioned and non-versioned rules.
All Rules	The total number of versioned and non-versioned rules. Click a number to open a window listing the rule types and counts comprising the total. Click a row (including Total) in the list to drill down to a list of rule instances comprising a rule type.
Lock and Roll	Click to display the Application Lock and Roll window where you can review, lock current ruleset versions, and roll (increment) versions in a single step. You can optionally update your current application rule to reflect the new versions, or create a new application rule that contains the new ruleset versions.

In the window, select the application ruleset versions you want to lock and roll to a higher version.

Field	Description
Lock	Check the check box to indicate you want to lock the ruleset version and roll to a new version. Locking prevents a developer from saving new rule instances to this version, or updating or deleting existing instances. A icon appears if there is a condition that might prevent you from locking the ruleset version. For example: A higher locked version exists or a version currently has rules checked out. A icon appears if the ruleset version is already locked.
RuleSet Version	The ruleset and current version. Rulesets using Application-Based Validation (ABV) do not have prerequisites. Click next to the Prerequisites label to display the Current and New prerequisites for the version. To open the rule form for a current ruleset and version, click its name in the Current list. When you lock a ruleset version and select the Roll check box, you can modify the new prerequisites. By default, they are the same as the current ones. You can select different prerequisites, add additional ones, and delete ones from the New list. To add another ruleset version to the list, click . To open the rule form for a ruleset in the New list, click next to its name. To delete a ruleset from the New list, click next to its name.
Password	Appears when you select the Lock check box. Enter the password for the ruleset version.
Roll	Displays when Lock is checked. Check if you want to roll the ruleset to a higher version.
Roll to Version	Displays the version that the ruleset will be rolled to unless you indicate another version number. Defaults to the next logical number in the ruleset numbering sequence.
Description	Current description of the ruleset version.
Run	Select an option to run against the selected ruleset versions. Do not update my application — Locks and rolls the versions without updating the application ruleset list. Update my Application to include the new RuleSet Versions — Locks and rolls the versions and updates the current application ruleset list. Prompts with an application description (current by default, which you can edit). Also prompts for a password if the current application is locked. Enter the application password. Create a new version of my Application — Locks and rolls the versions and creates a new application rule. Prompts with the new application version (one increment higher by default, which you can edit), and with an application description (current by default, which you can edit). Also prompts for a password if the current application is locked. Enter the application password.