X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FBackgroundJob%2FCleanBackgroundJobHistory.pm;h=6ec99f8005867888497be02dd748d53809f6dde7;hb=e5a76ed158219e3d2b19f142213f8a80c11627f1;hp=117a4d4ad8708ec9b6f3e958b16aa3ca7c863d5c;hpb=ee71ba3372b47b7de1e30d56db92c1315ae1e104;p=kivitendo-erp.git

diff --git a/SL/BackgroundJob/CleanBackgroundJobHistory.pm b/SL/BackgroundJob/CleanBackgroundJobHistory.pm
index 117a4d4ad..6ec99f800 100644
--- a/SL/BackgroundJob/CleanBackgroundJobHistory.pm
+++ b/SL/BackgroundJob/CleanBackgroundJobHistory.pm
@@ -1,5 +1,7 @@
 package SL::BackgroundJob::CleanBackgroundJobHistory;
 
+use strict;
+
 use parent qw(SL::BackgroundJob::Base);
 
 use SL::DB::BackgroundJobHistory;
@@ -27,3 +29,36 @@ sub run {
 }
 
 1;
+
+__END__
+
+=encoding utf8
+
+=head1 NAME
+
+SL::BackgroundJob::CleanBackgroundJobHistory - Background job for
+cleaning the history table of all executed jobs
+
+=head1 SYNOPSIS
+
+This background job deletes old entries from the table
+C<background_job_histories>. Each time a job is run an entry is
+created in that table.
+
+The associated C<SL::DB::BackgroundJob> instance's C<data> may be a
+hash containing the retention periods for successful and failed
+jobs. Both are the number of days a history entry is to be kept.  C<<
+$data->{retention_success} >> defaults to 14.  C<<
+$data->{retention_failure} >> defaults to 90.
+
+The job is supposed to run once a day.
+
+=head1 BUGS
+
+Nothing here yet.
+
+=head1 AUTHOR
+
+Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
+
+=cut