Skip to main content
Version: 3.8

Gateway Sync

caution

The artifacts mapped under the Production gateway are displayed under the Production tab, while artifacts mapped under the Sandbox gateway are displayed under the Sandbox tab.

The Gateway Sync module includes two sub modules:

  • Gateway Sync - Changes
  • Gateway Sync - History

The Gateway Sync - Changes screen allows manual synchronization of configurations from the portal to the Gateway.

gatewaysyncchange

In the Gateway Synchronization - History screen, users can select a backed-up instance to roll back artifacts if issues occur during synchronization.

gatewaysynchistory

Gateway Synchronization - Changes​

The Gateway Synchronization - Changes screen includes two tabs:

  • Production
  • Sandbox

The Production tab has three sections:

  • Changes to Backend Endpoint
  • Changes to Global Config, API, Usage Plan, Policy, Gateway
  • Changes to Subscriptions

The Sandbox tab has two sections:

  • Changes to Backend Endpoint
  • Changes to Global Config, API, Usage Plan, Policy and Gateway

Changes to Backend Endpoint​

In the Changes to Backend Endpoint section, the user can synchronize the Backend Endpoint (Production and Sandbox).

For example, the procedure for synchronizing the Production Backend Endpoint is described below.

info

The procedure for synchronizing the Sandbox Backend Endpoint is the same as in production.

  1. Navigate to the Gateway Sync module's Changes sub-module.

  2. Ensure that Production tab is selected.

gatewaysyncnew

  1. Click to expand the Changes to Backend Endpoint section.

gatewaysyncnew1

  1. Click the checkboxes to select the corresponding artifacts.

  2. Click Synchronize.

Gateway Sync dialog box appears as shown below.

  1. Enter the Synchronization Details.

  2. Click Sync.

On synchronizing, the confirmation message appears as shown below.

  1. Click Ok to close the Gateway Sync dialog box.
info

Users cannot propagate artifacts that are associated with a backend that is present on the Gateway Sync page.

Changes to Global Config, API, Usage Plan, Policy and Gateway​

In the Changes to Global Config, API, Usage Plan, Policy, Gateway section, the user can synchronize the Global Config, API, Usage Plan, Policy and Gateway (Production and Sandbox).

For example, the procedure for synchronizing the Production Usage Plan is described below.

info

The procedure for synchronizing the remaining artifacts in Production and Sandbox is the same as described below.

  1. Navigate to the Gateway Sync module's Changes sub-module.

  2. Ensure that Production tab is selected.

gatewaysyncusageplan

  1. Click to expand the Changes to Global Config, API, Usage Plan, Policy, Gateway section.

gatewaysyncusageplan1

  1. Click the checkboxes to select the corresponding artifacts.

  2. Click Synchronize.

Gateway Sync dialog box appears as shown below.

  1. Enter the Synchronization Details.

  2. Click Sync.

On synchronizing, the confirmation message appears as shown below.

  1. Click Ok to close the Gateway Sync dialog box.
info

Users cannot propagate artifacts that are associated with a backend that is present on the Gateway Sync page.

Changes to Subscriptions​

The user can synchronize the subscription under the Changes to Subscriptions section (available only in Production).

  1. Navigate to the Gateway Sync module's Changes sub-module.

  2. Ensure that Production tab is selected.

gatewaysyncsub

  1. Click to expand the Changes to Subscriptions section.

gatewaysyncsub1

  1. Click the checkboxes to select the corresponding artifacts.

  2. Click Synchronize.

On synchronizing, the confirmation message appears as shown below.

gatewaysyncsub2

Gateway Synchronization - History​

The Gateway Synchronization - History section displays the history of previously propagated/Synchronized artifacts and its details.

gatewaysynchistorynew

Rollback​

info

Rollback functionality is not available for Sandbox Gateway.

The rollback capability permits users to revert the artifacts to a previous state, ensuring restoration to earlier artifact versions before Synchronization. The rollback history includes synchronization dates and details of rollback.

info
  • To achieve the rollback for a certain propagation, all necessary Gateways must be up and running.
  • You can only rollback the propagation one by one.
  • Plan level details (i.e. plan_name, pricing_type, signup_fee, termly_fee, termination_fee, currency, term_validity, auto_renew and other pricing details) willl not be rolled back.
  1. Navigate to the Gateway Sync module's History sub-module.

gatewaysynchistorynew1

  1. Click to expand the Synchronization Date.

  2. Click Rollback here.

Gateway Sync dialog box appears as shown below.

  1. Click Rollback.

On rolling back, Gateway Sync dialog box is updated and displayed as shown below.

  1. Click Finish to complete the rollback.
info

Rollback reverts the latest propagation of artifact modifications and can be found in the Gateway Sync - Changes submodule.