UserLock Documentation
UserLock Documentation
You are here: Reference > Console > Logon cleaner

Logon cleaner

By default, UserLock retains user session events indefinitely in its database. However it's possible to delete some old and obsolete events from the database when it starts becoming too large. The menu item 'Logon cleaner' allows you to display some key figures about the database and to remove user session events in accordance with your history policy. This maintenance operation can be done on demand or as scheduled.

The 'Database' section displays the database currently linked to the cleaner tool. You can modify it by clicking on the button to the tight of the field containing the database connection string.

To display the information about the current database, click on the button 'Get database information'. The time required to obtain this information will depend on the database size and the number of records it contains.

'Erase records older than' mode

This mode allows you to define the number of days to keep in the database history. The date noted underneath the number of days corresponds to the new limit of the history once the operation has been performed. Click on 'Launch' from the 'Quick access' panel to initiate the operation.

Please note: The logon cleaner operations are definitive and irreversible.

'Clear all records' mode

As its name suggests, this mode will delete the entire database history content. In the same way, click on 'Launch' from the 'Quick access' panel to initiate the operation.

Please note: The logon cleaner operations are definitive and irreversible.

Schedule cleaning operations

You can also schedule these operations to clean your database regularly and automatically.

  1. After having defined the number of days to conserve or selected a full records deletion, click on 'Schedule' from the 'Quick access' panel.

  2. Enter a name for this job in the pop-up window.

  3. A Windows task will be created on the machine with this name, and the Windows scheduler will open. Display the 'Schedule' tab.
    Click on 'New' and configure the scheduling settings as desired. Click 'OK'.

  4. A credentials request will be prompted to start this task at the triggered date/time. Enter an account having local administrative privileges on the machine.

  5. The scheduled task has now been registered and added into UserLock. You can see that the 'Scheduler' menu has been expanded. You can find the cleaning job and modify it directly from here. Modifications will be automatically saved on focus change.