PingGateway 2024.11

Summary of tasks, route status, and icons

The following tables summarize the basic tasks that you can do in Studio, and summarizes the icons and status displayed in Studio:

Task reference
To do this Do this

Create a new route

Select ROUTES, Create a route.

Select a route

Select ROUTES, and then select a route to view.

Display the config of a selected route

Select a route, and then select and Display.

Deploy a selected route

Select a route, and then select Deploy.

Undeploy a selected route

Select a deployed route, and then select and Undeploy.

Change the basic config of a route

Select a route, and then select Route settings. Edit the route and save the changes.

Route status
Status Description Action

Undeployed

The route is saved in Studio but is not deployed to the backend.

Deploy the route. The status changes to Deployed.

Deployed

The route is saved in Studio and deployed to the backend.

None. The route has the same configuration in Studio and the backend.

Changes pending

The route has been deployed and then subsequently changed in Studio.

Deploy the route. The status changes to Deployed.

Out of sync

The route has been deployed and then subsequently changed in the backend, or in both Studio and the backend.

Select Deploy. A message informs you that a different version of the route is deployed in the backend. Select an option:

  • Deploy: The version in Studio overwrites the backend.

  • Import a route: The version in the backend overwrites Studio.

When you import a route into Studio you go into editor mode. You can use the JSON editor to manually edit the route, but can no longer use the full Studio interface to add or edit filters.

Compatibility update required

The route was created in Studio in an earlier version of PingGateway. Some information is needed to complete the upgrade.

Enter the information as prompted, and then select Deploy to deploy the route.

Icons
Icon Mode Description

Structured editor

The route was created and edited using the menus and options of structured editor.

{ }

Editor mode

The route was imported into Studio, or was created in Studio and then edited in editor mode.

FreeForm Icon

Freeform designer

The route was created on the canvas of FreeForm Designer.

Copyright © 2010-2024 ForgeRock, all rights reserved.