STEP 10. Configuring IBM AD Cross Application Service

IBM® AD Cross Application Service is an additional service that needs to be configured to show calls between different mainframe projects that have their databases on the same DB instance in IBM AD Analyze Client.

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

Important: The configuration of the following parameters is not mandatory. It is recommended to follow below steps only in case that you had previously configured these parameters and you performed an upgrade to the latest version of IBM AD product.
On the machine where IBM AD Cross Applications Service is installed, go to <IBM ADDI Installation Folder>/IBM Application Discovery Cross Applications 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 Cross Applications 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 Cross Applications 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 Cross Application Service.
    • Keystore password is the keystore password.
  3. Leave blank the line where the authSrv parameter is present if Authentication Server (DEX) is not needed.
    #authentication server URL
    authSrv:
    Otherwise, 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. (Optional) 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. The default value of the disableAuth parameter is true. Leave the default value if Authentication Server (DEX) is not needed.
    #disable authentication/authorization. allow all files to be sent
    disableAuth: true
    
    Otherwise, set the disableAuth parameter to false. The false value keeps enabled the authentication.
    #disable authentication/authorization. allow all files to be sent
    disableAuth: false
    
  5. Optionally, you can decide what project resolutions to display in the analysis, when more projects contain the same program definition.
    #optional: force resolution target
    #program name pattern from source project will be solved only in target project
    restrictions:
     - pattern:  "Program1"
       from.project: Project1
       to.project: Project2
       
    Where:
    • pattern - represents the name of the program which has the source present in other projects.
    • from.project - represents the project that contains the program without the source.
    • to.project - represents the project resolution that you decide to show in the analysis.

2. Make IBM AD Cross Application Service available in IBM AD Configuration Server

By adding a restriction in the Cross Applications Service page, you can decide what project resolutions to display in the analysis, when more projects contain the same program definition.

After IBM AD Cross Applications Service is up and running, go to IBM AD Configuration Server and make IBM AD Cross Applications 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 > Cross Applications Service. The Cross Applications Service settings page is displayed.
  2. To add a new restriction, click the Add button. As a result, the Add Restriction page is displayed.
  3. In the Pattern field, enter the name of the program that has the source present in other projects.
  4. In the From Project field, choose the project that contains the program without the source
  5. In the To Project field, choose the project resolution that you decide to show in the analysis.
  6. Click Save.

3. Restart IBM AD Cross Application Service

  • On Windows
    1. Once the configuration is done, go to the Dashboard tab, in IBM AD Configuration Server, click the menu button of Cross Applications 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 cross.log file under <IBM ADDI Installation Folder>/IBM Application Discovery Cross Applications Service/log folder.
Important: At this installation and configuration point, everything is put in place for having analysis available in IBM AD Analyze Client. To take full advantage of the available analysis functionality, you need to install IBM AD Analyze Client. For more information see, Installing IBM AD Analyze Client.