Installing Policy Studio

Overview

Policy Studio is a graphical IDE that enables developers to virtualize APIs and develop policies to enforce security, compliance, and operational requirements. For more details on API Gateway components and concepts, see the API Gateway Concepts Guide. This topic describes how to install Policy Studio on the following platforms:

  • Windows

  • Linux

  • Solaris

Prerequisites

You must ensure the following:

System Requirements

See the System Requirements to ensure that the target machine is of a suitable specification.

Executable Permission

On Linux/UNIX, you must ensure that the installation executable has the appropriate permissions in your environment. For example, you can use the chmod command to update the file permissions.

Patching Policy Studio 11.1.2.2.0

To patch your existing Policy Studio installation, perform the following steps:

  1. Back up your existing API Gateway 11.1.2.2.0 installation.

  2. Delete your exsiting Policy Studio installation directory (for example, INSTALL_DIR\policystudio).

  3. Use the API Gateway 11.1.2.2.0 installation executable to install Policy Studio into the same directory.

Installing Policy Studio 11.1.2.2.0

Use the API Gateway 11.1.2.2.0 installation executable to install a new Policy Studio installation. When you run the executable in default GUI mode, you are presented with an introductory welcome screen. Click Next to continue with the installation.

For details on installing on the command line, see the section called “Unattended Installation”.

Installation Location

Enter or click Browse to specify the directory where you wish to install API Gateway components. For example, the default is as follows:

Windows C:\OAG-11.1.2.2.0
Linux/UNIX /opt/OAG-11.1.2.2.0


Click Next to continue.

Select Components

Ensure that the Policy Studio component is selected in the list, and click Next to continue.

[Note] Note

This topic describes how to install the Policy Studio component only. For details on installing other components, see the following topics:

Ready to Install

The installer is ready to start installing the selected components and settings on your system.

Click Next to continue.

Installing

A progress screen is displayed showing the progress of the installation. Please wait for the installation to complete.

Click Next to continue.

Completing the Policy Studio Setup

After the installer has finished, you can select whether launch Policy Studio. This setting is selected by default.

Click Finish to complete the installation.

Ensure the API Gateway is Running

Before starting Policy Studio, you should ensure that the Admin Node Manager and the API Gateway instance that you wish to manage are running. For more details, see the topic on Installing the API Gateway Core Server.

Starting Policy Studio

If you did not select to launch Policy Studio after installation, perform the following steps:

  1. Open a command prompt.

  2. Change to your Policy Studio installation directory (for example, INSTALL_DIR\policystudio).

  3. Start policystudio.

Making a Server Connection

When Policy Studio starts up, click a link to a server session to display the Open Connection dialog. You can use this dialog to specify Connection Details (for example, host, port, user name, and password), or to specify Saved Sessions.

If you wish to connect to the server using a non-default URL, click Advanced, and enter the URL. The default URL for the Admin Node Manager is:

https://localhost:8090/api

For more details on the settings in the Open Connection dialog, see the Oracle API Gateway User Guide.

Unattended Installation

You can run the API Gateway installer in unattended mode on the command line. The following command shows an example of installing the Policy Studio component only:

Windows

OAG-11.1.2.2.0-windows-installer.exe --mode unattended 
  --enable-components policystudio 
  --disable-components analytics,nodemanager,apitester,configurationstudio

Linux

./OAG-11.1.2.2.0-linux-installer.run --mode unattended 
  --enable-components policystudio 
  --disable-components analytics,nodemanager,apitester,configurationstudio

The specified components are installed in the background.

Further Information

For a description of all available command options and default settings, enter the --help option. This outputs the help text in a separate console.