The websocket protocol (WebSocket) is used in bpm'online to run custom processes, notifications, and for integration with telephony. It is important to enable and configure this technology for all system functions to operate correctly.
The technology can be configured in two ways: In the first case, Windows Server 2012 or Windows 8/10 with installed Internet Information Services (IIS) version 8 or higher must be deployed on the application server. Additional configuration to use a secure HTTPS connection is not required.
If bpm'online is deployed on Windows Server 8 or older, you will need perform additional ports configuration. In addition, you will not be able to use the advantages of HTTPS.
Contents
•Configuring websockets for Windows Server 2012
•Configuring websockets for Windows Server 8
Configuring websockets for Windows Server 2012
To configure websockets in bpm'online deployed on a server running on Windows Server 2012:
1.Edit the Web.config file that is located in the root folder of bpm'online. You must disable inheritance and specify restrictions on the length and query execution time.
<location path="." inheritInChildApplications="false">
<system.web>
...
<httpRuntime maxRequestLength="102400" executionTimeout="28800" targetFramework="4.5" />
2.Edit the Web.config file located in the [Path to the root bpm’online directory]\Terrasoft.WebApp\ directory. Here you need to specify a port for clients to connect to, restrictions on length and execution time of HTTP requests, and additional moduls calling.
<wsService type="Terrasoft.Messaging.MicrosoftWSService.MicrosoftWSService, Terrasoft.Messaging.MicrosoftWSService" encrypted="false" portForClientConnection="2011" />
...
<location path="." inheritInChildApplications="false">
<system.web>
...
<httpRuntime maxRequestLength="102400" executionTimeout="28800" targetFramework="4.5" />
<httpHandlers>
...
<add verb="GET" path="*ViewModule.aspx.ashx" type="Terrasoft.Messaging.MicrosoftWSService.WSHandler, Terrasoft.Messaging.MicrosoftWSService" />
...
<system.webServer>
...
<handlers>
...
<add name="WSHandler" verb="*" path="*ViewModule.aspx.ashx" type="Terrasoft.Messaging.MicrosoftWSService.WSHandler, Terrasoft.Messaging.MicrosoftWSService" />
Configuring websockets for Windows Server 8
To set up websockets in the application deployed on Windows Server 8 or earlier, edit the Web.config file located in the [Path to the root bpm’online directory]\Terrasoft.WebApp\ directory. You must specify the following values:
<wsService type="Terrasoft.Messaging.SuperWSService.SuperWSService, Terrasoft.Messaging.SuperWSService" defaultPort="2011" encrypted="false" portForClientConnection="44310" />
Please note that the defaultPort value must be unique. That is it should not be the same as other port values for all applications on the server. To check port availability, enter the following in the Windows command line:
telnet –a [host [port]]
The host value is the web address of the deployed bpm’online application, and in port specify the value that will be used in the Web.config by default. For example:
telnet -a demo.bpmonline.com 2011
If bpm'online is deployed on the server with Windows Server 8, and Internet Explorer is used to work with the system, you must transfer the session cookies from http to JavaScript. To do this, change the httpOnlyCookies value in the Web.config file.
…
<httpCookies httpOnlyCookies="false" />
…