You are here

Home » API reference » Automated Logout 5

README.txt in Automated Logout 5

Same filename and directory in other branches
  1. 8 README.txt
  2. 6.4 README.txt
  3. 6 README.txt
  4. 6.2 README.txt
  5. 7.5 README.txt
  6. 7.2 README.txt
  7. 7.4 README.txt
README.txt file
===============

Settings
========

Enable module checkbox. 
  If this is unchecked the module is NOT activated and no 
  automated logouts will occur.

Timeout value in seconds.
  The is the "inactivity" timeout value. It's important to note
  that the server's only way of knowing about activity is when
  a browser requests a page from it. If the user is happily sitting
  there, say typing an enormous blog entry, then there's no way for
  server to know the actual user is very busy until she submits the
  page. The server checks for any submissions (input) by the user.
  If there is content being added, the timeout is effectivly
  cancelled and a new session starts.

Browser refresh delta:
  If this is set to a non zero value, this time will be added to the
  "Timeout value in seconds" variable and be used to set a :-
    <meta http-equiv="refresh" content="xxx">
  line in the <head> section of the page. It's likely that clocks
  won't be perfect so make the browser wait sometime longer than the
  actual time out value. This effectively sends the browser back to
  the homepage with the user logged out. Set this to 0 (zero) to disable
  the <meta> tag.
 
  Note, as stated above, we test for content submission before doing
  a logout so that users do not loose work. However, if you force a
  meta refresh, this is not possible as the browser will refresh the
  page without doing a submit or a preview. In this case, users may
  loose work so use this option carefully. There's nothing more
  annoying than loosing your work (except maybe hemorrhoids! ;)

Enable watchdog auto-logout logging:
  Check on to have the module record when it expires a user.

Set-up your site policy by role:
  You can specify, by role, how users are treated regarding timeout
  issues. The three types of policy are :

    Enforce: All users in this role have the timeout enforced on them
    Exclude: All users in this role do not have the timeout enforced on them
    By user: All users in this role have the choice to disable the timeout.

Important note! The module by default uses Enforce. However, if a user is
found to have any other exclusion (by role or by choice) this takes
precidence over any Enforce that might have been in place.

Finally, this module provides a block that displays the h,m,s left in this
session (hours minutes seconds). It can be enabled in Admin > blocks and
the title of the block can be set in the standard settings page.

If a policy settings means a user is not subject to autologout (in a role
of Exclude or By user and user set in profile not to autologout) then the
block is not displayed. The block is only displayed to users who will be
logged out if appropiate.

File

README.txt
View source 
  1. README.txt file

  2. ===============

  3. 

  4. Settings

  5. ========

  6. 

  7. Enable module checkbox. 

  8.   If this is unchecked the module is NOT activated and no 

  9.   automated logouts will occur.

  10. 

  11. Timeout value in seconds.

  12.   The is the "inactivity" timeout value. It's important to note

  13.   that the server's only way of knowing about activity is when

  14.   a browser requests a page from it. If the user is happily sitting

  15.   there, say typing an enormous blog entry, then there's no way for

  16.   server to know the actual user is very busy until she submits the

  17.   page. The server checks for any submissions (input) by the user.

  18.   If there is content being added, the timeout is effectivly

  19.   cancelled and a new session starts.

  20. 

  21. Browser refresh delta:

  22.   If this is set to a non zero value, this time will be added to the

  23.   "Timeout value in seconds" variable and be used to set a :-

  24.     

  25.   line in the  section of the page. It's likely that clocks

  26.   won't be perfect so make the browser wait sometime longer than the

  27.   actual time out value. This effectively sends the browser back to

  28.   the homepage with the user logged out. Set this to 0 (zero) to disable

  29.   the  tag.

  30.  

  31.   Note, as stated above, we test for content submission before doing

  32.   a logout so that users do not loose work. However, if you force a

  33.   meta refresh, this is not possible as the browser will refresh the

  34.   page without doing a submit or a preview. In this case, users may

  35.   loose work so use this option carefully. There's nothing more

  36.   annoying than loosing your work (except maybe hemorrhoids! ;)

  37. 

  38. Enable watchdog auto-logout logging:

  39.   Check on to have the module record when it expires a user.

  40. 

  41. Set-up your site policy by role:

  42.   You can specify, by role, how users are treated regarding timeout

  43.   issues. The three types of policy are :

  44. 

  45.     Enforce: All users in this role have the timeout enforced on them

  46.     Exclude: All users in this role do not have the timeout enforced on them

  47.     By user: All users in this role have the choice to disable the timeout.

  48. 

  49. Important note! The module by default uses Enforce. However, if a user is

  50. found to have any other exclusion (by role or by choice) this takes

  51. precidence over any Enforce that might have been in place.

  52. 

  53. Finally, this module provides a block that displays the h,m,s left in this

  54. session (hours minutes seconds). It can be enabled in Admin > blocks and

  55. the title of the block can be set in the standard settings page.

  56. 

  57. If a policy settings means a user is not subject to autologout (in a role

  58. of Exclude or By user and user set in profile not to autologout) then the

  59. block is not displayed. The block is only displayed to users who will be

  60. logged out if appropiate.

  61. 

  62. 

  63.