Help Center/ Customer Engagement Center/ Development Overview/ Development Preparations/ Configuring the Mode for Agents to Log In to the CC-Gateway
Updated on 2025-10-17 GMT+08:00
View PDF
Share

Configuring the Mode for Agents to Log In to the CC-Gateway

Before integration development of agent capabilities, you need to configure the mode for agents to log in to the CC-Gateway. You can use either the HTTPS or WebSocket mode. You can determine whether to use the HTTPS or WebSocket mode based on configuration files.

To change the login mode, you need to modify parameters in the CC-Gateway configuration files. If the NSLB is used, ensure that proxy policies exist for both modes in the NSLB.

The WebSocket mode cannot be used in integrated deployment scenarios. If both WebSocket and HTTPS modes need to be used, you can prepare a dedicated CC-Gateway server and add routing rules on the NSLB to route WebSocket requests to the dedicated CC-Gateway server.

Modifying the CC-Gateway Configuration Files

  • In the /home/elpis/tomcat/webapps/agentgateway/WEB-INF/config/basic.properties file, modify the configuration as required. 
    WEBSOCKET_PROTOCOL_SWITCH = OFF (The default value OFF indicates that the HTTPS mode is used.)
WEBSOCKET_PROTOCOL_SWITCH = ON (The value ON indicates that the WebSocket mode is used.)
  • In the /home/elpis/tomcat/conf/catalina.properties file, modify the configuration as required. 
    openas.annotation.enable = true (The value true indicates that the WebSocket mode is used.)
openas.annotation.enable = false (The value false indicates that the HTTPS mode is used.)

Modifying NSLB Routing Rules

You have configured the mode for agents to log in to the CC-Gateway by modifying the CC-Gateway configuration files basic.properties and catalina.properties. However, if requests are transmitted to the CC-Gateway through the NSLB, you need to configure the JSON rules of the NSLB. The NSLB can function as a proxy for both HTTPS and WebSocket modes at the same time.

Go to /home/nslb/aicc_nslbrule and find the JSON rule files corresponding to the two modes.

  1. ccgateway_proxy.json: used for the HTTPS mode
  2. ccgateway_websocket_proxy.json: used for the WebSocket mode
If the HTTPS mode is used, retain the default values in the two JSON rule files. If the WebSocket mode is used, modify the following parameters in the ccgateway_websocket_proxy.json file: 
name==aicc-gw-wss (Change the default name to a customized one, for example, aicc-gw-wss and avoid setting it to the same name as that of the HTTPS mode.)
listen==38043 (Change the default value 8043 to a customized value, for example, 38043 and avoid setting it to 8043, which is the default value of the HTTPS mode.)
If the ccgateway_websocket_proxy.json file is modified, you need to import and load it for the modification to take effect. 
$ nslbctl import ccgateway_websocket_proxy.json append

A message is displayed, indicating that the import is successful.

Check the information, for example, the new proxy of the CC-Gateway whose listen is set to 38043. 
# nslbctl list

Parent topic: Development Preparations