Viewing the Gateway List and Gateway Details
Pre-requisites:
To view a list of available gateways for an organization, you must have one of the following roles:
CentraSite Administrator: instances of
API Gateway,
API Portal,
Mediator, and
Insight Server gateways in any organization in
CentraSite.
Organization Administrator: instances of
API Gateway,
API Portal,
Mediator, and
Insight Server gateways in your organization.
API Gateway Administrator: instances of
API Gateway in the specific organization to which your
API Gateway Administrator role applies.
API Portal Administrator: instances of
API Portal gateway in the specific organization to which your
API Portal Administrator role applies.
Mediator Administrator: instances of
Mediator and
Insight Server gateways in the specific organization to which your
Mediator Administrator role applies.
In addition to the above, you can also view the details of a gateway instance if you have the Full, Modify, or at least View instance-level permission on the gateway itself.
You view the list of gateway assets using the Governance Rules activity in CentraSite Business UI. In addition, you can view gateway details, modify gateway details, publish (register) and unpublish (unregister) gateways, view gateway asset dependencies, and monitor runtime performance metrics in the Gateway Details page.
To view the list of gateways and gateway details
1. In the CentraSite Business UI activity bar, click Governance Rules.
2. To filter the list to display the available API Gateway, API Portal, Mediator, and Insight Server 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 the required type of gateway asset from the drop-down list:
API Gateway API Portal Mediator Insight c. Click the plus button next to the drop-down box or press Enter to add the scope to the search recipe.
CentraSite displays the list of available API Gateway, API Portal, Mediator, and Insight Server gateways.
The Search Results page provides the following basic information for each gateway:
Column | Description |
Name | The name of the gateway. |
Description | A descriptive information about the gateway. |
Created Date | The date on which the gateway was created in the CentraSite registry. CentraSite automatically sets this attribute when an administrator creates and registers the gateway with CentraSite. Note that once a gateway is created, the value of this field cannot be modified. |
Owner | The user to which the gateway belongs. |
Organization | The organization to which the gateway belongs. |
Version | The system-assigned version identifier for the gateway. |
Select an attribute from the Sort by box to sort API Gateway assets by name, description, and date last modified in the Search Results page.
Use the View menu to selectively display the Sort by attributes by specifying them individually.
The Search Results page displays one or more actions that you can perform in CentraSite:
Action | Description |
Add Gateway | Create a new API Gateway asset in CentraSite. |
Publish | Register an API Gateway asset with CentraSite. |
Unpublish | Unregister an API Gateway asset from CentraSite. |
Delete | Remove an existing API Gateway asset from CentraSite. |
3. In the displayed list, select the gateway whose details you want to examine.
This opens the Gateway Details page. You can also perform the following operations in the Gateway Details page:
Action | Description |
Edit | Modify the details of API Gateway asset. |
Save | Update the modified details of API Gateway asset. |
Delete | Remove the API Gateway asset from CentraSite. |
Add to List | Add the API Gateway asset to your favorites list. |
View Report | Generate reports that contain the specific information for API Gateway asset. |
Asset Navigator | Visualize the dependencies to and from the API Gateway asset. |
Permissions | Set instance-level permissions on the API Gateway asset. |
Publish | Register an API Gateway asset with CentraSite. |
Unpublish | Unregister an API Gateway asset from CentraSite. |