PHPackages                             briefley/filament-workflow-builder - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. briefley/filament-workflow-builder

ActiveLibrary[Utility & Helpers](/categories/utility)

briefley/filament-workflow-builder
==================================

A Filament plugin for scheduled workflow orchestration with pluggable step executors.

1.0.3(2mo ago)109↓100%2MITPHPPHP ^8.2CI passing

Since Mar 28Pushed 2mo agoCompare

[ Source](https://github.com/briefley/filament-workflow-builder)[ Packagist](https://packagist.org/packages/briefley/filament-workflow-builder)[ Docs](https://github.com/briefley/filament-workflow-builder)[ RSS](/packages/briefley-filament-workflow-builder/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (6)Dependencies (6)Versions (11)Used By (0)

Filament Workflow Builder
=========================

[](#filament-workflow-builder)

A generic Laravel workflow orchestration package with pluggable step executors and an optional Filament admin UI.

Features
--------

[](#features)

- Interval and fixed-time daily workflow scheduling.
- Queue-driven workflow execution with pluggable step executors.
- Stale run protection and overlap control.
- Filament integration with a single **Workflows** navigation entry:
    - `Steps` relation manager for workflow step configuration.
    - `Runs` relation manager for history.
    - Run steps visible in a modal from each run row.

Compatibility Matrix
--------------------

[](#compatibility-matrix)

Package lineFilamentLaravelPHPStatus`^1.0``^5.0``^11.0 | ^12.0 | ^13.0``^8.2`Primary line`^0.4``^4.0``^11.28 | ^12.0 | ^13.0``^8.2`Legacy compatibility line`^0.3``^3.3``^10.45 | ^11.0 | ^12.0``^8.1 | ^8.2`Legacy compatibility lineRelease Lines
-------------

[](#release-lines)

- `^1.x` (Filament v5) is the default and latest release line.
- `^0.4.x` is the Filament v4 maintenance line.
- `^0.3.x` is the Filament v3 maintenance line.

Latest Tags
-----------

[](#latest-tags)

- `1.0.3` for Filament v5 projects.
- `0.4.1` for Filament v4 projects.
- `0.3.1` for Filament v3 projects.

Installation
------------

[](#installation)

1. Require the package for your Filament major.

```
composer require briefley/filament-workflow-builder:^1.0 # Filament v5
composer require briefley/filament-workflow-builder:^0.4 # Filament v4
composer require briefley/filament-workflow-builder:^0.3 # Filament v3
```

2. Publish config and migrations.

```
php artisan vendor:publish --tag=workflow-builder-config
php artisan vendor:publish --tag=workflow-builder-migrations
php artisan migrate
```

Maintenance Policy
------------------

[](#maintenance-policy)

- `^1.x` (Filament v5) is the primary feature line.
- `^0.4.x` (Filament v4) and `^0.3.x` (Filament v3) are compatibility maintenance lines.
- New features are developed on `^1.x` first, then selectively backported when safe.

Configuration
-------------

[](#configuration)

Define available step types and executors in `config/workflow-builder.php`:

```
return [
    'workflow_jobs' => [
        'hello_world_job' => [
            'label' => 'Hello World Job',
        ],
    ],

    'step_executors' => [
        'hello_world_job' => App\Workflow\Executors\HelloWorldStepExecutor::class,
    ],
];
```

Build Your Own Workflow Jobs
----------------------------

[](#build-your-own-workflow-jobs)

### 1. Create a step executor

[](#1-create-a-step-executor)

Each workflow "job" is a step type mapped to an executor class.

```