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

Custom reports and scheduled exports for Filament

Let your users build their own reports from any Filament exporter, view the results in the panel, download them on demand, and have them emailed on as many schedules as they like.

Version Compatibility

Upgrading from 5.x?

6.0 is a breaking change. ExportSchedule has been split into CustomReport and ScheduledReport, and the export_schedules table is replaced. Your existing rows are migrated across automatically with no data loss, but app code that touched the old model, resource or table needs updating. Read UPGRADE.md before you upgrade.

Reports and schedules are separate things

A Custom Report is the definition: which exporter (or SQL query), which columns, which filters, and who is allowed to see it. The date range and file format for a delivery are chosen per-schedule.

A Report Schedule is an optional delivery instruction hanging off a report: when to run it, who receives it, who to copy in, what date range and file format to use, and whether to suppress empty results.

Keeping them apart means one report can be

• viewed in the panel and never emailed to anyone,
• downloaded ad hoc whenever somebody wants a copy,
• delivered on several schedules at once — daily to the ops team, monthly to the board.

It sits under a Reports navigation group by default: Custom Reports. Schedules are managed inline from the report itself, through the Schedules relation manager on its edit page.

Any Filament Exporter can be the starting point

• Exporters are discovered in App\Filament\Exporters, or add more locations in the config.
• All column formatting defined in the exporter is respected by the viewer, the ad hoc download and the emailed export alike.
• To keep data secure, only system users can own a report or receive one.

Or write a SQL query report

Set the report type to SQL Query and the exporter picker is replaced by a query field. Useful for reports no exporter covers: cross-table aggregates, window functions, or anything you would rather express in SQL than in Eloquent.

Column headings come from the result set metadata rather than from the rows, so the report is viewable and downloadable even when it matches nothing.

A SQL query is more privilege than most users should have, so creating one is gated by role:

Share reports with other users

Every report has a visibility mode:

Visibility grants viewing and downloading, nothing more. Editing, deleting, running and schedule management stay with the owner whatever the mode — a report shared with you is yours to read, not to change.

Let an admin see and manage everything

Ownership is deliberately strict, which leaves nobody able to tidy up a report whose owner has left. The BypassesReportVisibility contract is the escape hatch: return true for a user and they are treated as the owner of every report and every schedule.

Point the config at it, or bind the contract directly in a service provider:

A user who passes the check gets, on every report regardless of its visibility mode:

The contract takes a nullable user and is asked about guests too, so an implementation must handle null. The default, VisibilityBypass, returns false for everyone — nothing changes until you bind your own.

Filter by available attributes

Exclude attributes with the excludeFilterableAttributes method on the InteractsWithExportSchedulerFilter trait.

This is useful for excluding attributes not present in the database, or computed attributes/properties.

Date filtering is offered on any attribute via the <> (between) and is_in operators, using preset ranges: today · yesterday · last 7 days · last week · last 30 days · last month · this month · last quarter · this year · last year · next 7 days · next 30 days · next 60 days · next 90 days. The date column defaults to created_at and can be changed in the exporter.

Filter by available relationships

• BelongsTo relations (with InteractsWithExportSchedulerFilter set on the relation class) are automatically discovered.
• MorphTo relations can be filtered using dot notation paths.
• Exclude relations with the excludeFilterableRelations method on the same trait.

Make columns clickable to their records

A column can link straight through to the record it describes, the same way it already does on that record's own Filament table — an "Order ID" column linking to the order, an "End User" column linking to the user a relation resolves to.

Whoever builds a report only picks columns; there is nothing to configure per report. The exporter's author decides once, by implementing HasLinkedColumns on the exporter and returning a resolver per linkable column:

Every report built from OrderExporter gets these links automatically, on whichever of the two columns it selects. Returning null — no related record, or the resolver chooses not to link an unauthorized one — just leaves that cell as plain text for that row.

Only exporters implementing HasLinkedColumns get links; everything else, including SQL query reports, renders exactly as before.

Users choose which columns to include

• Columns must be defined in the exporter, or selected by the SQL query.
• All column formatting options set in the exporter are applied.

Easy frequency selection

Set on each schedule:

• daily
• weekly
• monthly
• quarterly
• half yearly
• yearly
• or a custom Cron expression for non-standard schedules

Each schedule carries its own timezone too, so one report can reach different regions at a sensible local hour.

An Enabled toggle sits beside the frequency, so a schedule can be built and left switched off until it is wanted, or paused later without deleting it. It can also be flipped straight from the list.

