Create a Policy Studio project

A Policy Studio project is a design-time store of API Gateway configuration on a local file system, which can be deployed to a running API Gateway instance on a server. This topic explains how to create a new Policy Studio project from the following starting points:

Launch the New Project wizard

To launch the New Project wizard in Policy Studio, select File > New Project in the main menu. Alternatively, click New Project on the welcome page.

Enter project details

Enter the following in the Project Details screen:

Name: Enter the Policy Studio project name. This field is required.

Use default location: Select whether to use the default location. This is selected by default.

Location: Enter or browse to the project location (for example, C:\Users\jane\apiprojects\my_test_project). When Use default location is selected, the default location is ${user.home}/apiprojects/${project.name}.

Click Next.

Select a project starting point

Select one of the following in the Project starting point window:

From a template configuration

From a .fed file

From .pol and .env files

From an API Gateway instance

From existing configuration

New project from a template configuration

To create a new project based on template configuration:

Select the configuration template to use as a starting point:

Factory template

Blank template that contains default factory configuration.

Factory template with samples

Blank template that contains sample policies and other entities. This is for creating a project used for demo purposes.

Team Development – Common Project (with Server Settings)

Blank template that contains Server Settings. This is for creating your common project only. This should include policies common to multiple API projects (for example, authentication and authorization). Your API Gateway configuration must contain only one project with Server Settings. All other projects must have no Server Settings.

Team Development – API Project (without Server Settings)

Blank template that does not contain Server Settings. This is for creating all your projects (except your common project). Your API Gateway configuration must contain only one project with Server Settings. All other projects must have no Server Settings.

New project from an API Gateway instance

To create a new project based on an API Gateway instance:

In the Saved Sessions section, select the server session to use from the list. You can edit a session name by entering a new name and clicking Save. You can also click the appropriate button to Add, Clone, or Remove saved sessions.

Alternatively, if you already have API Manager configured you can create the project from the existing API Gateway configuration directory.

Note

There is no project template currently available for API Manager configuration.

Automatic upgrade of project configuration from earlier versions

If you create a project from a .fed file, a .pol file, or a configuration directory from an earlier API Gateway version, the configuration is automatically upgraded to API Gateway7.5.3 when the new project is created. The configuration directory can be from an API Gateway, Admin Node Manager, or API Gateway Analytics instance.

Note

This feature does not apply when creating a project from an API Gateway instance. You can only download configuration from an API Gateway instance if the Policy Studio version is the same as the API Gateway version.