{"id":82,"date":"2026-03-22T12:52:59","date_gmt":"2026-03-22T12:52:59","guid":{"rendered":"https:\/\/overlaps.co.uk\/docs\/?page_id=82"},"modified":"2026-03-22T12:52:59","modified_gmt":"2026-03-22T12:52:59","slug":"history-report-tool","status":"publish","type":"page","link":"https:\/\/overlaps.co.uk\/docs\/overlaps-documentation\/additional-tools\/history-report-tool\/","title":{"rendered":"History Report Tool"},"content":{"rendered":"\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\" data-enlighter-theme=\"\" data-enlighter-highlight=\"\" data-enlighter-linenumbers=\"\" data-enlighter-lineoffset=\"\" data-enlighter-title=\"\" data-enlighter-group=\"\">C:\\Program Files (x86)\\OVERLAPS\\historyreport.exe\n<\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">The History Report Tool can be used to export History Log data for auditing or reporting purposes.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">The tool can export in three formats:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>CSV &#8211; For importing into spreadsheet software such as Microsoft Excel.<\/li>\n\n\n\n<li>PDF \u2013 Creates a report in the Adobe Portable Document Format (PDF).<\/li>\n\n\n\n<li>RTF \u2013 Generates a Rich Text Format document compatible with most word processors.<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"command-line-arguments\">Command Line Arguments<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"required-arguments\">Required Arguments<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">You must specify at least one of the arguments <strong>\u201c\/pdf\u201d<\/strong>, <strong>\u201c\/rtf\u201d<\/strong> or *<em>\u201c\/csv\u201d<\/em> and follow it with a valid path and filename to save the requested report to.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">To get help, you can instead pass the argument <strong>\u201c\/help\u201d<\/strong> or <strong>\u201c\/?\u201d<\/strong> to see more information.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"optional-arguments\">Optional Arguments<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th>Argument<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>\/db<\/td><td>If your database is in a non-standard location, or you want to access it from a network share, specify the path and filename of your database using this parameter.<\/td><\/tr><tr><td>\/date &lt;date&gt;<\/td><td>Give a valid date format (for example \u201cDD\/MM\/YY\u201d or \u201cMM\/DD\/YY\u201d depending on your system locale) to only export history logs from that date.<br><br>An incorrectly formatted date will show an error, but continue to export all logs instead.<br><br><strong>Note: If using a date format with spaces (e.g. \u201c31 Jan 2020\u201d), always enclose the date in quotes.<\/strong><\/td><\/tr><tr><td>\/start &lt;date&gt;<\/td><td>As an alternative to specifying an exact date, you can instead use the \/start and \/end parameters to specify a date range.<\/td><\/tr><tr><td>\/end &lt;date&gt;<\/td><td>As above.<\/td><\/tr><tr><td>\/find &lt;search term&gt;<\/td><td>Search the logs for a specific username, computer name, etc.<\/td><\/tr><tr><td>\/action &lt;action&gt;<\/td><td>Limit the results to a specific action. This argument can be added multiple times to specify multiple actions. For a full list of actions, run <strong>\u201chistoryreport.exe \/actions\u201d<\/strong> or see below.<\/td><\/tr><tr><td>\/limit &lt;number&gt;<\/td><td>Only output up to this number of results. Defaults to 10000.<\/td><\/tr><tr><td>\/fndate<\/td><td>Append the current date and time to the filename.<\/td><\/tr><tr><td>\/format &lt;paper size&gt;<\/td><td>(Only applies to PDF and RTF) Format the document paper size. Defaults to A4.<br><br>Valid values are: A0 to A6, B5, Ledger, Legal or Letter.<\/td><\/tr><tr><td>\/landscape<\/td><td>(Only applies to PDF and RTF) Orient the page in landscape layout.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"actions-for-filtering\">Actions for Filtering<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th>Action Keyword<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>Read<\/td><td>A password was read.<\/td><\/tr><tr><td>Reset<\/td><td>A password was expired.<\/td><\/tr><tr><td>SelfServiceRead<\/td><td>A password was read via Self-Service.<\/td><\/tr><tr><td>Justification<\/td><td>A user logged their justification for viewing a password.<\/td><\/tr><tr><td>ReadRequest<\/td><td>A request to read a password was entered into the Authorisation Request system.<\/td><\/tr><tr><td>ResetRequest<\/td><td>A request to expire a password was passed to the Authorisation Request system.<\/td><\/tr><tr><td>AuthoriseRead<\/td><td>A request to read a password was authorised.<\/td><\/tr><tr><td>AuthoriseReset<\/td><td>A request to expire a password was authorised.<\/td><\/tr><tr><td>DenyRead<\/td><td>A request to read a password was denied.<\/td><\/tr><tr><td>DenyReset<\/td><td>A request to expire a password was denied.<\/td><\/tr><tr><td>ReadComputerInfo<\/td><td>Computer information was viewed.<\/td><\/tr><tr><td>SaveComputerInfo<\/td><td>Computer information was modified (description field).<\/td><\/tr><tr><td>ComputerManagement<\/td><td>A Computer Management Task was processed.<\/td><\/tr><tr><td>ReadBitlockerRecoveryKey<\/td><td>A Bitlocker Recovery Key was read.<\/td><\/tr><tr><td>AddUser<\/td><td>A user or group was added.<\/td><\/tr><tr><td>EditUser<\/td><td>A user was edited\/modified.<\/td><\/tr><tr><td>RemoveUser<\/td><td>A user or group was removed.<\/td><\/tr><tr><td>ModifyConfig<\/td><td>Changes were made to the site settings.<\/td><\/tr><tr><td>Login<\/td><td>A user logged in.<\/td><\/tr><tr><td>Logout<\/td><td>A user logged out.<\/td><\/tr><tr><td>Information<\/td><td>General information log entry.<\/td><\/tr><tr><td>Security<\/td><td>A general security-related log entry.<\/td><\/tr><tr><td>Error<\/td><td>An error occurred.<\/td><\/tr><tr><td>SnapshotOperation<\/td><td>A snapshot was taken of the current per-OU user permissions.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"examples\">Examples<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Below are some example command lines to use with the History Report Tool.<\/p>\n\n\n\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\" data-enlighter-theme=\"\" data-enlighter-highlight=\"\" data-enlighter-linenumbers=\"\" data-enlighter-lineoffset=\"\" data-enlighter-title=\"\" data-enlighter-group=\"\">historyreport.exe \/pdf C:\\Reports\\overlaps.pdf\n<\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Exports all history records to a PDF file in C:\\Reports.<\/p>\n\n\n\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\" data-enlighter-theme=\"\" data-enlighter-highlight=\"\" data-enlighter-linenumbers=\"\" data-enlighter-lineoffset=\"\" data-enlighter-title=\"\" data-enlighter-group=\"\">historyreport.exe \/rtf C:\\Reports\\overlaps.rtf \/date 31\/12\/19 \/action Read \/action ReadRequest\n<\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Generates an RTF document container all Read and Requests to Read a password for the 31st December 2019 (in a locale that uses the DD\/MM\/YY format for this example).<\/p>\n\n\n\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\" data-enlighter-theme=\"\" data-enlighter-highlight=\"\" data-enlighter-linenumbers=\"\" data-enlighter-lineoffset=\"\" data-enlighter-title=\"\" data-enlighter-group=\"\">historyreport.exe \/csv C:\\Reports\\overlaps.csv \/date \u201c19 May 2020\u201d \/fndate \/find asmith\n<\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Create a CSV report for all history logs on the 19th May 2020, appending the current date to the filename (for example \u201coverlaps-201231-073000.csv\u201d for 31st December 2020 at 7:30 am), and only returning matches which contain the name \u201casmith\u201d.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>The History Report Tool can be used to export History Log data for auditing or reporting purposes. The tool can export in three formats: Command Line Arguments Required Arguments You must specify at least one of the arguments \u201c\/pdf\u201d, \u201c\/rtf\u201d or *\u201c\/csv\u201d and follow it with a valid path and filename to save the requested [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":78,"menu_order":200,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-82","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/overlaps.co.uk\/docs\/wp-json\/wp\/v2\/pages\/82","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/overlaps.co.uk\/docs\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/overlaps.co.uk\/docs\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/overlaps.co.uk\/docs\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/overlaps.co.uk\/docs\/wp-json\/wp\/v2\/comments?post=82"}],"version-history":[{"count":1,"href":"https:\/\/overlaps.co.uk\/docs\/wp-json\/wp\/v2\/pages\/82\/revisions"}],"predecessor-version":[{"id":83,"href":"https:\/\/overlaps.co.uk\/docs\/wp-json\/wp\/v2\/pages\/82\/revisions\/83"}],"up":[{"embeddable":true,"href":"https:\/\/overlaps.co.uk\/docs\/wp-json\/wp\/v2\/pages\/78"}],"wp:attachment":[{"href":"https:\/\/overlaps.co.uk\/docs\/wp-json\/wp\/v2\/media?parent=82"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}