You are here

Home » API reference » Automated Logout 7.4

README.txt in Automated Logout 7.4

Same filename and directory in other branches
  1. 8 README.txt
  2. 5 README.txt
  3. 6.4 README.txt
  4. 6 README.txt
  5. 6.2 README.txt
  6. 7.5 README.txt
  7. 7.2 README.txt
/* $Id:

Description
===========
After a given timeout has passed, users are given a configurable session expired prompt. They can reset the timeout, logout, or ignore it in which case they'll be logged out after a the padding time has elapsed. This is all backed up by a server side logout if js is disable or bypassed.

Features
========
* Configurable Global timeout and timeout padding. The latter determines how much time a user has to respond to the prompt and when the server side timeout will occur.
* Configurable messaging.
* Configurable redirect url, with the destination automatically appended.
* Configure which roles will be automatically logged out.
* Configure if a logout will occur on admin pages.
* Integration with ui.dialog if available. This makes for attractive and more functional dialogs.
* Configurable timeout based on role
* Configurable timeout based on User
* Configurable maximum timeout. Primarily used when a user has permission to change their timeout value, this will be a cap or maximum value they can use.
* Order of presidence is, user timeout -> lowest role timeout -> global timeout
* So if a user has a user timeout set, that is their timeout threshold, if none is set the lowest timeout value based on all the roles the user belongs to is used, if none is set the global timeout is used
* Roles with the proper permission setting can change their timeout value

File

README.txt
View source 
  1. /* $Id:

  2. 

  3. Description

  4. ===========

  5. After a given timeout has passed, users are given a configurable session expired prompt. They can reset the timeout, logout, or ignore it in which case they'll be logged out after a the padding time has elapsed. This is all backed up by a server side logout if js is disable or bypassed.

  6. 

  7. Features

  8. ========

  9. * Configurable Global timeout and timeout padding. The latter determines how much time a user has to respond to the prompt and when the server side timeout will occur.

  10. * Configurable messaging.

  11. * Configurable redirect url, with the destination automatically appended.

  12. * Configure which roles will be automatically logged out.

  13. * Configure if a logout will occur on admin pages.

  14. * Integration with ui.dialog if available. This makes for attractive and more functional dialogs.

  15. * Configurable timeout based on role

  16. * Configurable timeout based on User

  17. * Configurable maximum timeout. Primarily used when a user has permission to change their timeout value, this will be a cap or maximum value they can use.

  18. * Order of presidence is, user timeout -> lowest role timeout -> global timeout

  19. * So if a user has a user timeout set, that is their timeout threshold, if none is set the lowest timeout value based on all the roles the user belongs to is used, if none is set the global timeout is used

  20. * Roles with the proper permission setting can change their timeout value