Import, Update and Deploy in Policy Studio

Plan your Policy Studio project(s): dual or single instance

The import of the artifacts in the target environment depends on the deployment pattern (refer to Deployment patterns)

Single instance

If there's only one instance of API Gateway to host both sample policies and pattern policies, then only one Policy Studio project is needed:

Dual instance

If 2 instances of API Gateway are used, then 2 Policy Studio projects are needed:


Manage dependencies in Policy Studio

Follow the steps below to add a project as a dependency in Policy Studio:

Create a new project in Policy Studio with Server Settings (or use an existing one)

  • Activate Team development option

  • Follow the different steps to create New Project
  1. click File
  2. select New Project
  3. Enter the Name of Project and click Next button
  4. Select From a template configuration
  5. Select Team Development – Common Project (with Server Settings) and click Finish button

Add DigitalMFTPatternProject as a dependency:

  • A new Project Dependencies subfolder appears:
  • Right click > Manage Dependencies
  • Add the DigitalMFTPatternProject delivered project as a dependency:

Import fragments in Policy Studio

  1. Import the delivered fragments, in the following order:
    • DigitalMFTPatternJSON.xml
    • DigitalMFTKPS.xml (not necessary for deployment pattern 1)
    • DigitalMFTSampleFragment_Policies.xml
    • DigitalMFTSampleFragment_BusinessFlowAPI.xml
  2. Click Import Configuration Fragment button to import the 4 previous fragments:

Import the CG server certificates

This step requires access to your CG server. To import the certificates into the Certificates store:

  1. In Policy Studio, open Environment Configuration > Certificates and Keys > Certificates
  2. Click Create/Import button
  3. Edit the form to specify the certificates
    You can get these certificates, by exporting the whole certificate chain from a browser (Firefox for example), using crt or pem format.
  4. Click Import Certificates

Deploy the Policy Studio Configuration

  1. Once updated, deploy the Policy Studio configuration on the target environment.

Manage the environment settings

Some minimum updates must be performed to use provided configuration. These updates will allow you to test the configuration in your environment. They are described in this chapter.

Environment related settings are stored in a specific Cassandra KPS Table named Environment:

The content of this table must be filled with API Gateway Manager UI. For that:

  1. Connect to API Gateway Manager UI

  2. Select Key Property Store menu (step 1 and 2 in the diagram below)

  3. Select Actions and New Entry to fill variables

and create the following environment variables using the Create entry feature (step 3 in the previous diagram):

Environment variable




URL pointing towards CG1 Authentication API



URL pointing towards CG1 APIs

PatternResourcePath_V2 URL pointing towards Pattern API V2 http://<api_host>:<api_port>/PatternAPI/v2
PatternResourcePath_V3 URL pointing towards Pattern API V3 http:// <api_host>:<api_port>/PatternAPI/v3


Organization used to connect to CG1



User used to use CG1 APIs



Password for CG1User

authMode Authentication method.
Possible values: Basic_auth or SSO
encryptionKey Name of the encryption key for authentication keytest2018

URL pointing towards CG2 Authentication API

Not necessary if only one CG is available


URL pointing towards CG2 APIs

Not necessary if only one CG is available


Organization to connect to CG2

Not necessary if only one CG is available


User for CG2 APIs

Not necessary if only one CG is available


Password for CG2User

Not necessary if only one CG is available


Choice of the CG on which the configuration will be created

Possible values CG1 or CG2

in case of CG1, all variables starting with CG1 are used

in case of CG2, all variables starting with CG2 are used



Flag to enable (yes) or not (no) the debug for the JavaScript mapping used in the policy MappingExecution in the container DigitalMFTPatterns/PatternMaps


Related Links