Skip to content
Capell CMS

Document Lifecycle

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/document-lifecycle
Package slug document-lifecycle
Product group Capell Publishing
Tier premium
Bundle publishing
Runtime contexts admin, console
Capell version ^1.0
Catalogue role extension
Release channel Labs
Source repository capell-app/packages
Source path packages/document-lifecycle
Docs source packages/document-lifecycle/docs
Manifest capell.json

What This Plugin Adds

Section titled “What This Plugin Adds”

Document Lifecycle is an Available, Schema-owning Capell package in the Capell Publishing product group. It ships as capell-app/document-lifecycle and extends these surfaces: admin, console.

Document Lifecycle records controlled documents, immutable versioned publications with content hashes, and the acceptance history for each published version.

Administrators manage document status, publications, review dates, and acceptances, while an optional Customer Portal contribution exposes relevant document history to signed-in customers.

Evidence: capell.json, src/Models/Document.php, src/Models/DocumentPublication.php, src/Models/DocumentAcceptance.php, docs/overview.admin.md, docs/screenshots.json, src/Filament/Resources/Documents/DocumentResource.php, tests/Feature/CustomerPortalDocumentFeedTest.php.

Status details:

  • Status: Available
  • Tier: premium
  • Bundle: publishing
  • Composer package: capell-app/document-lifecycle
  • Namespace: Capell\DocumentLifecycle
  • Theme key: not applicable

Why It Matters

Section titled “Why It Matters”

For developers: Publication, hashing, acceptance, and re-acceptance rules are implemented as Actions, with Publishing Studio and Customer Portal integrations registered at package boundaries.

For teams: Compliance teams can show which version was published, who accepted it, and when a changed document requires acceptance again.

Evidence: src/Actions/PublishDocumentAction.php, src/Actions/PublishDocumentFromPublishingRevisionAction.php, src/Actions/RequiresDocumentReAcceptanceAction.php, src/Providers/DocumentLifecycleServiceProvider.php, docs/admin-guide.md, tests/Feature/DocumentPublicationTest.php, tests/Feature/RecordDocumentAcceptanceTest.php, src/Actions/BuildDocumentAcceptanceCertificateAction.php.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Controlled documents index

Controlled document edit form

  • Controlled documents index (admin, required).
  • Controlled document edit form (admin, required).
  • Document publications relation manager (admin, required).
  • Document acceptances relation manager (admin, required).
  • Controlled document publish action (admin, optional).
  • Document acceptance certificate (admin, optional).
  • Controlled documents customer portal feed (frontend, optional).

Technical Shape

Section titled “Technical Shape”
  • Service providers: Capell\DocumentLifecycle\Providers\DocumentLifecycleServiceProvider.
  • Migrations: packages/document-lifecycle/database/migrations/2026_05_10_190868_01_create_document_lifecycle_documents_table.php, packages/document-lifecycle/database/migrations/2026_05_10_190868_02_create_document_lifecycle_publications_table.php, packages/document-lifecycle/database/migrations/2026_05_10_190868_03_extend_legal_acceptances_for_document_lifecycle.php, packages/document-lifecycle/database/migrations/2026_06_06_000001_add_review_dates_to_document_lifecycle_documents_table.php.
  • Models: Document, DocumentAcceptance, DocumentPublication.
  • Filament classes: DocumentResource, CreateDocument, EditDocument, ListDocuments, AcceptancesRelationManager, PublicationsRelationManager.
  • Policies: DocumentPolicy.
  • Actions: ArchiveDocumentAction, ArchiveExpiredDocumentsAction, BuildDocumentAcceptanceCertificateAction, BuildDocumentAcceptanceEvidenceCsvAction, BuildDocumentLifecycleHealthReportAction, BuildDocumentPublicationDiffAction, BuildOutstandingDocumentAcceptancesCsvAction, ComputeDocumentContentHashAction, PublishDocumentAction, PublishDocumentFromPublishingRevisionAction, RecordDocumentAcceptanceAction, RegisterDocumentAction, and 3 more.
  • Data objects: DocumentLifecycleHealthReportData, DocumentPublicationMetadataData.
  • Command signatures: capell:document-lifecycle:archive-expired.
  • Scheduled commands: capell:document-lifecycle:archive-expired (daily).
  • Console command classes: ArchiveExpiredDocumentsCommand.
  • Manifest contributions: admin-resource: Capell\DocumentLifecycle\Manifest\DocumentResourceContribution, migration: Capell\DocumentLifecycle\Manifest\DocumentLifecycleMigrationsContribution, model: Capell\DocumentLifecycle\Manifest\DocumentLifecycleModelsContribution, scheduled-job: Capell\DocumentLifecycle\Manifest\DocumentLifecycleRetentionScheduleContribution.
  • Health checks: Capell\DocumentLifecycle\Health\DocumentLifecycleHealthCheck.

Data Model

Section titled “Data Model”
  • Required tables: document_lifecycle_documents, document_lifecycle_publications, legal_acceptances.
  • Models: Document, DocumentAcceptance, DocumentPublication.
  • Migration files: 2026_05_10_190868_01_create_document_lifecycle_documents_table.php, 2026_05_10_190868_02_create_document_lifecycle_publications_table.php, 2026_05_10_190868_03_extend_legal_acceptances_for_document_lifecycle.php, 2026_06_06_000001_add_review_dates_to_document_lifecycle_documents_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, capell-app/publishing-studio.
  • Admin navigation: declares admin-resource: DocumentResourceContribution; each Filament page or resource controls its own navigation visibility.
  • Admin/editor extensions: none declared.
  • Permissions: ViewAny:Document, View:Document, Create:Document, Update:Document, Delete:Document, DeleteAny:Document, Restore:Document, ForceDelete:Document, Replicate:Document, Reorder:Document.
  • Public routes: none declared.
  • Database changes: package migrations are declared.
  • Config: no package config files.
  • Settings: no package settings declared.
  • Queues or schedules: scheduled commands capell:document-lifecycle:archive-expired (daily).
  • Cache tags: none declared.
  • Commands: capell:document-lifecycle:archive-expired.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core, capell-app/publishing-studio.
  • Run migrations before opening package resources or public routes.
  • Register the host scheduler so these declared commands run at their documented frequencies: capell:document-lifecycle:archive-expired (daily).

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/document-lifecycle.
  2. Run the required setup: php artisan migrate.
  3. Open the Controlled documents index and confirm the admin workflow loads.

Next Steps

Section titled “Next Steps”