Configuring

Complete the following steps to configure IBM® Bob Premium Package for Z (Z Understand) on Linux®.

1. Navigate to the folder where the BobZ container was extracted in the Terminal.
   For example, enter the following line to navigate to /opt/bobz:

   cd /opt/bobz

2. Clone the setup.sample.db2.json and setup.sample.sqlserver.json database specific sample files and rename it to setup.json.
   To do so, run the following command:

   cp setup.sample.db2.json setup.json

   cp setup.sample.sqlserver.json setup.json

   This file is used for the initial configuration of the Z Understand container and can be deleted afterward.

3. Here are the two methods to modify the opened setup.json.
   1. Method 1: You can configure setup.json using plain text passwords.
   2. Method 2: You can configure setup.json using encrypted password. Here are the steps:
      1. Start the container using ./start.sh.
      2. Run the following command to enable password usage for the database, admin user, and graph database:

         ./cli.sh -encrypt <PASSWORD>

      3. Run the following command to stop the container:

         ./stop.sh

   The following steps apply to both the plain text and encrypted text password methods:
   1. Open the newly created setup.json file by running the following command:

      vi setup.json

   2. Replace all the values enclosed with <INSERT_*****> with actual values.
   3. Press the i key on the keyboard to enable keyboard input in the editor.
   4. Update the generalSettings section and replace <INSERT_HOSTNAME> with the FQDN (fully qualified domain name) of the local machine.
   5. Update the relationalDatabaseServer section with the details of your relational database server.
      • Replace <INSERT_DATABASE_HOSTNAME> with the database hostname or IP.
      • Replace <INSERT_DATABASE_USERNAME> with the database username. For example, you can enter sa for SQL Server.
      • Replace <INSERT_DATABASE_PASSWORD> with a plain text database or an encrypted password.
      • Replace <INSERT_DATABASE_TYPE->sqlserver|db2> with sqlserver or db2.
   6. Update the graphDatabaseServer section and replace <INSERT_GDB_PASSWORD> with a new plain text database or an encrypted password. This password must be at least 6 characters long and have a lowercase letter, an uppercase letter, and a special character.
   7. Update the userAccess section and replace <INSERT_ADMIN_PASSWORD> with a new plain text database or an encrypted password. This password must be at least 6 characters long and have a lowercase letter, an uppercase letter, and a special character.
   8. Update vectorDatabaseServer section and replace <INSERT_MILVUS_PASSWORD> with a new password. If the embedded Milvus Vector Database Server is not required, then you can update the scripts/environment.properties file and set MILVUS_SUPPORTED=false.
      Note: Ensure the <INSERT_MILVUS_PASSWORD> is entered in plain text format and cannot be encrypted.
4. Press the Escape key on the keyboard to exit insert mode. Then, save the file to disk and exit the editor by typing :wq and pressing the Enter key.
5. Start and configure the Z Understand container by running the following command:

   ./start.sh -c setup.json

   Wait for the configuration process to end. It usually takes several minutes.
6. When the process ends, the Z Understand container is ready to be used.
   Note: setup.json file can now be securely deleted.
7. Configure the semantic indexer.
   To configure the semantic indexer, perform the following steps only once:

   1. Log in to the Z Understand Configuration Service Admin user interface by opening https://<YOUR_HOSTNAME>:9443/ad/admin in a browser.
      Note: Z Understand container supports only 2 ports, by default 2424 for Graph Database Server and 9443 for all other services.

   2. Click Configure tab.

   3. Click Servers and Security section.

   4. On the left pane, click Vector database server.

   5. Enter Host, Server port, Username, Password, Protocol type, and optionally server certificate, then click Save.

   6. On the left pane, click Z Code Assistant.