Policy Studio preferences

Contents

Overview
Environmentalization
Policy colors
Prompt for credentials
Management services
Proxy settings
Runtime dependencies
SSL settings
Status bar
Topology screen
Trace level
WS-I settings
XML settings

Overview

The Preferences dialog enables you to configure a range of options for the Policy Studio. For example, you can configure the level at which the Policy Studio traces diagnostic output, customize the look-and-feel of the Policy Studio, or configure the timeout for the Policy Studio connection to the API Gateway. Each of the available settings is discussed in the following sections.

[Note] Note
When finished your updates, remember to click Apply at the bottom of the screen, and to click Deploy in the toolbar.

Environmentalization

Environmentalization refers to configuring environment-specific settings for a particular target environment (for example, users, certificates, and external connections for a development environment). You can enable Policy Studio to display settings that have been environmentalized by selecting the Allow environmentalization of fields option.

When this option is selected, you can environmentalize a selected field (for example, database URL) by clicking the globe icon to the right of the field. Alternatively, press Ctrl-E. When you have selected settings to be environmentalized, the field is disabled, and the globe icon is displayed on the right. You can manage settings that have been environmentalized under the Environment Settings node in the Policy Studio tree. For more details, see the API Gateway Deployment and Promotion Guide.

Policy colors

The Policy Colors settings enable you to customize the look-and-feel of the Policy Canvas in the Policy Studio. For example, you can change the colors of the following components:

  • Policy Background:

    Changes the background color of the Policy Canvas.

  • Missing Attribute:

    You can right-click the Policy Canvas, and select Show All Attributes from the context menu. When this is selected, each filter displays the list of required and generated message attributes that are relevant for that filter. If a required attribute has not been generated by a previous filter in the policy, the attribute is highlighted in a different color (red by default). You can change this color by selecting an appropriate color using this setting.

  • Success Path:

    You can change the color of the Success Path link using this setting.

  • Failure Path:

    Similarly, you can change the color of the Failure Path link here.

  • Show Link Labels:

    If this option is selected, a Success Path is labeled with the letter S, while a Failure Path is labeled F.

Prompt for credentials

The Prompt for Credentials setting enables you to select whether to check for user name and password credentials when you deploy updated API Gateway configuration. For example, this applies when you click Deploy in the toolbar to update configuration or add a group or server to the topology. To check for credentials each time you deploy, select Always prompt for Node Manager credentials.

For more details, see Deploy API Gateway configuration.

Management services

The Admin Node Manager and API Gateway Analytics expose certain interfaces that are used for management purposes only, and should be edited only under strict advice from the Oracle Support team.

The Management Services server process, interfaces, and policies are displayed in the Policy Studio tree. The Management Services policy container is displayed in the tree under the Policies node. The Management Services HTTP interfaces are displayed under the Listeners node under the server instance. For more details, see the section called “Management services” in Configure HTTP services.

[Important] Important

You should only modify Management Services under strict advice and supervision from the Oracle Support team.

Proxy settings

You can specify global proxy settings that apply only when downloading WSDL, XSD, and XSLT files from the Policy Studio. These include the following settings:

Proxy Setting Description
Host Host name or IP address of the proxy server.
Port Port number on which to connect to the proxy server.
Username Optional user name when connecting to the proxy server.
Password Optional password when connecting to the proxy server.


You can also specify individual proxy servers under the External Connections node in the Policy Studio tree. These are different from the global proxy settings in the Preferences because you can specify these proxy servers at the filter level (in the Connection and Connect To URL filters). For more details, see the Configure proxy servers topic.

Runtime dependencies

The Runtime Dependencies setting enables you to add JAR files to the Policy Studio classpath. For example, if you write a custom message filter, you must add its JAR file, and any third-party JAR files that it uses, to the Runtime Dependencies list.

Click Add to select a JAR file to add to the list of dependencies, and click Apply when finished. A copy of the JAR file is added to the plugins directory in your Policy Studio installation.

[Important] Important

You must restart Policy Studio and the server for these changes to take effect. You should restart Policy Studio using the policystudio -clean command.

SSL settings

The SSL Settings enable you to specify what action is taken when an unrecognized server certificate is presented to the client. This allows the Policy Studio to connect to SSL services without a requirement to add a certificate to its JVM certificate store.

Configure one of the following options:

Prompt User When you try to connect to SSL services, you are prompted with a dialog. If you choose to trust this particular server certificate displayed in the dialog, it is stored locally, and you are not prompted again.
Trust All All server certificates are trusted.
Keystore Enter or browse to the location of the Keystore that contains the authentication credentials sent to a remote host for mutual SSL, and enter the appropriate Keystore Password.


