Policy Studio Preferences


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.

Management Services

The Admin Node Manager and Oracle 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. By default, the Management Services policies and interfaces, interfaces and server process are hidden from view in the Policy Studio tree. You can display them by selecting the Show Management Services option in this dialog.

When this option is selected, you can view the Management Services policy container in the tree under the Policies node. The Management Services HTTP interfaces are also displayed under the Listeners node under the server process. For more details, see the section called “Management Services” in the Configuring HTTP Services topic.

[Important] Important

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

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.

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 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 the Policy Studio and the server for these changes to take effect.

Server Connection

When an update is made to a configuration setting in the Policy Studio, the update is stored locally until you deploy it to the API Gateway. After making one or more configuration updates, you can deploy to the API Gateway by selecting Server -> Deploy in the main menu. Alternatively, you can click the Deploy button in the toolbar, or press F6.

The updated configuration is then pushed to the API Gateway, which finishes processing any current messages before flushing its cached policy configurations. The new configuration is then stored and loaded. Any subsequent messages received by the API Gateway then use the new configuration.

When deploying to the API Gateway, the Policy Studio sends a deployment request to the server. If necessary, you can configure the socket timeout value for this connection in the Policy Studio Preferences dialog. Enter the timeout value in milliseconds in the Server Socket Connection Timeout field.

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.

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.

Web and XML

The Web and 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.


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).

WS-I Settings

Before importing a WSDL file that contains the definition of a Web Service into the Web Services 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 checkbox (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 checkbox (unselected by default).
Verbose Output Specify whether verbose output is displayed in the Policy Studio console window using the checkbox (unselected by default). To view the console window, select Window -> Show Console from the Policy Studio main menu.

For details on running the WS-I Testing Tools, see the Web Service Repository or Global Schema Cache topics.