Manage Policy Studio projects

Overview

This topic explains how work with Policy Studio projects when developing API Gateway policies and configuration. For example, this includes basic tasks such as creating, opening, saving, and closing projects. It also includes tasks such as deploying, importing, and exporting configuration from a project, changing a project passphrase, and adding APIs and web services to a project.

Create a new project

To create a new project in Policy Studio, select File > New Project from the main menu, or click New Project on the welcome page. Follow the steps in the New Project wizard.

For more details, see Create a Policy Studio project.

Open an existing project

To open an existing project in Policy Studio, select File > Open Project from the main menu, or click Open Project on the welcome page, and enter the project details in the dialog. Alternatively, click a link to the existing project in the Recent Projects pane on the welcome page.

For more details, see Manage API Gateway connections.

Save changes to a project

When a project is loaded in Policy Studio, you can select FileSave from the main menu to save the changes to the current configuration editor.

Alternatively, select FileSave All to save the changes to all open unsaved configuration editors.

Deploy changes to a project

When a project is loaded in Policy Studio, you can select TasksDeploy from the main menu to deploy saved changes to a running API Gateway instance at any time. Alternatively, click the Deploy button in the toolbar.

For more details, see Deploy API Gateway configuration.

Add an API to a project

When a project is loaded in Policy Studio, you can select TasksAdd REST API from the main menu to add an API to the project.

For more details, see Develop REST APIs in Policy Studio.

Virtualize a web service

When a project is loaded in Policy Studio, you can select TasksVirtualize a Service from the main menu to use the API Gateway to virtualize a web service.

For more details, see Register and secure web services.

Change the project passphrase

You can use the projchangepass command to change the encryption passphrase for a Policy Studio project. For more information on projchangepass, see Automate processes for continuous integration in the API Gateway DevOps Deployment Guide.

Note   It is important to distinguish between the passphrase used by a project on the local file system and the passphrase used by an API Gateway group configuration on a running API Gateway instance. For details on specifying a different passphrase for runtime, see Deploy API Gateway configuration.

For more details on configuring encryption passphrases, see the API Gateway Administrator Guide.

Export configuration packages

When a project is loaded in Policy Studio, you call select File > Export to save the project as a configuration package. Select one of the following from the menu:

  • Deployment package:
    Saves the project as a .fed file that contains all API Gateway configuration. This includes policies, listeners, external connections, users, certificates, and environment settings.
  • Policy package:
    Saves the project as a .pol file that contains users, certificates, and environment settings.
  • Environment package:
    Saves the project as a .env file that contains policies, listeners, external connections, and environment settings.

When you have saved a configuration package, you can use it to create a Policy Studio project in another environment. For more details, see Create a Policy Studio project.

For more details on configuration packages to promote configuration between environments, see the API Gateway DevOps Deployment Guide.

Import configuration into a project

When a project is loaded in Policy Studio, you can select FileImport > Configuration Fragment from the main menu to import configuration into the project. This feature enables you to import XML-based configuration previously exported from Policy Studio. For more details, see Import API Gateway configuration fragment.

You can also select FileImport > Custom filters to import custom filters to be added to the Policy Studio filter palette. For more details, see the API Gateway Developer Guide.

Manage multiple projects

You can work with multiple projects in Policy Studio. When a project is loaded in Policy Studio, you can click the Show List icon (>>) in the toolbar to display a list of currently open views (for example, other open projects and the welcome page). Select an item in the list to switch between views. The toolbar also displays the number of available views beside the Show List icon in the toolbar.

Close a project

To close the project currently open in Policy Studio, select File > Close Project from the main menu. Alternatively, click the X icon next to the project name in the toolbar.

Related Links