API Management 10.4 | Using CentraSite | Runtime Governance | Gateway Management | Managing Gateways through CentraSite Business UI | Modifying Gateway Asset Details
 
Modifying Gateway Asset Details
Pre-requisites:
To modify the information of 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 Administrator role applies.
In addition to the above, you can also view the details of a gateway instance if you have the Full or at least Modify instance-level permission on the gateway itself.
You modify the existing information of a gateway asset using the Edit action in the Gateway Details page.
Note: If you do not see the Edit action in the Gateway Details page, it is probably because you do not have the required role or permission to modify the details of a gateway in CentraSite.
When you modify the details of a gateway, keep the following points in mind:
*To modify the details of a gateway in CentraSite, you must unpublish (unregister) the gateway from CentraSite, make the required changes, and then republish (register) the gateway to CentraSite.
*CentraSite does not allow you to directly modify the endpoint URL of a gateway, and tenant user information of an API Portal gateway, if you have one or more APIs associated to it. If you still continue to modify the information, CentraSite displays a warning message.
*When you make changes to the endpoint of a gateway, for example API Gateway, you must update the details page of the API Gateway with the new configuration, and then republish the API Gateway to CentraSite to put those changes into effect.
*Some attributes accept only specific types of information. For example, for a URL type attribute, you must supply a URL when you edit that attribute.
*Some attributes are designed to be read-only and cannot be edited even if they appear in a gateway on which you have Modify or Full permission.
* To modify the details of a gateway asset
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.
3. In the displayed list, select the gateway whose details you want to modify.
This opens the Gateway Details page. The details include:
*The gateway asset's Basic Information. This includes the gateway's asset type, short description about the gateway, the last modified date, the owning organization, and the user. In addition to the above information, gateway instance includes the following details:
*The Web application URL of webMethods API Gateway.
*The Home page URL of webMethods API Portal.
*Name of an onboarding organization for API Portal users in CentraSite.
*The CentraSite Communication information. This includes the endpoint URL of CentraSite, and the username of a CentraSite user.
*The API Gateway Communication information. This includes the endpoint URL of API Gateway, and the username of a technical user in API Gateway.
A technical user displayed in the API Gateway Communication profile is used to publish API assets from CentraSite to API Gateway, and a user who is part of the MyAPIGateway Synchronization Group is used to send data from API Gateway to CentraSite.
*The API Portal Communication information. This includes the endpoint URL of API Portal gateway, and the username of a technical user in API Portal.
*The Mediator Communication information. This includes the endpoint URL of Mediator gateway, and the username of a user who is part of the MyMediatorGateway Synchronization Group.
*The list of API assets published to the gateway.
4. On the actions bar of the Gateway Details page, click Edit.
5. In the Basic Information profile, modify the properties of the displayed data fields, as required.
Field
Description
Name
Name of the gateway.
Organization
Name of the organization to which the gateway belongs.
Onboarding Consumer Organization
For API Portal gateway only. Name of the organization that contains the users of API Portal gateway.
Note: You are not allowed to modify the value of this field if there is at least one API Portal user onboarded in this organization.
Owner
Name of the user to which the gateway belongs.
Description
Description of the gateway.
6. In the CentraSite Communication profile, modify the properties of the displayed data fields, as required. This is applicable only for API Gateway, API Portal, and Mediator gateways.
Field
Description
Endpoint
The endpoint URL of CentraSite.
Username
The user ID of the CentraSite user who has one of the following appropriate roles:
*CentraSite Administrator
*Organization Administrator
*API Gateway Administrator
*API Portal Administrator
*Mediator Administrator
*Insight Server Administrator
Password
The password of the CentraSite user specified in the above Username field.
7. In the API Gateway / API Portal / Mediator Communication profile, modify the properties of the displayed data fields, as required. This is applicable only for API Gateway, API Portal, and Mediator gateways.
Field
Description
Endpoint
Read-only. The endpoint URL of API Gateway, API Portal, or Mediator gateway.
API Gateway WebApp URL
This is applicable only for API Gateway.
The Web application URL of API Gateway. For example, http://myHostname:9072.
Note: Various aspects of the way API Gateway WebApp URL functions are as follows:
*If a value is specified for this attribute, then CentraSite uses this URL as the API Gateway Web application URL.
*If a value is not specified for this attribute, then CentraSite automatically populates the dynamic URL based on the value that was sent by API Gateway on publishing the API Gateway asset from CentraSite to the API Gateway instance.
API Gateway sends the Web application URL based on the value specified in the Web application load balancer URL field in API Gateway (go to <Username> > Administration > General > Load balancer) as described in webMethods API Gateway Administrator's Guide.
For example,
*if a value is specified for this field, API Gateway sends the defined Web application load balancer URL to CentraSite.
*if the value is not specified for this field, API Gateway sends the default hostname and port number as Web application URL to CentraSite. For example:
http://myHostname:9072
Important: If you are modifying the value of this API Gateway WebApp URL attribute, you have to republish the API Gateway asset for the changes to take effect.
Tenant
This is applicable only for API Portal gateway.
Name of a tenant user in API Portal gateway.
Important: You are not allowed to change the value of Tenant property if there is an API already published to this gateway.
Use CentraSite Credentials
This check box enables the usage of CentraSite credentials for authenticating against this gateway.
Username
The user ID of the API Gateway, API Portal, or Mediator user who has an API Runtime Provider role in CentraSite.
Password
The password of the user specified in the above Username field.
Sandbox
The sandbox category of the gateway.
8. In the Published APIs profile, examine the following information.
Attribute
Description
Name
A deep link to open the API asset details page directly in CentraSite Business UI.
Description
A descriptive information of the asset.
Version
The user-assigned version identifier for the asset.
View in API Gateway
This is applicable only for API Gateways.
A deep link to open the API asset details page directly in the API Gateway user interface.
View in API Portal
This is applicable only for API Portal gateways.
A deep link to open the API asset details page directly in the API Portal user interface.
9. Click Save to save the updated gateway.
If you have made changes to the CentraSite communication information, such as the CentraSite Username or Password field, publish the gateway again.
Copyright © 2015- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release