Synchronizing Consumer Applications through CentraSite Business UI
Note:
This section is not applicable if the
CentraSite run-time aspects are not enabled. By default, run-time aspects configured from
CentraSite are disabled. However, you can enable them if required. To enable the
CentraSite run-time aspects, see
Enabling CentraSite Run-Time Aspects.
Pre-requisites:
To synchronize consumer applications in CentraSite with API Gateway, you must have the following roles:
CentraSite Administrator: to synchronize consumers of any organization with an instance of
API Gateway belonging to any organization.
Organization Administrator: to synchronize consumers with an instance of
API Gateway to which your Manage Organizations permission applies.
API Gateway Administrator: to synchronize consumers with an instance of
API Gateway belonging to the organization to which your
API Gateway Administrator role applies.
API Gateway Publisher: to synchronize consumers with an instance of
API Gateway belonging to the organization to which your
API Gateway Publisher role applies.
You synchronize, also termed publish, consumer applications to a policy enforcement point (PEP) such as webMethods API Gateway to perform client validation.
You synchronize consumer applications in CentraSite with API Gateway for the following reasons:
To update any changes, for example, modification to the range of valid IP addresses, that was performed in the details page of a consumer application in
CentraSite.
To update the list of consumers in
API Gateway when a consumer application is deleted in
CentraSite.
To update the list of registered consumers in
API Gateway when a consumer application is unregistered from the API in
CentraSite.
Note:
When synchronizing consumer applications with API Gateway, if the application has an API key or OAuth 2.0 token, then CentraSite does not allow the synchronization of that particular application with API Gateway. In this case, you have to manually republish the application that includes the API key or OAuth 2.0 token to API Gateway.
To synchronize consumer applications
1. In the CentraSite Business UI activity bar, click Governance Rules.
2. To filter the list of the available API Gateways, do the following:
a. Go to the advanced search panel.
b. In the Narrow Your Results section, do the following:
a. Locate Applicable Scopes.
b. Select API Gateway from the drop-down list.
CentraSite displays the list of available API Gateways in the Search Results page. Also, the actions bar displays a set of actions that are available for working with the displayed API Gateways.
3. Select the API Gateways to which you want to synchronize the consumers.
4. On the actions bar of the Search Results page, click Sync Consumers (
). You can also synchronize consumers to a single API Gateway through the Sync Consumers actions in the API Gateway Gateway Details page.
The deployment process is carried out by a synchronous mechanism between CentraSite and API Gateway:
a. CentraSite invokes the API Gateway’s deployer service and pushes the consumer applications that are ready for deployment to the API Gateway.
b. Instantly, API Gateway deploys the consumer applications that were received from CentraSite and notifies CentraSite when the deployment process is complete.