Skip to content
Capell CMS

Automation Studio

Package docs status

Section titled “Package docs status”

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

Field Value
Composer package capell-app/automation-studio
Package slug automation-studio
Product group Capell Automation
Tier premium
Bundle automation
Runtime contexts admin, console
Capell version ^1.0
Catalogue role extension
Release channel Labs
Source repository capell-app/packages
Source path packages/automation-studio
Docs source packages/automation-studio/docs
Manifest capell.json

What This Plugin Adds

Section titled “What This Plugin Adds”

Automation Studio is an Available, Schema-owning Capell package in the Capell Automation product group. It ships as capell-app/automation-studio and extends these surfaces: admin, console.

Automation Studio stores rule-based workflows that match Capell package events to registered native actions, Public Actions, or agent capabilities.

Operators create and pause rules, dry-run them before use, and inspect or replay recorded automation runs from the admin.

Evidence: capell.json, src/Models/AutomationRule.php, src/Actions/DispatchAutomationTriggerAction.php, docs/overview.admin.md, docs/screenshots.json, tests/Unit/Actions/DryRunAutomationRulesActionTest.php, tests/Unit/Actions/ReplayAutomationRunActionTest.php.

Status details:

  • Status: Available
  • Tier: premium
  • Bundle: automation
  • Composer package: capell-app/automation-studio
  • Namespace: Capell\AutomationStudio
  • Theme key: not applicable

Why It Matters

Section titled “Why It Matters”

For developers: Trigger and action registries let packages add workflow boundaries without coupling Automation Studio to their internal classes, and Actions own dispatch, persistence, recovery, and replay.

For teams: Teams can automate repeatable responses to package events and use run history to see whether each rule completed or failed.

Evidence: src/Support/AutomationTriggerRegistry.php, src/Support/AutomationActionRegistry.php, src/Contracts/AutomationActionHandler.php, tests/Unit/Support/AutomationStudioRegistryTest.php, docs/overview.admin.md, docs/screenshots.json, tests/Unit/Actions/RecordAutomationRunActionTest.php.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Automation rules admin index

Automation rule edit screen

  • Automation rules admin index (admin, required).
  • Automation rule edit screen (admin, required).
  • Automation runs admin index (admin, required).
  • Automation rule trigger and action builder (admin, optional).
  • Automation run failure detail (admin, optional).
  • Automation Studio dashboard widget (admin, optional).

Technical Shape

Section titled “Technical Shape”
  • Service providers: Capell\AutomationStudio\Providers\AutomationStudioServiceProvider, Capell\AutomationStudio\Providers\AdminServiceProvider.
  • Config files: packages/automation-studio/config/capell-automation-studio.php.
  • Migrations: packages/automation-studio/database/migrations/2026_05_31_170000_01_create_automation_rules_table.php, packages/automation-studio/database/migrations/2026_05_31_170000_02_create_automation_runs_table.php.
  • Models: AutomationRule, AutomationRun.
  • Filament classes: AutomationRuleResource, CreateAutomationRule, EditAutomationRule, ListAutomationRules, AutomationRunResource, ListAutomationRuns.
  • Policies: AbstractAutomationStudioResourcePolicy, AutomationRulePolicy, AutomationRunPolicy.
  • Extension contracts: AutomationActionHandler.
  • Listeners: DispatchAutomationFromAccessApproval, DispatchAutomationFromCampaignConversion, DispatchAutomationFromFormSubmission, DispatchAutomationFromWorkspaceStateChanged.
  • Actions: BuildAutomationRecoveryStatusAction, BuildSafeAutomationActionFailureResultAction, DispatchAutomationTriggerAction, DryRunAutomationRulesAction, LoadPersistedAutomationRulesAction, PersistAutomationTriggerResultsAction, QueueAutomationTriggerAction, ReapStaleAutomationRunsAction, RecordAutomationRunAction, RegisterAutomationStudioDefaultsAction, ReplayAutomationRunAction.
  • Data objects: AutomationActionDefinitionData, AutomationActionResultData, AutomationRecoveryStatusData, AutomationRuleActionData, AutomationRuleConditionData, AutomationRuleData, AutomationRuleDryRunResultData, AutomationTriggerDefinitionData, AutomationTriggerEventData.
  • Jobs: DispatchQueuedAutomationTriggerJob.
  • Manifest action API: dispatchAutomationTrigger: Capell\AutomationStudio\Actions\DispatchAutomationTriggerAction, dryRunAutomationRules: Capell\AutomationStudio\Actions\DryRunAutomationRulesAction, loadPersistedAutomationRules: Capell\AutomationStudio\Actions\LoadPersistedAutomationRulesAction, persistAutomationTriggerResults: Capell\AutomationStudio\Actions\PersistAutomationTriggerResultsAction, queueAutomationTrigger: Capell\AutomationStudio\Actions\QueueAutomationTriggerAction, reapStaleAutomationRuns: Capell\AutomationStudio\Actions\ReapStaleAutomationRunsAction, recordAutomationRun: Capell\AutomationStudio\Actions\RecordAutomationRunAction, registerAutomationStudioDefaults: Capell\AutomationStudio\Actions\RegisterAutomationStudioDefaultsAction, replayAutomationRun: Capell\AutomationStudio\Actions\ReplayAutomationRunAction.
  • Scheduled commands: capell:automation-studio:reap-stale (everyTenMinutes).
  • Console command classes: ReapStaleAutomationRunsCommand.
  • Manifest contributions: admin-resource: Capell\AutomationStudio\Manifest\AutomationRuleResourceContribution, admin-resource: Capell\AutomationStudio\Manifest\AutomationRunResourceContribution, model: Capell\AutomationStudio\Manifest\AutomationStudioModelsContribution, scheduled-job: Capell\AutomationStudio\Manifest\AutomationStudioRecoveryScheduleContribution.
  • Health checks: Capell\AutomationStudio\Health\AutomationStudioHealthCheck.
  • Cache tags: automation-studio.

