Skip to main content
Kinetic Community

Chapter Five - Web Application Customizations

The Kinetic SR web application can be customized with additional functionality, such as branding provided by bundles, or other functionality, for example, persisting user sessions across browser restarts.

Bundles and Themes

Bundles and themes provide additional functionality or a custom look and feel to your application.  Bundles are available here on the Kinetic Data Community website, or you can create your own.

To use a bundle, simply drop into the web application's /themes directory, or create the /themes directory if it doesn't already exist.  Then all you have to do is point your service items at a JSP file located in the theme directory.

Persistent User Sessions

SINCE v5.1.3

Some organizations have requested that Kinetic Request be able to retain user sessions across browser restarts.  While this feature was added in v5.1.3, it is disabled by default.

It can be enabled by changing a value in the web.xml file located in the Kinetic Request web application deployment directory on your web server to indicate the name of the session cookie your web server uses.  In a Tomcat deployment, the web.xml file will be located at  <tomcat_base>/webapps/kinetic/WEB-INF/web.xml where <tomcat_base> is the base location of your tomcat deployment.  If your organization uses a web server other than Tomcat, the file may be in a different location.

Near the top of the web.xml file, a new <context-param> element exists named SESSION_COOKIE_NAME.  By default the parameter value is blank, which indicates this feature is not used.  

<context-param>
    <description>The name of the cookie that is used to set the session id.  If this 
        value is set, sessions will be persisted in the browser between restarts.
        If this value is not set, session cookies will not be persisted between 
        browser restarts.  The value of this parameter should be set to the name 
        of the session cookie generated by the web server, for most systems this 
        will be 'JSESSIONID'.  
    </description>
    <param-name>SESSION_COOKIE_NAME</param-name>
    <param-value></param-value>
</context-param>

To enable the persistent user session, you will need to edit the web.xml file with a simple text editor such as Notepad, and change the <param-value> element to the name of the session cookie used by your web server.  Tomcat uses the value JSESSIONID, other web servers may use a different value.  You will need to consult your web server documentation to obtain the correct value.

<context-param>
    <description>The name of the cookie that is used to set the session id.  If this 
        value is set, sessions will be persisted in the browser between restarts.
        If this value is not set, session cookies will not be persisted between 
        browser restarts.  The value of this parameter should be set to the name 
        of the session cookie generated by the web server, for most systems this 
        will be 'JSESSIONID'.  
    </description>
    <param-name>SESSION_COOKIE_NAME</param-name>
    <param-value>JSESSIONID</param-value>
</context-param>