idle-lookup
Reactive icon

Idle Lookup

Stable version 1.1.0 (Compatible with OutSystems 11)
Uploaded
 on 03 December 2023
 by 
0.0
 (0 ratings)
idle-lookup

Idle Lookup

Documentation
1.1.0

IDLE Lookup is a component that can be added into your screen to perform tasks when the screen is kept idle or out of focus for a given time.


There are 3 functionalities in this component:

  1. Screen Idle Lookup

  2. Screen Focus Lookup

  3. Idle Timer


  1. Idle Lookup


This web block can be added to the screen to check if the screen is kept idle for a certain period of time. If there is no activity for the given amount of time, then the web block can perform built-in functionalities that can be configured using the input parameters of the block. This web block can also be used to perform custom tasks by using the “IdleTimedOut” event.




Parameter

Description

Mandatory

TimeoutInSeconds

Time in seconds after which the session should be timed out

Yes

ShowPopup

Set as True if you want to use the built in popup display after timeout

No

LogoutIfInactive

Set as True if you want to logout the current user session

No

ChangeTitle

Set as True if you want to change the title of the screen at timeout

No

TimeoutTitle

The page title to be displayed when timed out

No

PopupBlock

This placeholder is used to add custom elements to the popup that will be displayed on timeout

No

IdleTimedOut

This event can be used to perform custom tasks after timeout

No



How To:


  1. Add the Idle Lookup component to the screen to get started. 

  2. Configure how you need the component to work.

  3. If you want to display popup, add the elements into the PopupBlock placeholder.

  4. Publish & Enjoy!



2. Focus Lookup


This web block can be added to the screen to check if the screen is kept out of focus for a certain period of time. If the screen is not active for the given amount of time, then the web block can perform built-in functionalities that can be configured using the input parameters of the block. This web block can also be used to perform custom tasks by using the “FocusTimedOut” event.



Parameter

Description

Mandatory

TimeoutInSeconds

Time in seconds after which the session should be timed out

Yes

ShowPopup

Set as True if you want to use the built in popup display after timeout

No

LogoutIfInactive

Set as True if you want to logout the current user session

No

ChangeTitle

Set as True if you want to change the title of the screen at timeout

No

TimeoutTitle

The page title to be displayed when timed out

No

PopupBlock

This placeholder is used to add custom elements to the popup that will be displayed on timeout

No

FocusTimedOut

This event can be used to perform custom tasks after timeout

No



How To:


  1. Add the Idle Lookup component to the screen to get started. 

  2. Configure how you need the component to work.

  3. If you want to display popup, add the elements into the PopupBlock placeholder.

  4. Publish & Enjoy!






3. Idle Timer


This web block can be added to the screen if you want to display the idle timer when the screen is kept idle. This can be customised to fit to your screen with options to change appearance and size of the component. There is also an event that will be triggered automatically at the end of the timer, which can be used to perform custom tasks at timeout.



Parameter

Description

Mandatory

Hours

Number hours to trigger timeout

Yes

Minutes

Number minutes to trigger timeout

Yes

Seconds

Number seconds to trigger timeout

Yes

BackgroundColor

Background color for the timer

No

TextColor

Text color for the timer

No

Size

Size of timer with unit

No



How To:


  1. Add the Idle Timer component to the screen to get started. 

  2. Configure how you need the component to work.

  3. Publish & Enjoy!









1.0.0


Idle Lookup is a component that can be added into your screen to perform tasks when the screen is kept idle or out of focus for a given time.


There are 2 functionalities in this component:

  1. Screen Idle Lookup

  2. Screen Focus Lookup


  1. Idle Lookup


This web block can be added to the screen to check if the screen is kept idle for a certain period of time. If there is no activity for the given amount of time, then the web block can perform built-in functionalities that can be configured using the input parameters of the block. This web block can also be used to perform custom tasks by using the “IdleTimedOut” event.



Configuration:

Parameter

Description

Mandatory

TimeoutInSeconds

Time in seconds after which the session should be timed out

Yes

ShowPopup

Set as True if you want to use the built in popup display after timeout

No

LogoutIfInactive

Set as True if you want to logout the current user session

No

ChangeTitle

Set as True if you want to change the title of the screen at timeout

No

TimeoutTitle

The page title to be displayed when timed out

No

PopupBlock

This placeholder is used to add custom elements to the popup that will be displayed on timeout

No

IdleTimedOut

This event can be used to perform custom tasks after timeout

No



How To:


  1. Add the Idle Lookup component to the screen to get started. 

  2. Configure how you need the component to work.

  3. If you want to display popup, add the elements into the PopupBlock placeholder.

  4. Publish & Enjoy!



      2. Focus Lookup


This web block can be added to the screen to check if the screen is kept out of focus for a certain period of time. If the screen is not active for the given amount of time, then the web block can perform built-in functionalities that can be configured using the input parameters of the block. This web block can also be used to perform custom tasks by using the “FocusTimedOut” event.



Configuration:

Parameter

Description

Mandatory

TimeoutInSeconds

Time in seconds after which the session should be timed out

Yes

ShowPopup

Set as True if you want to use the built in popup display after timeout

No

LogoutIfInactive

Set as True if you want to logout the current user session

No

ChangeTitle

Set as True if you want to change the title of the screen at timeout

No

TimeoutTitle

The page title to be displayed when timed out

No

PopupBlock

This placeholder is used to add custom elements to the popup that will be displayed on timeout

No

FocusTimedOut

This event can be used to perform custom tasks after timeout

No



How To:


  1. Add the Idle Lookup component to the screen to get started. 

  2. Configure how you need the component to work.

  3. If you want to display popup, add the elements into the PopupBlock placeholder.

  4. Publish & Enjoy!