How to Create and Publish Web Services to CA API Gateway › Publish Web Services

Publish Web Services

Gen web services are deployed to one of the support web application servers: JBoss, WebLogic, or WebSphere. The web service must be deployed to one of these servers before it can be published into the CA API Gateway.

Note: CA Gen web services are published to the folder named CA Gen in the CA API Gateway. If the folder does not exist, it will be created before the service is published.

Follow these steps:

1. After creating an interface and adding that interface to a web service in Gen Studio, right-click the web service definition and select Publish to CA API Gateway.

   Note: A Gen web service definition contains multiple operations.

2. Enter the CA API Gateway properties and the Service properties in the Publish Web Service dialog.

   The properties and its description are as follows:

   CA API Gateway Properties

   CA API Gateway URL

   Specifies the location of the CA API Gateway server.

   The format of the CA API Gateway URL is:

   https://CAAPIGateway_hostname:portnumber/wsman

   Example: https://CAAPIGateway.ca.com:8443/wsman

   Important! Do not delete the CA API Gateway Client web service (wsman) in the CA API Gateway Policy Manager. Ensure that this client web service is running to publish a web service.

   User Name

   Specifies the CA API Gateway user name.

   Password

   Specifies the CA API Gateway password.

   Context

   Specifies the alias name of the web service in the CA API Gateway.

   Example: If Target URL is http://localhost:8080/Calculator/calculate and the context is calc, the published CA API Gateway URL is http://<CAAPIGateway_URL>/calc.

   Service Properties

   Service Name

   Specifies the web service definition name. This field is automatically populated with the selected web service definition name and is not editable.

   Target URL

   Specifies the URL location of the deployed web service. This URL is used to publish the web service in CA API Gateway. The format template that is shown is based on the selected Application Server.

   AppServer

   Indicates one of the following application servers where the web service is deployed to:

   Other

   Select this option if the web service was customized using the PStep Interface Designer.

   The format is as follows:

   http://hostname:port/selected_web_service_name

   Example: http://hostname:port/webservice1

   JBoss

   Select this application server when the procedure step was published and deployed in JBoss.

   The format is as follows:

   http://hostname:port/load_module_name/procedure_step_name

   Example: http://hostname:port/sample-P900/SERVER_MAINTAIN_DEPARTMENT

   WebLogic

   Select this application server when the procedure step was published and deployed in WebLogic.

   The format is as follows:

   http://hostname:port/procedure_step_name_Bean/procedure_step_name

   Example: http://hostname:port/LIST_SCORING_RECORD_Bean/LIST_SCORING_RECORD

   WebSphere

   Select this application server when the procedure step was published and deployed in WebSphere.

   The format is as follows:

   http://hostname:port/load_module_name/procedure_step_name

   Example: http://hostname:port/sample-P900/SERVER_MAINTAIN_DEPARTMENT

3. Click Finish to close the dialog and the web service is published to CA API Gateway.

When the web service is published successfully, the following message is displayed:

Publishing is successful. URL: <CA API Gateway URL/Context>

The CA API Gateway properties details (CA API Gateway URL and user name) are stored in a properties file in the configuration folder at the following location:

C:\Users\<username>\AppData\Local\CA\Gen 8.5\cfg\GenStudio\configuration\Layer7\Layer7.properties

When you want to publish another web service, the CA API Gateway user name and URL are populated in to the Publish Web Service dialog from the properties file. If necessary, you can modify the values in the dialog.

Note: If the web service already exists in CA API Gateway, a confirmation message is prompted to update an existing service. If Yes, the service is updated with a new Target URL. If No, no action is performed.