Configuring embedded chat window

You can configure web chat for embedded chat window and integrating applications.

Before you begin

You must install PostgreSQL. For more information, see Installing PostgreSQL.

About this task

If you enable webchat in the bnz-server.yaml file, you must configure the bnz-web-chat.yaml file.

If you want to integrate with chat window as an integrating web application, you must add a folder with the name of your web application in the /config/webChat/integratingApps/. The yaml file sitemap.yaml in the integratingApps folder can help your web application with embedded chat window to driven pages.

Procedure

Go to the Z ChatOps configuration directory.
- For container users:
  1. Go to the directory where you extract the IBM Z® ChatOps container archive.
  2. Run the following command to open an interactive shell on the IBM Z ChatOps container that is running.
```
./bnzContainer.sh shell
```
  3. Go to the configuration directory.
```
cd config
```
    Tip: If you are familiar with docker/podman commands, you can use commands to open the interactive bash shell. You can also edit the configuration files directly in the mounted path of the zchatops-configuration-1144, zchatops-configuration-1143, zchatops-configuration-1142, zchatops-configuration-1141, or zchatops-configuration-114 volume.
- For native installation users:
```
cd $ZCHATOPS_HOME/config
```
Go to the web chat directory.
```
cd webChat
```

Edit the web chat configuration file bnz-web-chat.yaml.

# Licensed material - Property of IBM
# © Copyright IBM Corporation 2023.
# This file controls all configurations of the chat window server for IBM Z ChatOps

# Specify the bot name of your web chat bot.
# The default value is bnz.
botName: bnz

# Configure webSocket
webSocket:
  # Specify the protocol of your webSocket server. The value can be wss or ws.
  # The default value is wss.
  protocol: wss
  # Specify the port number of your webSocket server.
  # The default value is 6001.
  port: 6001

Go to the integratingApps directory.
```
cd integratingApps
```
For new integrating web application: copy the integratingAppId folder and paste in the integratingApps directory and name it with the unique integrating web application name.

For driven page of integrating web application: edit the sitemap.yaml file in the folder that you create in Step 5:

# icensed material - Property of IBM
# © Copyright IBM Corporation 2023.
# This file controls one sitemap of the chat window server for IBM Z ChatOps

# Configure the urlSet
urlSet:
  - url:
      loc:
      keywords:
        - 
      description:

For more information about driven page and sitemap, see Generating driven pages.

Run the bnzsvr restart command to restart Z ChatOps for the changes to take effect. For more information, see Starting and stopping Z ChatOps.

What to do next

Integrate with embedded chat window. For more information, see Integrating with embedded chat window.