Configuring IBM AD Analyze Client

If IBM AD Analyze Client is installed together with IDz, make sure to add the following lines in the eclipse.ini or developer_for_zos.ini configuration file in the -vmargs section. Avoid blank lines in the -vmargs section.

• If you installed IDz with Eclipse p2, add the following lines.

  -Dorg.osgi.framework.os.name=win32
  -Dsun.awt.noerasebackground=true
  -Dsun.java2d.noddraw=true

• If you installed IDz with IBM Installation Manager , add the following lines.

  -Dsun.awt.noerasebackground=true
  -Dsun.java2d.noddraw=true

Eclipse IDE startup is controlled by the options in eclipse.ini. Make sure that for each Eclipse version that is used, your installed Java™ version is compatible with the recommendations of Eclipse. For more information about Eclipse compatibilities with Java versions, see Prerequisite Software and Configurations.

The latest supported version of Eclipse IDE for IBM AD Analyze Client is Eclipse 2022-03 (4.23), which is compatible with Java 11. Since Eclipse 2022-03 (4.23) includes Java 17 jars as prerequisites, you need to update the eclipse.ini file by specifying the path to the Java 11 installation folder in the -vm section. This step is not required for the previous versions of Eclipse IDE.

• OS-Dependent Configuration: In case Analyze Client is installed on Windows Server (any version) or Windows 10/11, you need to edit the eclipse.ini configuration file and add the following line, in the -vmargs section. Avoid blank lines in the -vmargs section.

  -Dorg.osgi.framework.os.name=win32

  

• Java-Dependent Configuration: If an AD-supported IBM Java version is used as the system Java and you want to enable the TLS V1.2 connection, make sure to add the following lines in the eclipse.ini configuration file, in the -vmargs section. Avoid blank lines in the -vmargs section.

  -Dcom.ibm.jsse2.overrideDefaultTLS=true
  -Djsse.enableCBCProtection=false

• TLS-Dependent Configuration: If IBM AD Analyze Client is configured with TLS support, to have a secured communication between IBM AD Analyze Client and IBM AD ZooKeeper, make sure to add the following lines in the eclipse.ini configuration file, in the -vmargs section. Avoid blank lines in the -vmargs section.

  ​-Dzookeeper.client.secure=true
  ​-Dzookeeper.ssl.keyStore.location=</path/to/keystore.jks>
  -Dzookeeper.ssl.keyStore.password=password
  -Dzookeeper.ssl.trustStore.location=</path/to/trustore.jks>
  -Dzookeeper.ssl.trustStore.password=password
  

  Make sure that the keystore.jks and trustore.jks files are physically present on the machine where IBM AD Analyze Client is installed and configured. You might use the keystore.jks and trustore.jks files that were generated for IBM AD ZooKeeper if both IBM AD Analyze Client and IBM AD ZooKeeper are installed on the same machine. For more information, see Activate the IBM AD ZooKeeper Server to use certificates.

• OrientDB SSL-Dependent Configuration: If OrientDB is configured with SSL in the orientdb-server-config.xml file, make sure to add the following lines in the eclipse.ini configuration file, in the -vmargs section. Avoid blank lines in the -vmargs section.

  -Dcom.ibm.ad.client.ssl.enabled=true
  -Dclient.ssl.keyStore=</path/to/client-keystore.jks>
  -Dclient.ssl.keyStorePass=password
  -Dclient.ssl.trustStore=</path/to/client-keystore.jks>
  -Dclient.ssl.trustStorePass=password

  Important:

  Make sure that the client-keystore.ks file is physically present on the machine where IBM AD Analyze Client is installed and configured, and that the correct path to client-keystore.ks is added in the eclipse.ini configuration file. The file can be found in the server machine where IBM ADDI was installed, and then obtained from the path <IBM ADDI Installation Folder>\security\<environment-id>\keystore.jks.

  Make sure that the orientdb.ks file is physically present on the machine where IBM AD Analyze Client is installed and configured, and that the correct path to orientdb.ks is added in the eclipse.ini configuration file.

• Cross Applications Service-Dependent Configuration: If IBM AD Cross Applications Service is configured and up and running, make sure to add the following line in the eclipse.ini configuration file, in the -vmargs section. Avoid blank lines in the -vmargs section.

  -Dad.http.read.timeout=100

  
• Memory Management Configuration: Eclipse must be configured to allow for optimized memory consumption. To configure Eclipse, edit the eclipse.ini file under the Eclipse installation folder and set the minimum memory parameter (marked –Xms), the maximum memory parameter (marked –Xmx). Following is an example of an eclipse.ini file containing parameters for optimized memory consumption.

  

• To use a specific language in the Eclipse interface, add the following parameter before the -startup parameter in the eclipse.ini file:

  -clean
  -nl
  language

  The -nl parameter has the following language values:

  Language value	Language
  de	German
  es	Spanish
  fr	French
  it	Italian
  ja	Japanese
  ko	Korean
  pt_BR	Brazilian Portuguese
  zh	Simplified Chinese
  zh_HK	Traditional Chinese, Hong Kong
  zh_TW	Traditional Chinese, Taiwan

  Note: The -clean parameter only needs to be present once, or the first time Eclipse is configured to be used in a specific language, and can then be removed from the eclipse.ini file for the faster startup of Eclipse/IDz.