Task 6: Deploy the chat service

In this task, you will install the chat service for End User Chat.

Note To enable Collaboration with LDAP, comment the follow line in sm.ini and then restart the Service Manager server:

ldapauthenticateonly:1

Follow these steps:

  1. Save the chat service installer sm9.61.xxxx_ChatMSVC.zip from Service Manager installation package to the same computer on which the chat server was deployed.
  2. Log on to your Openfire Administration Console.

  3. Click the User/Groups tab and create an Openfire user. For example:

    User name: publishadmin

    Password: admin123

  4. To enable the virtual agent, click Server > Server Settings > REST API. Enable REST API and record the secret key auth.

  5. Save your changes, and then restart the Openfire chat server.
  6. Run tso_srv_slvt.bat to create the following certificate files:

    Directory Files
    Certs\

    Cacerts
    clientpubkey.cert
    mycacert.pem
    mycacert.srl
    scclientcert.pem
    smservercert.pem
    trustedclients.keystore

    Key\ cakey.pem
    server.keystore
    <FQDN of the Chat Service host>.keystore

    Note

    • When running tso_cln_svlt.bat, you need to append the FQDN of the Chat Service host as the bat parameter. For example, tso_cln_svlt.bat training.sm-demo.com. Make sure that you type the same FQDN of the Chat Service host when you are asked to enter your first and last name.

    • After the client keystore is created, update the new trustedclients.keystore file in C:\Program Files (x86)\Micro Focus\Service Manager 9.60\ChatServer\resources\security folder and rename the file to client.truststore.

  7. Copy the CA certificates file (Cacerts) and the chat service client keystore (<FQDN of the Chat Service host>.keystore) to the C:\Program Files (x86)\Micro Focus\Service Manager 9.60\ChatService\conf folder.

  8. Run tso_2nd_srvs_svlt.bat to generate a second server.keystore by following the instructions as described in Task 5: Deploy the chat server > Replace the server certificate and OpenSSL connection > step 3 in this document.
  9. Configure SSL in the Service Manager server and web tier by following the instructions as described in Example: Enabling trusted sign-on.

  10. Extract sm9.61.xxxx_ChatMSVC.zip to C:\Program Files (x86)\Micro Focus\Service Manager 9.60\ChatService.

  11. Copy app.properties and config.yml from C:\Program Files (x86)\Micro Focus\Service Manager 9.60\ChatService\conf\samples\https to C:\Program Files (x86)\Micro Focus\Service Manager 9.60\ChatService\conf, and replace the original files. Open the chat service configuration file app.properties with a text editor.

  12. Update the related parameters:

    Parameter Description
    daoFactory.serviceEndPoint The Service Manager server’s URL.
    daoFactory.username

    The Backend user name for chat service to access Service Manager.

    Important The backend user must be an SM user with the "system administrator" privilege and the “RESTful API” capability.

    daoFactory.password The daoFactory user password.
    pubSubServiceConfig.userName The user name created in step 3.
    pubSubServiceConfig.password The user password created in step 3.
    chatServerConfig.domain The domain user filled during install chat server.
    chatServerConfig.host The chat server computer name or IP.
    chatServerConfig.restApiSecretKey The secret key you recorded in step 4.
  13. Save your changes and close this file.
  14. To install the chat service as a Windows service, open a DOS command prompt and change the directory to C:\Program Files (x86)\Micro Focus\Service Manager 9.60\ChatService\bin.
  15. Run the install-service.bat command to install the Service Manager chat service as a Windows service.

    Note We recommend using 64-bit Java because 32-bit Java may have potential performance limitations. However, if you are working with 32-bit Java, follow these steps so that the Service Manager chat service Windows service can start successfully:

    1. Open C:\Program Files (x86)\Micro Focus\Service Manager 9.60\ChatService\bin\startup.bat with a text editor.

    2. Update the memory setting as follows:

      SET CHAT_SVC_JVM_OPTIONS=-XX:ThreadStackSize=256 -Xms512m -Xmx1024m

    3. Save your changes and close this file.
    4. Open C:\Program Files (x86)\Micro Focus\Service Manager 9.60\ChatService\bin\ install-service.bat with a text editor.

    5. Update the ThreadStackSize memory setting to ThreadStackSize=256 -Xms512m -Xmx1024m.

    6. Save your changes and close this file.

    You can run nssm edit SmChatService to edit the corresponding configurations after the Windows service is installed.

    Tip To remove this Windows service, run the nssm remove SmChatService command.