IG 7.1.2

Creating and Editing Routes in Freeform Designer

The following sections describe basic tasks for creating and deploying routes in the freeform designer of Studio:

Creating Simple Routes

This section describes how to create a simple route in the freeform designer, and add a chain and a filter. For examples of routes created with the freeform designer that can be tested with the examples in the Gateway Guide, see Example Routes Created With Freeform Designer.

  1. In IG Studio, create a route:

    1. Go to http://openig.example.com:8080/openig/studio, and select Create a route.

    2. Select freeform Freeform to use the freeform designer.

  2. Select Basic to create a route from a blank template.

  3. Enter a URL for the application you want to protect, followed by a path condition to access the route. For example, enter http://app.example.com:8081/my-basic-route.

    The route is displayed on the freeform Flow tab of the canvas.

  4. On the top-right of the screen, select and Display to review the route.

      "name": "my-basic-route",
      "baseURI": "http://app.example.com:8081",
      "condition": "${find(request.uri.path, '^/my-basic-route')}",
      "handler": "ReverseProxyHandler",
      "heap": [
          "name": "ReverseProxyHandler",
          "type": "ReverseProxyHandler"
          "type": "BaseUriDecorator",
          "name": "baseUri"
          "type": "TimerDecorator",
          "name": "timer",
          "config": {
            "timeUnit": "ms"
          "type": "CaptureDecorator",
          "name": "capture",
          "config": {
            "captureEntity": false,
            "captureContext": false,
            "maxEntityLength": 524288
  5. Add a filter to the route:

    1. Select the freeform Flow tab, and delete the connector between Start and ReverseProxyHandler.

    2. From the side bar, drag a Chain onto the canvas, and then drag a filter into the chain.

      See how to add objects to the canvas.
      add chain sso

      A menu for the filter opens. Enter the required configuration properties, and then save.

  6. Connect Start to Chain-1, and Chain-1 to ReverseProxyHandler.

    See how to connect components.
    connect components

  7. Decorate objects in the route:

    1. Select the All Objects tab to view a list of objects in the route. By default, all available decorators are included in the route heap but do not decorate any objects.

    2. For the ReverseProxyHandler or filter, select , select the Decorations tab, and then enable one or more of the decorators.

  8. On the top-right of the screen, select and Display to review the route.

Changing the Basic Settings of a Route

  1. In Studio, select ROUTES, and then select a route with the icon.

  2. On the top-right of the screen select Route settings.

  3. Using the on-screen hints for guidance, change the name, condition, or other features of the route, and save the changes.

  4. On the top-right of the screen, select and Display to review the route.

Copyright © 2010-2023 ForgeRock, all rights reserved.