Policy Revisions

gateway90
The Policy Manager can keep a revision history of changes made to a policy or policy fragment. It can record when a change was made and who made it. A version number is assigned to each change. You can roll back to any version, making it the "active" policy.
 
The policy revisions feature only tracks changes to the policy XML. It will not record changes to other objects such as users, groups, private keys, certificates, or JMS connections. It will also not include changes to other service or policy properties (for example, SOAP services intended, routing to URI or WSDL location).
 
Configuring Policy Revisions
By default, the Gateway is preconfigured to store 20 versions. You can change the number of versions stored by setting the policyVersioning.maxRevisions cluster property.
A policy revision is "protected" once it is assigned a comment. This means it will never be overwritten and it does not count toward the stored revisions maximum. To remove this protection, simply delete the comment.
Creating a New Policy Revision
When policy revisions are enabled, the Policy Manager automatically creates a new revision each time you save a policy. If you wish to describe the policy, add a comment using the Policy Revisions dialog. Versions containing a comment are protected from being overwritten. Versions without a comment will be automatically overwritten when the revision limit is reached.
A new revision is created each time the policy is saved, even if no changes have been made.
Working with Policy Revisions
The title of the policy gives a concise indication of the revision in use and whether it is the active revision. Consider the following example:
image2014-10-15 16:38:22.png
This indicates that the policy has 32 revisions and revision 22, currently being edited, is the active revision.
The word "active" changes to "inactive" if the revision being edited is not the active revision.
To view policy versions:
  • In the Services and Policies list, right-click the service name or policy name and then select Revision History. The assertion properties are displayed.
    To quickly open the active version of the policy, right-click the service name and select Active Policy Assertions or double-click the service name in the Services and Policies list. The word "active" will appear next to the service name and version number above the policy window to remind you that you are working with the active version.
    The following table describes the dialog:
    Element
    Description
    Policy tree at top
    The tree shows the policy revision currently selected. This helps you better visualize each revision.
    Act.
    Indicates the version that is currently active. It is possible to have a policy with no active versions; this disables the policy.
    Vers.
    The version number, assigned by the Policy Manager. Version numbers may not be contiguous, but they will be unique.
    The number of versions stored is controlled by the policyVersioning.maxRevisions cluster property. By default, 20 "uncommented" versions are stored.
    Once a comment is entered, the version is preserved permanently and does not count against the revision limit. For example, 30 versions may be displayed even though the maximum is 20, because 10 of those versions have comments entered. To allow a version to be discarded, simply delete the comment.
    Administrator
    The person who was logged in at the time when the changes were saved.
    Date and Time
    When the version was created.
    Comment
    A description of the version. To enter a comment, click [
    Set Comment
    ]. Entering a comment is not mandatory but recommended for versions you may wish to roll back to in the future.
    (1) Revisions with comments will be protected against deletion; they will also be excluded from the maximum revisions cap. (2) Policy revisions for a policy fragment used in an encapsulated assertion may display an "Artifact Version" number. This number is automatically inserted when the encapsulated assertion configuration is imported into the Gateway. For information about the Artifact Version number, see Encapsulated Assertion Configuration Properties.
    Open in Editor
    Opens the currently selected version in a new tab within the policy development window for editing.
    The version number and its active status are displayed next to the service name in the tab for that version in the policy development window.
    Set Comment
    Allows you to enter or remove a comment for the selected version.
    Set Active
    Designates the currently selected version as the active version for the policy and loads the version into a new tab in the policy development window.
    (1) If the active version is currently open in the policy development window, it automatically becomes inactive. (2) Reverting to an older version of a policy may rely on objects (users, groups, WSDLs, private keys) that no longer exist. Be sure to validate the policy afterward.
    Clear Active
    Clears the active version and disables the policy. Click [
    Yes
    ] to confirm when prompted. It is not necessary to select the active version before clicking [
    Clear Active
    ].
    If the active version is currently open in the policy development window, it automatically becomes inactive.
    Compare Policy: Left|Right
    Loads the selected revision for policy comparison. The button label shows either "Left"or "Right" depending on whether this is the first or second revision or policy selected.
    Comparison begins immediately after the second policy is selected and may require a moment to complete. The results are displayed in a separate window.
    For more information, see Comparing Policies.
    Close
    Closes the Policy Revisions dialog.