Quick Installation

To configure the chat solution, navigate to the chat-solution/docker/environment-variables directory and perform the following steps

Core Chat Solution Configuration

To configure the core chat solution, perform the following steps.

  1. Open agent-gadget-variables.env file and enter the chat server URL (https://<fqdn>) in SERVER_URL environment variable, enter the database connector URL (https://<fqdn>/database-connector) in DB_URL environment variable, enter the file server URL (https://<fqdn>/file-engine) in FILE_SERVER_URL environment variable. Also, enter the MRE URL (https://<fqdn>/mre) in MRE_URL environment variable. 
  2. Open chat-variables.env file and enter the chat server URL (https://<fqdn>/chat) in SERVER_PUBLIC_URL environment variable.
  3. Open customer-gadget-variables.env file and enter the chat solution URL (https://<fqdn>/chat) in SERVER_PUBLIC_URL environment variable. Enter host machine FQDN in SOCKET_URL (https://<fqdn>). Customer gadget URL (https://<fqdn>/customer-gadget) in CUSTOMER_GADGET_URL environment variable, calendar api URL (https://<fqdn>/umm) in CALENDAR_API_URL environment variable, mre URL (https://<fqdn>/mre) in MRE_URL environment variable, enter the file server URL (https://<fqdn>/file-engine) in FILE_SERVER_URL environment variable.If call back functionality required,  enter the ecm url (https://<fqdn>/ecm) in CALLBACK_URL environment variable and set the value of CALLBACK_ENABLED environment variable to true .
  4. Open mre-ui-variables.env file and enter the UMM URL (https://<fqdn>) in GAT_URL environment variable. Also, enter the mre microservice URL (https://<fqdn>/mre-microservice) in MRE_MICRO_URL environment variable.
  5. Open ecm-frontend-variables.env file and enter the UMM URL (https://<fqdn>/umm) in GAT_URL environment variable.

Chat Solution Configuration with Standalone Agents

To configure the core chat solution with standalone agents, perform the following steps.

  1. Open agent-gadget-variables.env file and set the STANDALONE_AGENTS environment variable value to true.
  2. Open comm-server-variables.env file and set the IS_STANDALONE enviornment varialbe value to true.
  3. Open mre-variables.env. file and set the USER_TYPE environment variable value to DB.
  4. Open mre-microservice-variables.env file and set the USER_TYPE environment variable value to DB.
  5. After starting services, add MRE_Agent role and assign it to be an MRE Agent in UMM frontend. Assign Supervisor role to agents who are supervisors. Restart MRE or login to MRE UI to sync UMM agents with MRE. For more details see MRE User Guide on Confluence.

Chat Solution Configuration with Contact Center

To configure the core chat solution with contact center integration, perform the following steps.

  1. Open agent-gadget-variables.env file and set the STANDALONE_AGENTS environment variable value to false.
  2. Open comm-server-variables.env file and enter the primary finesse FQDN in FINESSE_1 environment variable and the secondary finesse FQDN in FINESSE_2 environment variable. Also, set the IS_STANDALONE enviornment varialbe value to false.
  3. Open mre-variables.env. file and set the USER_TYPE environment variable value to CC.
  4. Open mre-microservice-variables.env file and set the USER_TYPE environment variable value to CC.
  5. Open umm-variables.env file and enter the primary finesse FQDN in PRIM_FINESSE_IP environment variable and the secondary finesse FQDN in SEC_FINESSE_IP environment variable. Also, enter the finesse cf admin user name in FINESSE_USER and finesse cf admin password in FINESSE_PASS environment variables.
  6. To deploy the agent gadget in finesse, please follow the instructions given here.

Chat solution configuration with Rasa BOT

To configure the core chat solution with BOT, perform the following steps.

  1. Open chat-variables.env file and set BOT environment variable value to true.
  2. Open rasa-connector-variables.env file and enter the rasa api URL (http(s)://<bot-api-url>) in BOT_API_URL environment variable. Also, set the BOT_Type environment variable value to Rasa.

Chat Solution Configuration with Articulate

To configure the core chat solution with Articulate, perform the following steps.

  1. Open chat-variables.env file and set BOT environment variable value to true.
  2. Open rasa-connector-variables.env file and enter the articulate api URL (https://<fqdn>/articulate-hybrid-api) in BOT_API_URL environment variable. Also, set the BOT_Type environment variable value to Articulate.
  3. open knowledge-base-ui-variables.env file and enter the articulate api URL (https://<fqdn>/articulate-hybrid-api) in API_URL environment variable. Also, enter the UMM URL (https://<fqdn>) in UMM_URL environment variable.

Chat Solution Configuration with Reporting

To configure the core chat solution with reporting, perform the following steps.

  1. Open chat-variables.env file and set REPORTING_ENABLED environment variable value to true.
  2. Open mre-variables.env file and set ENABLE_REPORTING environment variable value to true.
  3. Open comm-server-variables.env file and set ENABLE_REPORTING environment variable value to true and set REPORTING_RONA_REASON environment variable to "RONA" or any other value like NETWORK or AGENT. NOTE: This value will only impact endedBy column in case of chat ended by RONA.
  4. Get the reporting database script from Chat-Solution/3rdPartyResources/ReportingDB-Script directory and create SQL database on external server.
  5. Open cs-reporting-connector-variables.env file and enter the external MSSQL server IP in DBURL, database user name in DBUSER, database user password in DBPWD and database name ( created in step 4) in DBNAME environment variable. Also enter the chat solution URL (https://<fqdn>/chat) in SERVER_PUBLIC_URL environment variable.
  6. Please make sure, you have already created the database on external machine, and it's accessible with the configuration done in step 4.