Choose who receives it

• One recipient per schedule, picked from any of your configured user classes.
• Any number of cc recipients from that same class.
• Change the recipient's class and the cc list clears itself, so ids are never reinterpreted against the wrong model.

The file format is chosen per-schedule: CSV or XLSX.

Automatic Recipients

A schedule can instead be fanned out: the report is rerun once per user found in the data, and each of them is sent only their own rows. The fields are hidden from the form by default, since it is a sharp tool and the visibility features now cover most of what it was used for.

Schedules that already have it enabled keep fanning out regardless of this flag — it only governs whether the fields can be reached in the UI.

Control when to send reports

• Choose whether to send when no data is found
  • Always send (default) — reports go out even with no rows
  • Only send when there are results — sending is skipped if the query returns nothing
• Prevents users from receiving empty reports
• The export files are still created and available in the system
• Ad hoc downloads are never suppressed by this setting: if you asked for the file, you get it

View report results in the admin panel

Opening a saved report shows its live results without running the export or emailing anyone.

• Full width table, 50 rows per page by default
• Click any column header to sort
• One search box matches every field in the results, across all pages
• A Download button runs the report through the normal export pipeline and returns the file to whoever asked for it, in either format

Filtering is not offered in the viewer, because filters are part of the report definition — change them on the report itself.

Searching and sorting are done in PHP rather than in the database, so that they work on columns that are not database columns: morph relations, relationship aggregates, accessors, and whatever expressions a SQL query report happens to select. The whole result set is therefore loaded when the page is opened. On very large reports set viewer_max_rows in the config to cap how many rows the viewer will load — the export itself is never capped.

File formats

A schedule's format is chosen when you create or edit it: CSV or XLSX. The download action offers the chosen format; CSV is always written first, and XLSX is built from it.

Attractive HTML email templates

• Default HTML email template included
• Or works well with Visual Builder Email Templates — if you want user editable emails

Installation

You can install the package via composer:

Copy views and migrations, then run the migration:

This creates the custom_reports and scheduled_reports tables. If you are coming from 5.x, a third migration copies your export_schedules rows across — see UPGRADE.md.

Optionally seed an example report for the users table. It creates a report of all users, delivered on the 1st of every month:

Schedule Command in Laravel

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

1. Register the Scheduled Command

In routes/console.php (Laravel 11+):

2. Check the server's 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
• customise the navigation menu
• set the disk to be used
• customise which notification and email template is used
• cap how many rows the viewer loads
• restrict who may write SQL query reports
• set which user classes can own reports, receive them, and be given visibility of them
• change how a user's display name and email address are read
• decide who, if anyone, may bypass visibility and administer every report

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/actions/prebuilt-actions/export

Polymorphism — using different user classes

This package uses this by default, so 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 call is already made in the package service provider, so you don't need to include it.

5. Add the plugin to your Filament panel provider

Both navigation items can be gated together, or one at a time:

Make some export classes with:

How the package identifies your users

Nothing here assumes your user model has email, id or name columns. Every id, display label and email address the package reads goes through the ResolvesReportUsers contract, resolved from the container.

The default resolver tries three things in order:

1. The model's own HasExportReportIdentity methods, if it implements that contract.
2. The title_attribute and email_attribute from config, read with data_get() — so dot notation into relations works.
3. A fallback label, so a user is never rendered as a blank option.

email_attribute deliberately does not inherit title_attribute. A model labelled by a person's name is never mailed at that name.

Per-model control

Or replace the resolver entirely

Filtering exports by a related attribute/model

A typical scenario might be exporting all Orders filtered by a specific Organisation. To filter by organisation we need to know the field that should be searchable.

This requires adding the InteractsWithExportSchedulerFilter trait to the models that can be filtered.

The trait provides:

• $filterOptionLabel — which column is used for the filter label.
• excludeFilterableAttributes() — exclude attributes, including nested ones, from column selection. Suitable for attributes that do not exist in the database.
• excludeFilterableRelations() — exclude relations that should not be offered in the filter. By default all BelongsTo relations are included.

MorphTo relations are also supported when filtering nested attributes.

Extending the package

The service, job, notification and mailable all take the report and its schedule as separate arguments. The schedule is always optional — pass none for an ad hoc run.

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.

Codex Setup

When using this repository in the OpenAI Codex environment, a .codex/setup.sh script will install PHP, MySQL, and Composer during initialization when network access is available.

Upgrading

Please see UPGRADE.md for the 5.x to 6.0 migration guide.

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.