projekt kivitendo

__END__

=encoding utf8

=head1 NAME

SL::BackgroundJob::Base - Base class for all background jobs

=head1 SYNOPSIS

All background jobs are derived from this class. Each job gets its own

class which must implement the C<run> method.

There are two types of background jobs: periodic jobs and jobs that

are run once. Periodic jobs have a CRON spec associated with them that

determines the points in time when the job is supposed to be run.

=head1 FUNCTIONS

=over 4

=item C<create_standard_job $cron_spec>

Creates or updates an entry in the database for the current job. If

the C<background_jobs> table contains an entry for the current class

(as determined by C<ref($self)>) then that entry is updated and

re-activated if it was disabled. Otherwise a new entry is created.

This function can be called both as a member or as a class function.

=back

=head1 BUGS

Nothing here yet.

=head1 AUTHOR

Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>

=cut

__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