Configuring

Edit online

Complete the following steps to configure IBM® watsonx Code Assistant™™ for Z Understand (Z Understand) on Linux®.

Before you begin

The Z Understand container must be already installed on the system. For more information, see Installing.

Procedure

Navigate to the folder where the Z Understand container was extracted in the Terminal.
For example, enter the following line to navigate to /opt/wca4z-understand:
```
cd /opt/wca4z-understand
```
Clone the setup.sample.json configuration file and rename it to setup.json.
To do so, run the following command:
```
cp setup.sample.json setup.json
```
This file is used for the initial configuration of the Z Understand container and can be deleted afterward.
Open the newly created setup.json file by running the following command:
```
vi setup.json
```
Modify the opened setup.json file as follows:
1. Replace all the values enclosed with <INSERT_*****> with actual values.
2. Press the i key on the keyboard to enable keyboard input in the editor.
3. Update the generalSettings section and replace <INSERT_HOSTNAME> with the FQDN (fully qualified domain name) of the local machine.
  
  Note: Configuring by using an IP is currently not supported.
4. 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 the database password.
  - Replace <INSERT_DATABASE_TYPE->sqlserver|db2> with sqlserver or db2.
5. Update the graphDatabaseServer section and replace <INSERT_GDB_PASSWORD> with a new password. This password must be at least 6 characters long and have a lowercase letter, an uppercase letter, and a special character.
6. Update the userAccess section and replace <INSERT_ADMIN_PASSWORD> with a new password. This password must be at least 6 characters long and have a lowercase letter, an uppercase letter, and a special character.
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.
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.
When the process ends, the Z Understand container is ready to be used.
Private preview Run 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.
2. Click Configure tab.
3. Configure page appears.
4. Click Servers and Security section.
5. On the left pane, click Vector database server.
6. Enter Host, Server port, Username, Password, Protocol type, and optionally server certificate, then click Save.
7. On the left pane, click Z Code Assistant.
8. Select Enable integration with Z Code Assistant to provide URLs for watsonx Code Assistant for Z cloud services. To connect Semantic Indexer with the default IBM Cloud® deployment, do not modify the URLs and retain the default values.
  Note: Enter a new value if you are instructed by an IBM representative.

What to do next

You can register the Z Understand container as a system service and start it automatically on machine boot.

To do so, proceed as follows:

Run the following script from the container installation path:
```
./install-as-a-service.sh
```
This script creates an wca4z-understand system-level service. You can start, stop, or restart the service, or check its status by using the systemctl command as follows:
```
systemctl start wca4z-understand
```
```
systemctl stop wca4z-understand
```
```
systemctl restart wca4z-understand
```
```
systemctl status wca4z-understand
```
Create and manage analysis projects, as it is explained in Managing analysis projects.