CA API Gateway 9.1

9.4 9.1

Policy Manager Menus

In the browser client, use either the alternative or keyboard shortcut methods to perform a Copy. Note: If the browser client is running in the untrusted mode, the Copy option is disabled in the right-click context menu for added security and you must use the keyboard shortcut instead.
gateway91
This topic describes the menus in the desktop client version of the Policy Manager. For the browser client version, use the keyboard shortcuts instead.
File menu
  • Save and Activate
    : Saves the current policy or policy fragment as a new revision and makes it the active revision. This is indicated in the tab title for the revision. Also available on the Policy Tool Bar. Keyboard shortcut: [Ctrl]+[Alt]+S
  • Save
    : Saves the current policy or policy fragment as a new revision, without changing its active state. Also available on the Policy Tool Bar. Keyboard shortcut: [Alt]+S
  • Export Policy
    : Exports the policy to a file. Also available on the Policy Tool Bar. Keyboard shortcut: [Alt]+R
  • Import Policy
    : Imports a policy from an external file. Also available on the Policy Tool Bar. Keyboard shortcut: [Alt]+I
  • Validate
    : Validates a policy. Also available on the Policy Tool Bar. Keyboard shortcut: [Alt]+V
  • Active Policy Assertions
    : (Visible only when a policy is open in the policy development window) Loads the active revision into the policy development window. This shortcut removes the need to first display the revision history, then manually loading the active revision into the editor. Also available by right-clicking on the name of the service in the Services and Policies  list. 
    Tip:
     An even faster method to load the active revision is to double-click on the name of the service.
  • Service Properties
    : Displays the properties for the service. Also available by right-clicking on the name of the service in the Services and Policies  list.
  • Publish to UDDI
    : Publishes information to a UDDI registry. Also available by right-clicking on the name of the service in the Services and Policies list .
  • Delete Service
    : Deletes a published service. Also available by right-clicking on the name of the service in the Services and Policies  list.
  • Compare Policy
    : Compares any two policies and displays the results in a color-coded list. Can display differences between two assertions, including showing the properties or raw XML. 
  • Connect
    : Connects to a Gateway. Also available on the Main Tool Bar. Keyboard shortcut: [Alt]+C 
  • Disconnect
    : Disconnects from a Gateway and logs you out. Also available on the Main Tool Bar. Keyboard shortcut: [Alt]+D
    When using the browser client, you should close your browser after disconnecting to securely log out. This clears your user name and password from the browser cache.  
  • My Account
    : Displays the My Account dialog, where you can view basic information about your account (including role information) and change your password. In the browser client, this is available under the Manage tool on the Main Tool Bar. Keyboard shortcut: [Alt]+space
  • Preferences
    : Configures preferences for the Policy Manager. Also available on the Main Tool Bar. Keyboard shortcut: [Alt]+P
  • Exit
    :  Closes the Policy Manager. You will be prompted to save if there are unsaved changes. In the browser client, close the browser after disconnecting to exit. Keyboard shortcut: [Alt]+X
Edit menu
  • Copy
    : Copies the selected item to the clipboard, ready to be pasted elsewhere. Useful for quickly replicating an assertion within a policy, replicating an include-policy fragment, service, or alias, copying the underlying XML code of an assertion, or copying validation messages. When copying a composite assertion, all child assertions are copied as well.
    When copying a service, the information on the [UDDI] tab of the Published Service Properties is not carried over. This must be manually reentered upon pasting. Internal and Global policies cannot be copied. Avoid copying a service that has been converted to be a "portal managed" API. Doing so will cause the new service to be mapped to the original API. From the API Portal's perspective, it would appear that the original API has been replaced by the new one.  
In the browser client, use either the alternative or keyboard shortcut methods to perform a Copy.
Note: 
If the browser client is running in the untrusted mode, the Copy option is disabled in the right-click context menu for added security and you must use the keyboard shortcut instead.
Alternative
: Right-click an assertion or selected text and select Copy
Keyboard shortcut
: [Ctrl]+C
  • Copy All
    : Copies all the assertions in the policy development window. The XML code for all the assertions is placed in the clipboard, ready to be pasted back into the same policy or another external application.
    In the browser client, use either the alternative or keyboard shortcut methods to perform a Copy All.
Alternative
: Right-click anywhere within the policy development window and select Copy All. 
Keyboard shortcut
: [Ctrl]+[Shift]+C
  • Paste
    : Pastes the items that were copied to the clipboard.
    • When pasting an include policy fragment, service, or alias, select the destination folder before pasting. The properties for that policy or service are automatically displayed upon pasting, allowing you to make modifications to the copied settings before saving. Pasted policies start their own revision sequence (i.e., the version number is not related to the source item).
    • When pasting an assertion, the clipboard must contain valid policy XML code before Paste will work. The pasted assertion is inserted after the selected assertion in the policy development window or after the last assertion if no assertion is selected
