Portal user idle timeout using dialog windows - Client side solution

[Former Member]

Abstract 

As per the SAP Note: 982982 there is no standard solution in SAP Portal to Logoff the Portal due to user inactivity. Hence people have been using client side solution to overcome this. Upto certain extent this functionality built using Javascript has been useful. With reference to the Portal timeout solution posted by Arnaud Leymet, this post is an enhancement of the Portal user idle timeout solution.

Background of previous Solution :

If user is idle, then the Portal displays a warning message to the user after a certain period (warning period). In the duration between warning period and actual timeout period, if user intervens and clicks on the Warning message, then Portal timer is updated. Else the Portal still remains idle waiting for user intervention. Hence the actual timeout of the application is happenning only after user intervention. Even if the user has not seen the application for n hours the portal would not have logged off.

Hence to overcome this issue, in place of an alert I have used a dialog window prompting the user to activate the portal and will be displayed for few minutes (timeout period - warning period) after which it closes automatically and logs off the portal. Before logging off it opens a new window informing the user about the session termination due to inactivity. The code has been modified for achieving the same.

Source

Open Mashead PAR file through NWDS.

Create a JS page by name customtimeout.js under scripts folder in the project directory and include the same in Headerivew.jsp page.

Add the below code in customtimeout.js

javascript/customtimeout.js

/*** Custom Timeout Handler* @param warn_delay Delay until the warning message (in minutes)* @param kick_delay Delay until the "session timed out" message (in minutes)*/var customTimeoutHandler = function(warn_delay, kick_delay) {  return {    debug_mode:         false,                  // Switches the display of the timer (function _displayTimer)    timeout_wait:       1000 * 30,              // Delay for the 'setTimeout' native function    timeout_warn_delay: 1000 * 60 * warn_delay, // Delay until the warning message    timeout_kick_delay: 1000 * 60 * kick_delay, // Delay until the timeout message and the effective timeout    warning_period:     kick_delay - warn_delay, // Warning period in minutes        /**    * Initializes the custom portal timeout (called at first time)    **/        initialize: function() {      this.updateTimer();      setTimeout("timeout_h.checkTimeout()", this.timeout_wait);    },        /**    * Updates the custom portal timeout (called whenever the user navigates in the portal)    **/        updateTimer: function()    {      var dt = new Date();      writeCookie('custom_timeout', dt.getTime());      if(this.debug_mode)      {        this._displayTimer();      }    },            /**    * Checks whether the timeout has occured or not ( repeatedly called)    **/                checkTimeout: function() {      },                   postAjax: function() {         var now = new Date();         var diff = now.getTime() - this._getTimerStart();                  if(diff > this.timeout_warn_delay) { // Action : unactive                 openPopup();              }                               if(diff > this.timeout_kick_delay) { // Action : kick (= time out)              forceLogoff();         } else {           this.updateTimer();           setTimeout("timeout_h.checkTimeout()", this.timeout_wait);         }                         if(this.debug_mode) {        this._displayTimer( diff + " > " + this.timeout_kick_delay + " ? " + (diff > this.timeout_kick_delay) );      }    },                      /**     *     */        _getTimerStart: function() {      var timeout_start = parseInt(readCookie('custom_timeout'));      return new Date(timeout_start);    },        /**    * Displays the timer informations in the window status bar    **/        _displayTimer: function(message) {      var dt = this._getTimerStart();      var timer_start_string = dt.getHours() + ":" + dt.getMinutes() + ":" + dt.getSeconds();      if(message && message!=null && message!="") {        window.status = timer_start_string + " - " + message;      } else {        window.status = timer_start_string;      }    },    /**    * Refreshes the portal page content    **/    _refreshPage: function() {      try {        frameworkSupport.refreshContentArea();      } catch(e) {        document.location.reload()      }    },    /**    * Subscribes to an EPCM event    **/      addListener: function(urn, action) {      EPCM.subscribeEvent(urn, action, this.updateTimer);           }  }}// cookies functionsfunction writeCookie(name, value) {  document.cookie = name + "=" + escape(value);}function readCookie(name) {  var arg = name+'=';  var alen = arg.length;  var clen = document.cookie.length;  var i=0;  while (i < clen){    var j = i + alen;    if (document.cookie.substring(i, j) == arg) return getCookieVal(j);    i=document.cookie.indexOf(' ', i) + 1;    if (i == 0) break;  }  return null; }    function getCookieVal(offset) {  var endstr = document.cookie.indexOf (';', offset);  if (endstr == -1) endstr = document.cookie.length;  return unescape(document.cookie.substring(offset, endstr));}//  Call openPopup to close session     function inActivateSession(){         var now = new Date();         var diff = now.getTime() - timeout_h._getTimerStart();          if(diff > timeout_h.timeout_warn_delay) {                   openPopup();               } else {        setTimeout("timeout_h.checkTimeout()", timeout_h.timeout_wait);           }         }//  Open a Dialog window     function openPopup() {        var EventID;    if (EPCM.getUAType() == EPCM.MSIE) {              EventID = window.showModalDialog("/irj/portalapps/com.sap.portal.masthead/scripts/IEDialog.jsp","Dialog","dialogWidth:500px;dialogHeight:130px;toolbar:no;directories:no;status:no;menubar:no;scrollbars:no;resizable:no;modal:yes");       if(EventID != null && EventID == 'C') {           getLegacyHitStatus();          }          else {          forceLogoff();                    }        }    else {        //       window.open("/irj/portalapps/com.sap.portal.masthead/scripts/FFDialog.jsp","Dialog","width:200px;height:100px;toolbar:no;directories:no;status:no;menubar:no;scrollbars:no;resizable:no;modal:yes");         alert("Your session will expire in 5 minute(s). Please click [OK] to continue.");         forceLogoff();         }    }        //  Force LogOff        function forceLogoff(){        logoff();                    }

For opening a pop up dialog window in Internet Explorer browser after the warning period, create a JSP page by name IEDialog.JSP and add the below code in it .

IEDialog.jsp

The Portal session will expire in 5 minute(s). Please click [Continue/Logoff] to Re-activate/End the session.

  

For opening a pop up dialog window in other browsers after the warning period, create a JSP page by name FFDialog.JSP and add the below code in it .

FFDialog.JSP

Your session will expire in 5 minute(s). Please click [Continue/Logoff] to Re-activate/End the session.

To display a Logoff message after Portal Log off, create a JSP page by name LogoffMessage add the below code in it . 

The Log off Message is displayed, so that user can identify that its a force log off due to session inactivity.  The HTML code for the same is given below.

LogOffMessage.jsp

The Portal session has been terminated due to inactivity. Please login again.

Add the below code towards the end of HeaderiView.jsp

(No change done in this page compared to previous)

PORTAL-INF/jsp/HeaderiView.jsp

    // Code for Portal Timeout     var timeout_h = customTimeoutHandler(25, 30);      timeout_h.initialize();    function pop() { timeout_h.updateTimer(); }    EPCM.subscribeEvent("urn:com.sapportals:navigation", "Navigate", pop);              

Note: The Idle warn delay & kick delay values can be changed as per the requirement in

customTimeoutHandler(25, 30) in HeaderiView.jsp.

Result:

After being idle on the portal for 25 minutes , you should obtain a popup like the following:

Dialog Window:

Log off message after timeout:

It worked for me. Hope you'll find it useful.