KB13219: How to enable ‘Keep Alive’ setting on an external Java application that connects to MicroStrategy Intelligence Server through the firewall in MicroStrategy SDK

SYMPTOM:
A Strategy Intelligence Server 9.4.1 session can be created by an external application and later restored using External Security Module (ESM), as explained in the Strategy Developer Library. If an external application is separated from Strategy Intelligence Server9.4.1 by a firewall, it can lead to the build up of half-open TCP connection on Strategy Intelligence Server 9.4.1, which in turn may cause it to stop responding to client requests.
 
CAUSE:
Just like Strategy Web 9.4.1, an external application using Strategy Web 9.4.1 libraries creates a pool of TCP connections to Strategy Intelligence Server 9.4.1. This pool is governed by the same settings as Strategy Web 9.4.1, however these settings are not accessible through the graphical interface
 
If the firewall is present between Strategy Web 9.4.1 and Strategy Intelligence Server 9.4.1, administrator should enable the 'Keep Alive' setting through the Administrator interface, and configure the 'Keep Alive' signal frequency according to specifications provided by the vendor of the operating system/web server on which Strategy Web 9.4.1 is installed.
 
For more information, consult the following Strategy Knowledge Base documents:
 

• KB5600-072-0701 - How to set the frequency signal for the ’Keep alive’ function in Strategy Web 8.x on Windows.
   
  
• KB5300-75x-0518 - The connection to the server has been lost” error message appears when logging into a Strategy Intelligence Server either via Strategy Desktop or Web 8.x.

ACTION:
In the case of an external application, the 'Keep Alive' setting has to be enabled using the WebClusterAdmin interface, for instance:
 

WebIServerSession isess = WebObjectsFactory.getInstance().getIServerSession();
isess.getFactory().getClusterAdmin().setKeepAlive(true);

 
 
 
CUSTOMIZATION WARNING:
This customization is provided as a convenience to Strategy users and is only directly applicable to the version stated. While this code may apply to other releases directly, Strategy Technical Support makes no guarantees that the code provided will apply to any future or previous builds. In the event of a code change in future builds, Strategy Technical Support makes no guarantee that an updated version of this particular customization will be provided. In the event of a code change in future builds, Strategy may not be able to provide additional code on this matter even though this customization is provided at this time for this specific build. For enhancements to this customization or to incorporate similar functionality into other versions, contact your Account Executive to inquire about Strategy Consulting assistance.