Understanding checkouts and your personal ruleset

A checkout is a private copy of a Rule- instance that you update and later check in to replace a base rule version. All checked out rules reside in a ruleset that is only visible to your operator known as your personal ruleset.

Two types of checkouts are supported: standard checkout and private checkout.

How to check out

Before you start, verify that your operator allows rule checkout and the rule resides in a ruleset with checkout enabled. Use buttons in the rule form header to perform a checkout:

1. Click Check out. A copy of the original or base rule is placed in your personal ruleset. All other users are blocked from checking out this rule until you check in your changes.
2. Update the rule as needed.
3. Click Save. Your changes are saved into the checked-out version and are only visible to you. When you run rules in your application, they resolve to your checked-out version.
4. Click Check in to replace the base rule with the version in your personal ruleset. If approval is not required, your changes immediately affect rule resolution and run time behavior for all users.

You are not required to check in your changes immediately. You can log off and return to a checked-out rule later or click Discard to remove the rule from your personal ruleset.

The standard checkout option is not available when a rule resides in a locked ruleset version or is checked out by another user. For these cases, use a private checkout to work on a rule.

When you check in, you can optionally link your development changes to items in to your PMF worklist.

How to private check out

The Private edit option is available when your operator has the pxAllowPrivateCheckout privilege. A private checkout is like a standard checkout except it does not block checkouts for other users. This option is good for quick debugging without interrupting development by other team members.

Use buttons in the rule form header to perform a private checkout:

1. Click Private Edit. A copy of the original or base rule is placed in your personal ruleset. Another user can concurrently perform a standard checkout if the base rule resides in an unlocked ruleset version.
2. Update the rule as needed.
3. Click Save. Your changes are saved into the checked-out version and are only visible to you. When you run rules in your application, they resolve to your checked-out version.
4. Click Check in.
5. Select a Destination for your checked-in version:
• Ruleset — click this radio button and keep the default Ruleset name to replace the base rule with your checkout. Alternatively, click this radio button and select a different Ruleset name to create a new rule.
• Branch — click this radio button and select an unlocked Branch name to copy your version into a branched ruleset.

Like standard checkouts, you are not required to check in your changes immediately and can optionally link development changes to items in to your PMF worklist. Private checkouts also support check-in approval.

Note: When you check in, you are warned if the base rule has been updated since the time you performed the private checkout. As a best practice, work with the user who updated the base rule last to resolve and merge any conflicts. Otherwise, your checked-out version will overwrite the latest version.

Tips

• Use My Checkouts or the Private Explorer to view all rules checked out by you.
• Use the Application Development landing page to view all checked-out rules. Rules checked out using the Private edit option do not appear in this list.
• Use the restore feature to undo changes made by a checked-in version.
• Use the Rule-.SetApprovalDependency activity to override the default check-in procedure.
• Use the lock icon to see who has a specific rule instance checked out.
• Select the View version > Checked out from [version number] option in the Actions menu to view your checked-out rule's base version.

Notes

• It is possible for a checked-in version to have validation errors. This can happen when ruleset pre-requisites change or a referencing rule is relocated. When you perform a standard checkout, the validation errors appear in the rule form header. You must resolve all errors and save before you can check in any new changes.
• You cannot check out a base rule when you or another developer has a circumstanced version checked out.
• The following rule types are always available for edit (do not support checkout):

  Application Class Ruleset Version

  Library Agent System Settings

	check in, personal ruleset, Project Management Framework
	Using the rule check in approval process Working with My Checkouts and Bulk Actions

Designer Studio basics

Open topic with navigation