KeePass   KeePass Help Center Home KeePass Home | Package Downloads | Flag Translations | Blocks Plugins  
Home Help Center Home | People Forums | Award Awards | Search Search  






Donate Donate
Locked

Trigger Examples


Examples of how to use the trigger system.

[Documentation contributed by Paul Tannard]


Info  Backup your database when you open KeePass

  1. Open KeePass and navigate to 'Tools' -> 'Triggers...'.
  2. Add a trigger.
  3. Call it something meaningful, like "Backup database on open".
  4. Tick the 'Enabled' and 'Initially on' boxes.
  5. Navigate to the 'Events' tab and add an event.
  6. Select 'Opened database file'. Don't bother with the comparison or filter.
  7. Navigate to the 'Actions' tab and add an action.
  8. Select 'Execute command line / URL'.
  9. In the 'File/URL' field enter this: %comspec%
  10. In the 'Arguments' field enter this:
    /c copy "{DB_PATH}" "C:\Backup\{DB_BASENAME}.{DT_SIMPLE}"

KeePass will now backup all databases when opening them.

How it works.
KeePass runs the command specified and replaces the placeholders as shown:

  • {DB_PATH} = the full path and name of the opened database.
  • {DB_BASENAME} = the first part of the database name only, e.g. "Database.kdbx" would become "Database".
  • {DT_SIMPLE} = YYYYMMDDHHMMSS.

If your database was on drive E: and was called MyDB.kdbx, this is what you get as a command line:
%comspec% /c copy "E:\MyDB.kdbx" "C:\Backup\MyDB.20090626"

If you want to save the database to a different location, change the 'C:\Backup' to the correct location. Note: this command will fail if the location you specify does not exist.

USB Key
If you have your database on a USB key and use it on many machines, you don't want to leave a back up on the hard disk. You need to backup your database to the USB key before you save any changes.

10. In the 'Arguments' field enter this:
/c copy "{DB_PATH}" "{DB_DIR}\{DB_BASENAME}.{DT_SIMPLE}"

How it works.
KeePass runs the command specified and replaces the placeholders as shown:

  • {DB_DIR} = the full path of the opened database.
  • {DB_BASENAME} = the first part of the database name only, e.g. "Database.kdbx" would become "Database".
  • {DT_SIMPLE} = YYYYMMDDHHMMSS.

Keep only the most recent 3 or 5 or 7 backups.
10. In the 'Arguments' field enter this:
/c for /f "skip=7 tokens=*" %X in ('dir "C:\Backup\{DB_BASENAME}.*" /b /o:-d') do del "C:\Backup\%X"

How it works.
This performs a "dir" in reverse date order on the backup files, skips the first 7 items and deletes the rest. The path and file name are quoted in case you have spaces in there. Note: you need to set the the path in 2 places so that it matches your backup location.


Info  Export to a different format when you save

  1. Open KeePass and navigate to 'Tools' -> 'Triggers...'.
  2. Add a trigger.
  3. Call it something meaningful, like "Export database on save".
  4. Tick the 'Enabled' and 'Initially on' boxes.
  5. Navigate to the 'Events' tab and add an event.
  6. Select 'Saved database file'. Don't bother with the comparison or filter.
  7. Navigate to the 'Actions' tab and add an action.
  8. Select 'Export active database'.
  9. In the 'File/URL' field a full path, filename and extension, e.g. C:\Export\Database.txt
  10. In the 'File format' field enter the required format. See format names below.
    Note: format names must be exact.

KeePass will now export the current database after it has been saved.

Format Names.

  • Version 1 database format (uses the same password/key as the existing database): KeePass KDB (1.x)
  • Version 2 database format (uses the same password/key as the existing database): KeePass KDBX (2.x)
  • Version 1 CSV format: KeePass CSV (1.x)
  • Version 2 XML format: KeePass XML (2.x)

Info  Auditing KeePass changes

Should the auditors be on your case - aren't they always - you can set up a trigger to log changes to the KeePass database. This will not list the specific changes, but it does show who made the changes and when. If you also save copies of the changed database, you can view the modified time attribute to see what was changed.

  1. Open KeePass and navigate to 'Tools' -> 'Triggers'.
  2. Add a trigger.
  3. Call it something meaningful, like "Auditors do it because it annoys you".
  4. Tick the 'Enabled' and 'Initially on' boxes.
  5. Navigate to the 'Events' tab and add an event.
  6. Select 'Saved database file'. Don't bother with the comparison or filter.
  7. Navigate to the 'Actions' tab and add an action.
  8. Select 'Execute command line / URL'.
  9. In the 'File/URL' field enter this: %comspec%
  10. In the 'Arguments' field enter this:
    /c echo DBS change on %DATE% %TIME% by %USERDNSDOMAIN% %USERDOMAIN% %USERNAME% >> "\\servername\share\directory\KpLogRecord.txt"
  11. Add another action.
  12. Select 'Execute command line / URL'.
  13. In the 'File/URL' field enter this: %comspec%
  14. In the 'Arguments' field enter this:
    /c copy "{DB_PATH}" "\\servername\share\directory\{DB_BASENAME}.{DT_SIMPLE}"

To be sure the audit logs are retained, set up "\\servername\share\directory" with only write permission.

How it works.
KeePass runs the command specified and replaces the placeholders as shown:

  • %DATE% = the current date.
  • %TIME% = the current time.
  • %USERDNSDOMAIN% = the logon domain of the current user, if they are in a domain.
  • %USERDOMAIN% = the logon machine/domain of the current user.
  • %USERNAME% = the logon name of the current user.

This information is appended to the log file KpLogRecord.txt. The second action copies the saved database to the audit location and appends the date and time.


Info  Preventing infinite loops

KeePass can fall into an infinite loop if an action re-triggers itself, e.g. a save triggering a sync event will loop because the sync is classed as a save. To prevent this you need to disable the trigger system whilst your event is running, then re-enable the trigger system.

  1. Open KeePass and navigate to 'Tools' -> 'Triggers...'.
  2. Edit your existing trigger.
  3. Navigate to the 'Action' tab and add a new action.
  4. Select 'Change trigger on/off state'.
  5. Enter the name of the trigger you want to disable in the 'Trigger name' field.
  6. In the 'New state' field change the state to 'off'.
  7. Click 'OK' to save the action.
  8. Highlight the new action and move it to the top of the 'Actions' list by clicking on the 'up arrow' on the right.
  9. Add a new action.
  10. Select 'Change trigger on/off state'.
  11. Enter the same triger name you used above in the 'Trigger name' field.
  12. In the 'New state' field change the state to 'on'.
  13. Click 'OK' to save the action.
  14. Make sure the action is at the bottom of the 'Actions' list.
  15. Save the event.

KeePass will now disable the trigger whilst the actions are performed.







Valid XHTML 1.0 Transitional Document

Get Thunderbird

Get KeePass


KeePass is OSI Certified Open Source Software
Copyright © 2003-2010
Dominik Reichl, [Legal Contact / Imprint] [Disclaimer] [Acknowledgements] [Donate], Downloads hosted at

Get KeePass Password Safe at
SourceForge.net. Fast, secure and Free Open Source software downloads