STEP 6. Configuring IBM AD Manual Resolutions Service

1. Configure the parameters that are present in the conf.yaml file

On the machine where IBM AD Manual Resolutions Service is installed, go to <IBM ADDI Installation Folder>/IBM Application Discovery Manual Resolutions Service/conf/ and make sure that the conf.yaml is present. If the conf.yaml file is not present in the /conf folder, go to <IBM ADDI Installation Folder>/IBM Application Discovery Manual Resolutions Service/sample-conf/ and copy the conf.yaml file in the /conf folder. Open the conf.yaml file by using a text editor and enter the desired values for the parameters that are detailed below.
Note: The parameters are represented in YAML as mappings that consist of a parameter key and the value that is associated to that key. The format of the mapping is the parameter key represented by a string, which is terminated by a trailing colon that is followed by a space. The value for that parameter key is represented by a string that follows the key's colon and space. Example:
my_parameter: my_value
  1. Add the port of IBM AD Configuration Server.
    ## Coordination and Configuration Server port
    ## default 2181
    ccs.server.port: 2181
    
  2. Set the https parameter as follows:
    1. If the https parameter is set to false, a non-secured communication is used.
      #if communication should be secured with TLS
      https: false
      
    2. If the https parameter is set to true, a secured communication is used.
      Note: This step implies the use of certificates. If you want to set the communication to be secured, make sure that a certificate authority issues a signed certificate (.crt) and a private key for the certificate (.key).
      #if communication should be secured with TLS
      https: true
      
    Note: If the https parameter is set to true, an additional step needs to be performed. Locate startServer.bat file under <IBM ADDI Installation Folder>/IBM Application Discovery Manual Resolutions Service/ and replace the following line:
    set tlsoptions=
    with:
    SET keystorepath=<"path_to_keystore">
    SET keystorepass=<"password_of_keystore">
    set tlsoptions=-Djavax.net.ssl.keyStore="%keystorepath%" -Djavax.net.ssl.keyStorePassword="%keystorepass%"
    
    Where:
    • Path to keystore is the path to the keystore that holds the certificate for IBM AD Manual Resolutions Service.
    • Keystore password is the keystore password.
  3. Set the authSrv parameter as follows:
    1. If the value of the https parameter is set to true, add the URL of Authentication Server (DEX) where authSrv parameter is present. Authentication Sever (DEX) that belongs to the IBM AD package is used. For more information, see STEP 4. Configuring Authentication Server (DEX). Example:
      #authentication server URL
      authSrv: https://WIN-ASK7V692EKB.ferdinand2.com:7600/dex
    2. If the value of the https parameter is set to false and the Authorization and Authentication feature is enabled, add the URL of Authentication Server (DEX). Example:
      #authentication server URL
      authSrv: http://WIN-ASK7V692EKB.ferdinand2.com:7600/dex
  4. Set the disableAuth parameter to false. The false value keeps enabled the authentication.
    #disable authentication/authorization. allow all files to be sent
    disableAuth: false
    

2. Make IBM AD Manual Resolutions Service available in IBM AD Configuration Server

The IBM AD Manual Resolutions Service manages the manually added resolutions and it is mandatory to be configured if you want to use Callgraph-based analyzes (graphs or reports).

After IBM AD Manual Resolutions Service is up and running, go to IBM AD Configuration Server and make IBM AD Manual Resolutions Service available for the other IBM AD components as follows:
  1. Access Start Menu > IBM Application Discovery and Delivery Intelligence > Launch IBM Application Discovery Configuration Service Admin, and go to Configure > Environments > "Your environment" > Services > Manual Resolutions Service. The Manual Resolutions Service settings page is displayed.
  2. If necessary, you can modify the path where the journal files are created. The path where these files are generated is separated from the project's path and needs to be accessible only for IBM AD Manual Resolutions Service. Once a project is imported, a folder with the same name is generated in the related path and it hosts all the files that are needed to manage dynamic call resolutions. Example:
    C:\AD\Resolutions
  3. Optionally, the main path where the manual resolutions are created for each project, can be overwritten. Click Add, select the target project, and add the path where the manual resolutions are created for the target project.
  4. Click Save.

3. Restart IBM AD Manual Resolutions Service

  • On Windows
    1. Once the configuration is done, go to the Dashboard tab, in IBM® AD Configuration Server, click the menu button of Manual Resolutions Service, and select Restart Service.
      Note: Wait until the service is restarted, this can take a few minutes to complete.
    2. If the service does not start, check the manualres.log file under <IBM ADDI Installation Folder>/IBM Application Discovery Manual Resolutions Service/log folder.
  • On Linux®
    1. Go to <IBM ADDI Installation Folder>/IBM Application Discovery Manual Resolutions Service/ and locate the startServer.sh file.
    2. In case that the .sh file is not executable, open a terminal and run the following command for flagging them as executable:
      chmod +x startServer.sh
    3. If the service does not start, check the manualres.log file under <IBM ADDI Installation Folder>/IBM Application Discovery Manual Resolutions Service/log folder.