Data Model

Section titled “Data Model”
  • Required tables: automation_rules, automation_runs.
  • Models: AutomationRule, AutomationRun.
  • Core record references in migrations: sites via site_id.
  • Migration files: 2026_05_31_170000_01_create_automation_rules_table.php, 2026_05_31_170000_02_create_automation_runs_table.php.
  • Migration impact: run host migrations through the package install flow before opening package surfaces.
  • Deletion/retention behaviour: migrations declare cascade-on-delete relationships and null-on-delete relationships; no timed pruning or retention schedule is declared in capell.json.

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin, capell-app/core.
  • Admin navigation: declares admin-resource: AutomationRuleResourceContribution, admin-resource: AutomationRunResourceContribution; each Filament page or resource controls its own navigation visibility.
  • Admin/editor extensions: none declared.
  • Permissions: View:AutomationRule, Create:AutomationRule, Update:AutomationRule, Delete:AutomationRule, View:AutomationRun, Update:AutomationRun.
  • Public routes: none declared.
  • Database changes: package migrations are declared.
  • Config: config/capell-automation-studio.php.
  • Settings: no package settings declared.
  • Queues or schedules: scheduled commands capell:automation-studio:reap-stale (everyTenMinutes); queue jobs DispatchQueuedAutomationTriggerJob.
  • Cache tags: automation-studio.
  • Commands: console command classes detected: ReapStaleAutomationRunsCommand.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core.
  • Run migrations before opening package resources or public routes.
  • Review package configuration before production-like verification: config/capell-automation-studio.php.
  • Register the host scheduler so these declared commands run at their documented frequencies: capell:automation-studio:reap-stale (everyTenMinutes).
  • Custom write integrations must preserve invalidation for automation-studio cache tags.

Troubleshooting

Section titled “Troubleshooting”
Symptom Likely cause Check Fix
Package surface is missing after install Provider or manifest is not loaded Confirm capell.json, package composer.json, and provider registration Reinstall the package, refresh Composer autoload, and clear host caches
Admin screen or command fails on missing table Package migrations have not run Check the tables listed in Data Model Run host migrations and rerun the focused package test
Background work does not run Queue worker or declared schedule is not active Check the jobs and scheduled commands listed in Technical Shape Start the queue worker or host scheduler, then run the focused command or package test

Quick Start

Section titled “Quick Start”
  1. Install the package: composer require capell-app/automation-studio.
  2. Run the required setup: php artisan migrate.
  3. Open the Automation rules admin index and confirm the admin workflow loads.

Next Steps

Section titled “Next Steps”