In the browser client, use either the alternative or keyboard shortcut methods to perform a Paste.
Alternative
: Right-click an assertion and select Paste. 
Keyboard shortcut
: [Ctrl]+V
Note the following about the Paste operation:
    • When 
      Copy All
       was used, Paste will group the pasted assertions within an "All Assertions" folder beneath the currently selected assertion. You can then use the Assertions Tool Bar to reposition if necessary.
    • Source XML code for the Paste operation can come from an external application.
      • If a pasted assertion requires immediate configuration, its properties will be displayed, just as if you had added it to the policy.
      • If a pasted assertion refers to unknown entities (for example, unknown users or identity providers), a policy validation error will be displayed.
      • Nothing will happen if you attempt to paste non XML or invalid policy XML code. However, this operation will be noted in the Policy Manager logs as a FINE event.
    • Go to Assertion
      : Displays the assertion with the given number. 
      Tip:
       To see assertion numbers, click [Show Assertion Numbers] on the Policy Tool Bar or select this option under the View menu. Keyboard shortcut: [Ctrl]+G
    • Find
      : Locates assertions in the policy that contain a specific search string. For more information, see Policy Search Bar. Keyboard shortcut: [Ctrl]+F
    • Find Next
      : Finds the next matching item. Keyboard shortcut: [F3]
    • Find Previous
      : Finds the previous matching item. Keyboard shortcut: [Shift]+[F3]
    • Migrate Namespaces
      : Updates all XPath assertions from one namespace to another. For more information, see "Migrating Namespaces" under Configure Namespaces.
Tasks menu
In the browser client version of the Policy Manager, many of the items below are accessed from the "Manage" menu.
Items under the Tasks menu are organized within these submenus:
Identity Providers
Users and Authentication
Services and APIs
Transports
Certificates, Keys, and Secrets
Data Sources
Global Settings
Extensions and Add-Ons
Logging and Auditing
View menu
  • Policy Messages
    : Shows/hides the Policy Validation Messages window. This window should normally be displayed, so that you can see validation messages. In the browser client, this is available under the Help tool on the Main Tool Bar.
  • Inputs and Outputs:
     Shows/hides the inputs and outputs defined in the encapsulated assertion that is using the policy fragment (currently displayed in the policy development window) as its backing policy. By default, this panel is displayed when there is an associated encapsulated assertion and hidden when the policy fragment is not serving as a backing policy. In the browser client, use the Show/Hide Inputs and Outputs button on the Policy Tool Bar to toggle the view. Keyboard shortcut: [Alt]+U
  • Status Bar
    : Shows/hides the Status Bar at the bottom of the Policy Manager interface. The Status Bar is not used in the browser client version.
  • Show Comments/Hide Comments:
     Shows or hides comments in the policy development window. Also available on the Policy Tool Bar. 
  • Show Assertion Numbers/Hide Assertion Numbers
    : Shows or hides assertion numbers in the policy development window. Also available on the Policy Tool Bar. Keyboard shortcut: [Alt]+N
  • Refresh
    : Updates all tabs in the policy development window. Useful if multiple users are updating a policy simultaneously. Also available on the Main Tool Bar. Keyboard shortcut: [F5]
  • Dashboard
    : Displays Service Metrics and Cluster Status information. In the browser client, this is available under the Monitor tool on the Main Tool Bar.
  • Gateway Audit Events
    : Displays the Gateway Audit Events window. In the browser client, this is available under the Monitor tool on the Main Tool Bar.
  • View Logs
    : Used to view the logs in the system. In the browser client, this is available under the Monitor tool on the Main Tool Bar.
  • Saved Events
    : Used to view log or audit events that have been saved. In the browser client, this is available under the Monitor tool on the Main Tool Bar.
  • Filter Service and Policy Tree
    : In the policy tree, display only Services, Policy Fragments, or All. (Note: Filtering the display affects what is returned by Search box—only displayed entities are searched.) In the browser client, this is available by right-clicking the root folder in the policy tree.
  • Sort Service and Policy Tree By
    : Sort the policy tree by Name or Type, in ascending or descending order. In the browser client, this is available by right-clicking the root folder in the policy tree.
Help menu
  • Help System
    : Displays the online help for Policy Manager. Keyboard shortcut: [F1] 
  • Manage Gateway License
    : Displays the Manage Gateway Licenses dialog, where you can install, view, and remove the licenses for your Gateway. In the browser client, this is available under the Manage tool on the Main Tool Bar.
  • About
    : Displays information about the version of the Policy Manager.

Content feedback and comments