Download the PHP package visualbuilder/filament-export-scheduler without Composer

Configure scheduled routines for filament exporters

Email automated exports on a defined schedule - keep the management happy with timely reporting and minimise effort.

Empower users to create their own reports

Any Filament Exporter can be used as the starting point

• Exporters will be discovered in or add more locations in the config
• Send Exports to other users
• To ensure data security only system users can receive reports

Filter By Available Relationships

• BelongsTo relations (with 'InteractsWithExportScheduler' trait set on the relation class) are automatically discovered.
• Exclude relations with the 'excludeFilterableRelations' method available in the 'InteractsWithExportScheduler' trait.

Easy Frequency Selection

• Choose from preset frequencies
  • daily
  • weekly
  • monthly
  • quarterly
  • half yearly
  • yearly
• Or use a custom Cron for non standard schedules

Customise query data range

• Choose from preset query ranges
  • today
  • yesterday
  • last 7 days
  • last week
  • last 30 days
  • last month
  • this month
  • last quarter
  • this year
  • last year
• Custom date field if not created_at can be set in the Exporter

Users can choose which columns to include

• Currently all columns must be defined in the exporter
• Maybe will add ability to add user definable columns
• All Column Formatting options set in the exporter

Attractive HTML Email templates

• Default HTML email template included
• Or works well with Visual Builder Email Templates - if you want user editable emails
• Custom Report Builder and Templates coming soon

Installation

You can install the package via composer:

Copy views and migrations, run the migration

Optionally seed an example schedule for the users table This will export all Users on the 1st of every month.

Schedule Command in Laravel

To enable automatic sending you must add the console command to your scheduler.

1. Modify the Scheduler

Open app\Console\Kernel.php:

2. Check servers cron

Ensure your server is set up to run Laravel's scheduler by adding this cron entry

3. Review the config file

Here you can

• override the resource page
• customise the navigation menu
• set the disk to be used
• customise which notification and email template is used
• set which user classes can receive reports

4. Ensure you have added the filament Export migrations

If you don't have an exports table you can add it with:-

Check the docs at: https://filamentphp.com/docs/3.x/actions/prebuilt-actions/export

Polymorphism - Using different user classes

This package uses this by default, please ensure your exports migration has this line:-

This will create the columns user_type and user_id to allow any user type to be associated with an export.

Note: This code has already been included in the package service provider so you don't need to include it.

Add the plugin to your filament panel provider

Make some export classes with

New Feature - Filtering Exports by a related model

Typical scenario might be exporting all Orders but filtered by a specific Organisation. In order to filter by organisation we need to know the field that should be searchable. This requires adding the InteractsWithExportSchedulerFilter to the Models that can be filtered.

The trait has the $filterOptionLabel property allowing us to define which column should be used for the filter label. And excludeFilterableRelations allows you to exclude relations which should not be included in the filter, by default all belongsTo relations will be included. NB. Next release will include morphsTo relation options.

}

Testing

To prove the integrity of the system the test suite creates these schedules and simulates running the tasks every day for 4 years to ensure leap years are handled correctly.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Lee Evans
• All Contributors

License

The MIT License (MIT). Please see License File for more information.