Policy Manager Interface

This topic describes the Policy Manager interface as seen by those with the Administrator role. Some elements may not be visible or editable if you have a more restrictive role. For more information, see .
This topic describes the Policy Manager interface as seen by those with the Administrator role. Some elements may not be visible or editable if you have a more restrictive role. For more information, see Manage Roles.
Some entities installed via Solution Kits cannot be modified, even by administrators. The editing controls for these entities are disabled.
General Interface: Identity Providers & Home Page
Main_Interface1.png
General Interface: Assertions & Policy Tree
Main_Interface2.png
Main Tool Bar
The Main Tool Bar contains shortcuts to commonly used program features:
  • Connect
    : Connects to a Gateway.
  • Disconnect
    : Disconnects from a Gateway and logs you out.
  • Refresh
    : Updates the policy development window by retrieving information from the Gateway again.
  • Home
    : Displays the Home page. (To return to policy view, double-click the name of the service.)
  • Preferences
    : Configures preferences for the standard version of the Policy Manager.
Assertions Tool Bar
The Assertions Tool Bar contains shortcut buttons used to add and organize assertions in the policy development window. Many of these actions are also available by right-clicking the assertion in the policy development window.
(1) All operations (except for the  button) can be performed on more than one assertion at a time. To select multiple assertions, hold down the [Ctrl] or [Shift] key while selecting assertions in the policy. The [Shift] key selects blocks of assertions, while [Ctrl] key allows for discontiguous selection. (2) The Assertions Tool Bar is disabled if the policy was installed by a Solution Kit and is not intended to be edited.
Button
Description
AssertionAdd.png
Adds the selected assertion to the policy.
Alternative: Drag the assertion from the [Assertions] tab and drop it into the policy development window.
AssertionExpand.png AssertionCollapse.png
Expands and collapses the selected composite assertion(s) or included policy fragment assertion(s) in the policy development window. If no assertions are selected, then all assertions in the policy are expanded or collapsed.
These buttons are not active if you select a branch with nothing to expand or collapse (in other words, it does not show the  or  icon).
Alternative: Right-click the assertion and select
Expand Assertion
or
Collapse Assertion
.
AssertionMoveUp.png AssertionMoveDown.png
Moves the selected assertion(s) in the policy up or down one line.
Alternatives: (1) Drag and drop the assertion.(2) Right-click the assertion and select
Move Assertion Up
or
Move Assertion Down
.
AssertionDelete.png
Deletes the selected assertion(s) from the policy.
Alternative: Right-click the assertion and then select
Delete Assertion
.
AssertionDisable.png
Disables the selected assertion(s) in the policy.
Alternative: Right-click the assertion and then select
Disable Assertion
.
Policy Tool Bar
The Policy Tool Bar contains shortcuts to commonly used policy features:
  • Save and Activate:
    Saves the policy or policy fragment in the policy development window and makes it the active revision. This button is available only if you have opened a non-active version for editing and changes have been made in the policy editor.
  • Save:
    Saves the policy or policy fragment in the policy development window as a new revision but does not change the active version.
    To activate an inactive version, either use [Save and Activate] or the [Set Active] button in the Policy Revisions dialog.
    The [Save] and [Save and Activate] buttons are unavailable when your role permits Read but not Write access to policies (for example, the "Operator" role). They may also be unavailable for policies added by a Solution Kit (where the Solution Kit author has disallowed changes).
    To preserve policy changes in these instances, export the policy.
  • Validate
    : Validates the policy.
  • Export Policy
    : Exports the policy to a file.
  • Import Policy
    : Imports a policy from a file.
  • Import from UDDI
    : Imports a file via a UDDI registry. Similar to Import Policy, except instead of importing from a file, the source is XML resolved from an HTTP URL published in a UDDI registry.
    Note:
    UDDI support is deprecated in
    Layer7 API Gateway
    .
  • Show Comments/Hide Comments
    : Toggles the display of comments in the policy development window.
  • Show Assertion Numbers/Hide Assertion Numbers
    : Toggles the display of line numbers next to each assertion in the policy development window.
  • Show Inputs and Outputs/Hide Inputs and Outputs:
    Toggles the display of inputs and outputs for the currently displayed policy fragment (in the desktop client, use the option under the View menu).
    This button only has effect when the policy fragment displayed is currently serving as a backing policy for an encapsulated assertion. It has no effect when used with any other policies.
