IBM AD Web Service

Edit online

IBM® AD Web Service collects the data that is provided by Web Service Metrics component and prepares it for delivery.

IBM AD Web Service parameters are stored in the webservice.properties file in the /conf folder under IBM AD Batch Server installation folder.

The following parameters can be set:

The IP address or hostname of the computer where IBM AD Web Service is installed. The default value is 0.0.0.0 (all interfaces). Another valid value is the external IP of the computer.
```
## web service host
#host=
```
The port no. to be used by the IBM AD Web Service; the default port is 8090, if no other value is specified the default value will be used.
```
## web server port
## default: 8090
#port=
```
The administrative port number to be used by IBM AD Web Service; the default administrative port is 8099, if no other value is specified the default value will be used.
```
## web service administrative port
## default: 8099
#admin-port=
```
Relative path to the Web Service directory under <IBM Application Discovery and Delivery Intelligence installation folder>\IBM Application Discovery Batch Server\data\tmp directory.
```
## web service directory
web-dir=webdata
```
Relative path to the JSON files directory under <IBM Application Discovery and Delivery Intelligence installation folder>\IBM Application Discovery Batch Server\data\tmp directory.
```
## json files directory
rest-dir=wsmetrics
```
The auth-file that contains the web service authentication data.
```
## authentication info for the web service
auth-file=auth.properties
```
The file auth.properties that is created by the authConfigTool.bat is located at <IBM Application Discovery and Delivery Intelligence installation folder>\IBM Application Discovery Batch Server\conf.
The keystore-file that contains the SSL certificate.
```
##ssl keystore file
keystore-file=keystore.jkl
```
The keystore-file, keystore-storepass (the keystore password), and keystore-keypass (the key password) are optional. If you need to run IBM Application Discovery Web Service (IBMApplicationDiscoveryWebService) over HTTPS, make sure that all the following prerequisites are met.
- The keystore-file argument is provided.
- The password for keystore-storepass is present.
- The password for keystore-keypass is present.
Complete the steps that are described at Configuring Security Settings. Then, specify the keystore and password that are created for IBM AD Batch Server in the webService.properties file.

If one of the certificates/keystore and password is missing, the Web Service will run over HTTP.

The log-conf-file that contains the log configuration data.

## log configuration file
log-conf-file=webservice.log4j2.properties

After the parameters are set, make sure to complete the following steps before you use Web Service Metrics.

Access Start Menu > IBM Application Discovery and Delivery Intelligence > Launch IBM Application Discovery Configuration Service Admin, and go to Configure > Environments > "Your environment" > Services > Batch Server Service. The Batch Server Service settings page is displayed.
Select the projects on which IBM AD Batch Server will operate.
Select the wsmetrics component that will run on the selected projects.
Restart IBM AD Batch Server by navigating to the Dashboard tab and accessing IBM AD Configuration Server. Then, click the menu button of Batch Server Service, and select Restart Service.
Build the project for which you want the wsmetrics to take effect. Once the build process is finished and the Batch tasks are complete, go to <IBM Application Discovery and Delivery Intelligence installation folder>\IBM Application Discovery Batch Server\data\tmp\wsmetrics. You can find a projects.json file and a folder for each project where the IBM Application Discovery Web Service (IBMApplicationDiscoveryWebService) was executed by the IBM AD Batch Server. Then, you can use IBM Application Discovery Web Service (IBMApplicationDiscoveryWebService).
Launch a command prompt with administrative privileges. Run authConfigTool.bat that is located at <IBM Application Discovery and Delivery Intelligence installation folder>\IBM Application Discovery Batch Server, and enter your credentials as instructed. Once the script confirms that the credentials are stored successfully, verify that the auth.properties file has been created at <IBM Application Discovery and Delivery Intelligence installation folder>\IBM Application Discovery Batch Server\conf\.
To ensure that the newly provided credentials are recognized, restart Web Service by navigating to the Dashboard tab and accessing IBM AD Configuration Server. Then, click the menu button of Web Service, and select Restart Service. You can now make HTTP requests to the service by using the previously configured credentials.
Notes:
- The credentials that are generated with the authConfigTool are only used by the IBM Application Discovery Web Service (IBMApplicationDiscoveryWebService) in Windows Services (services.msc). The user ID that is defined does not need to match any existing credentials already in IBM Application Discovery.
- To apply any changes that are made to the generated file auth.properties by using the authConfigTool, restart IBM Application Discovery Web Service (IBMApplicationDiscoveryWebService). The service can from be started from Windows Services (services.msc) by locating IBM Application Discovery Web Service (IBMApplicationDiscoveryWebService) and by clicking Restart.
- These credentials are used to validate and secure any requests that are made to the service. Unauthorized users that do not have the access to these credentials cannot access the data that is provided by this service.