Status bar

The Show Status Bar setting enables you to specify whether the applications status bar is displayed at the bottom of the Policy Studio screen. For example, this status bar displays details such as the currently selected tree node on the left, and details such as the heap size on the right. You can also use the status bar to run garbage collection by clicking the trash icon on the right. This status bar is enabled by default.

Topology screen

The Topology Screen settings enable you to customize how configuration package properties are displayed in the Topology View table in Policy Studio. These are user-entered properties contained in deployment packages (.fed), policy packages (.pol), and environment packages (.fed). The Group / API Gateway and Deployed by columns in the Topology View are read only. You can customize all other columns to show package property values.

Specify default column values

You can specify the following default package property values in the Column Value column:

  • ${manifest.policy.Name}

  • ${manifest.policy.Description}

  • ${manifest.policy.Version}

  • ${manifest.policy.VersionComment}

  • ${manifest.env.Name}

  • ${manifest.env.Description}

  • ${manifest.env.Version}

  • ${manifest.env.VersionComment}

  • ${manifest.root.Id}

  • ${manifest.root.Timestamp}

Add custom properties

You can also add custom package properties. For example, to add a custom policy package property to be displayed in the Topology View, perform the following steps:

  1. Click New.

  2. Double-click the value in Column Header, and enter MyCustomPolicyField.

  3. Double-click the value in Column Value, and enter ${manifest.policy.MyCustomPolicyField}.

Similarly, to add a custom environment package property, add a property with a Column Header of MyCustomEnvField, and a Column Value of ${manifest.env.MyCustomEnvField}.

Customize the topology view table

You can add, edit, remove, or reorder the columns displayed in the Topology View using the Topology Screen settings. You can also specify the Column Width displayed.

For more details on configuring package properites, see the API Gateway Deployment and Promotion Guide.

Trace level

You can set the level at which the Policy Studio logs diagnostic output by selecting the appropriate level from the Tracing Level drop-down list. Diagnostic output is written to a file in the /logs directory of your Policy Studio installation. You can also select Window > Show View > Console in the main menu to view the trace output in the Console window at the bottom of the screen. The default trace level is INFO.

WS-I settings

Before importing a WSDL file that contains the definition of a Web service into the Web service repository, you can test the WSDL file for compliance with the Web Service Interoperability (WS-I) Basic Profile. The WS-I Basic Profile contains a number of Test Assertions that describe rules for writing WSDL files for maximum interoperability with other WSDL authors, consumers, and other related tools.

The WS-I settings are described as follows:

WS-I Setting Description
WS-I Tool Location Use the Browse button to specify the full path to the Java version of the WS-Interoperability testing tools (for example, C:\Program Files\WSI_Test_Java_Final_1.1\wsi-test-tools). The WS-I testing tools are used to check a WSDL file for WS-I compliance. You can download them from www.ws-i.org.
Results Type Select the type of WS-I test results that you wish to view in the generated report from the drop-down list. You can select from all, onlyFailed, notPassed, or notInfo.
Message Entry Specify whether message entries should be included in the report using the check box (selected by default).
Failure Message Specify whether the failure message defined for each test assertion should be included in the report using the checkbox (selected by default).
Assertion Description Specify whether the description of each test assertion should be included in the report using the check box (unselected by default).
Verbose Output Specify whether verbose output is displayed in the Policy Studio console window using the check box (unselected by default). To view the console window, select Window > Show Console from the Policy Studio main menu.


[Important] Important

On Linux/UNIX, when you download WS-I Testing Tools v1.1, you must run dos2unix on /java/bin/Analyzer.sh and /java/bin/setenv.sh. This is because both files do not have executable privileges set and have Windows line endings, so the shell interpreter is unable to use them.

For details on running the WS-I testing tools, see the Manage WSDL and XML schema documents topic.

XML settings

The XML settings enable you to configure a range of options that affect how XML files are treated in the Policy Studio.

XML Files

This includes the following options:

Creating or saving files Specifies a line delimiter (for example, Mac, Unix, Windows, or No translation).
Creating files Specifies a file suffix (xml), and the type of encoding (for example, ISO 10646/Unicode(UTF-8)).
Validating files Configures whether to warn when no grammar is specified.


Source

This includes the following options:

Formatting Specifies a range of formatting options (for example, line width, line breaks, and indentation).
Content assist Specifies whether to make suggestions and which strategy to use (for example, Lax or Strict).
Grammar constraints Specifies whether to use inferred grammar in the absence of DTD/Schema.


Syntax Coloring

These settings enable you to associate specific colors with specific XML syntax elements (for example, attribute names, comment delimiters, or processing instruction content).

Prev  Up  Next
  Home