[Identity Providers] Tab
Contains the that have been set up in the Policy Manager. Right-click on a provider name to see the available actions.
[Assertions] Tab
Contains a categorized list of the policy assertions used to construct a policy for a service. Expand a category to see the assertions within it.
Home Page
The Home Page is displayed upon startup or when [Home] is clicked on the Main Tool Bar. The Home Page contains shortcuts to commonly used wizards and dialogs.
Policy Search Bar
The Policy Search Bar in the policy development window helps you quickly locate an assertion based on text visible in the policy editor, or in the underlying XML code.
You can hide the Policy Search Bar by pressing the [Esc] key or by clicking the "x" in the upper right corner. Press [Ctrl]+F or select Edit > Find to re-enable the search bar.
The following table describes the controls in the Policy Search Bar:
Element
Description
FindSearchBar.png
Type the text in this search box. As you type, any assertions that contain the matching text are displayed.
Tip:
If [Include Properties] is selected, the match may not be obvious: the match may occur in the underlying XML code for the assertion.
FindDropDown.png
Click this to see a drop-down list showing the matching assertions again.
FindNextButton.png
Click this button to jump to the next matching assertion. This is the same as selecting Find Next from the Edit menu (keyboard shortcut [F3]).
FindPrevButton.png
Click this button to jump to the previous matching assertion. This is the same as selecting Find Previous from the Edit menu (keyboard shortcut [Shift]+[F3]).
Case sensitive
Select this check box to match the case of the search string.
Clear this check box to ignore case during searches. This setting is the default.
Show Disabled
Select this check box to include disabled assertions in the searches. This setting is the default.
Clear this check box to show only active assertions.
Include Properties
Select this check box to include the assertion properties in the searches. This setting is the default.
Clear this check box to search only the assertion name.
Note: When including properties, the underlying XML code is also searched. This may result in unexpected matches.
Tip:
To see the underlying XML code, copy the assertion and then paste the contents into a text editor. Note that only text viewable in the underlying XML is searchable.
FindCloseButton.png
Click this button to close the Policy Search Bar.
During the search, feedback messages similar to the following may appear:
FindFeedbackMessage.png
These messages are for informational purposes only and will disappear when you click on them or perform another search task.
Policy Development Window
Used to view or edit a policy revision for the selected published service. Each policy or revision is displayed in a separate tab. The tab name indicates whether the revision is active or inactive.
Policy Validation Messages Window
This window displays confirmation, warning, and error messages about the policy. You can show/hide this window using the [View] > Policy Messages menu option. Unless you need the screen space for the policy development window, you should always have the validation window open. For more information, see Validate a Policy.
Status Bar
The Status Bar displays user, Gateway, and port information. This bar may be toggled on and off by using [View] > Status Bar.
Audit Alerts
The Policy Manager can alert you to important audit events that require your attention. These events could have occurred while you were logged off or while you are using the Policy Manager.
In order to receive audit alerts, your role must allow you to view the Gateway Audit Events window.
When an audit event occurs that meets a preset threshold, the following alert indicator will appear in the top right corner of the user interface:
Audit_Alert_Awaiting.png
Click this indicator to open the Audit Alerts dialog.
Tip:
You can also access this dialog directly via:
Tasks > Logging and Auditing > Configure Audit Alert Options.
Your options are as follows:
Option
Description
View Audits
Launches the Gateway Audit Events window, where you can see more information about the audit items.
When [View Audits] is clicked, the audit alert indicator will not appear again until there are new audits requiring your attention.
Acknowledge Audits
Acknowledges the alert and closes the dialog without displaying the Gateway Audit Events window.
Configure Audit Alert Options
Opens the Configure Audit Alerts dialog to allow you to configure the following settings:
  • Enable Audit Alerts:
    Use this check box to enable or disable the Audit Alert feature.
  • Check for new audits every:
    Specify how often the Policy Manager should check for new audit events. The default is every 30 seconds.
  • Check for audits at or above level:
    Select the severity of the audit event before the audit alert appears. At the default WARNING level, only events rated WARNING or SEVERE will be brought to your attention. Be aware that choosing a threshold below WARNING will result in a large number of audit alerts (the Gateway generates many INFO alerts).
To configure audit alerts when the Audit Alerts Waiting indicator is not present, select Configure Audit Alert Options from the Task menu.
Dialog Boxes
Controls in dialog boxes are largely self explanatory. If a list or table is present in a dialog box, you can click the column heading to re-sort the column in ascending or descending order.