Workflow in Joomla

1. De basis

1.1 Wat een workflow is

Standaard heeft een artikel één statusveld: het is gepubliceerd, gedepubliceerd, gearchiveerd of in de prullenbak, en elke redacteur met het juiste recht kan dat omzetten. Een workflow vervangt die ene schakelaar door een proces dat je zelf ontwerpt. In plaats van één schakelaar beweegt het artikel door fases die je benoemt (bijvoorbeeld Concept, Ter beoordeling, Gepubliceerd), en het beweegt alleen via overgangen die je toestaat.

Workflow is een optionele functie. Hij staat standaard uit, en je zet hem per component aan. Op dit moment levert de Joomla-kern workflow-ondersteuning voor artikelen (com_content); het systeem is zo gebouwd dat andere componenten het ook kunnen overnemen.

Zonder workflow is "publiceren" een vinkje. Met workflow is "publiceren" een deur die alleen bepaalde mensen kunnen openen, en het openen ervan kan extra acties starten.

1.2 De drie bouwstenen

Alles in Workflow bestaat uit slechts drie dingen. Leer deze drie woorden en het hele component wordt logisch:

1.3 Een plaatje van het idee

Zie fases als dozen en overgangen als de pijlen ertussen. De pijlen zijn eenrichtingsverkeer en jij bepaalt welke bestaan:

  [ Concept ] --indienen--> [ Ter beoordeling ] --goedkeuren--> [ Gepubliceerd ]
                                    │
                                    └--afwijzen--> [ Concept ]

Een redacteur die aan een artikel in de fase Concept werkt, ziet alleen de deuren die uit Concept leiden (hier: "indienen"). Ze kunnen niet rechtstreeks naar Gepubliceerd springen, omdat geen enkele overgang die twee fases verbindt. Dat is precies de bedoeling: de workflow bepaalt wat mogelijk is.

1.4 Waar je het vindt

Workflow leeft alleen in het beheergedeelte. Zodra het voor artikelen is ingeschakeld, verschijnt er een item Workflows in het Inhoud-gedeelte van het beheermenu, dat het scherm opent op index.php?option=com_workflow&view=workflows&extension=com_content.article. Daar beheer je workflows, en binnen elke workflow beheer je de fases en overgangen.

3. Fases: de statussen waar je inhoud doorheen beweegt

Een fase is een benoemde status. Goede fases ontwerpen is de kern van het bouwen van een workflow, dus het loont om er helder over na te denken.

3.1 Eén fase tegelijk

Elk artikel dat bij een workflow hoort, zit in precies één fase. Die fase is de huidige positie van het artikel in het proces. Als je de artikellijst bekijkt met workflow ingeschakeld, toont de kolom Fase waar elk artikel staat (Concept, Ter beoordeling, Gepubliceerd, enzovoort).

3.2 De standaardfase

Elke workflow heeft precies één standaardfase. Nieuwe artikelen komen in die fase de workflow binnen. Joomla bewaakt deze regel: je kunt de standaardfase niet verwijderen en niet depubliceren, want elke workflow heeft een geldig startpunt nodig. Probeer je het toch, dan toont Joomla een foutmelding en weigert het.

3.3 Fases ontwerpen

Een typische redactionele workflow gebruikt drie of vier fases:

Houd het aantal fases klein. Elke extra fase betekent meer overgangen om te definiëren en meer keuzes voor je redacteuren. Begin met de minste fases die je echte proces beschrijven, en voeg er pas meer toe als je er een mist.

5. Overgangsacties: publiceren, uitlichten en notificatie

Een overgang verplaatst een item tussen fases, maar op zichzelf is dat slechts een labelwijziging. De echte effecten komen van workflow-plugins, die acties toevoegen die een overgang kan uitvoeren. Joomla levert er drie.

5.1 De Publishing-plugin

De plugin plg_workflow_publishing laat een overgang de werkelijke status van het artikel instellen. In de Opties van de overgang kies je één waarde:

Dit is de brug tussen je workflow en het daadwerkelijk verschijnen van het artikel op de site. Een overgang naar je fase "Gepubliceerd" draagt normaal de publicatieactie "Gepubliceerd"; een overgang naar "Concept" draagt "Gedepubliceerd".

5.2 De Featuring-plugin

De plugin plg_workflow_featuring laat een overgang een artikel als uitgelicht markeren of niet, wat bepaalt of het in de lijst Uitgelichte artikelen verschijnt. De optie is simpelweg Uitgelicht (1), Niet uitgelicht (0) of "niet gebruiken".

5.3 De Notification-plugin

De plugin plg_workflow_notification stuurt een e-mail wanneer een overgang afgaat. Dit is wat een workflow tot leven brengt: wanneer een schrijver een concept indient, krijgen de redacteuren een bericht. In de opties van de overgang stel je in:

• E-mail versturen: aan of uit voor deze overgang.
• Notificatietekst: een eigen bericht om mee te sturen.
• Gebruikersgroepen: welke groepen je e-mailt (bijvoorbeeld alle Redacteuren).
• Ontvangers: specifieke individuele gebruikers om te e-mailen.

Omdat dit plugins zijn, hangen de actie-opties die je op een overgang ziet af van welke workflow-plugins zijn ingeschakeld. Schakel je de notificatie-plugin uit, dan verdwijnen de e-mailopties van elke overgang.

7. De visuele workfloweditor

Sinds Joomla 6.1 hoef je fases en overgangen niet meer alleen via lijstschermen te bouwen. Elke workflow heeft een visuele grafiek-editor die het hele proces toont als een diagram dat je met de hand kunt bewerken. Voor een workflow met meerdere fases is dat veel makkelijker te overzien dan twee aparte lijsten.

7.1 De grafiek openen

In Inhoud → Workflows heeft elke workflow-rij een koppeling Grafiek, die het canvas opent op index.php?option=com_workflow&view=graph&id=1&extension=com_content.article (met het eigen id van de workflow). Op het canvas is elke fase een doos (een knooppunt) en elke overgang een pijl (een verbinding) tussen twee fases, zodat je de vorm van je proces in één oogopslag ziet:

   +-----------+  indienen    +-------------------+  goedkeuren  +----------------+
   |  Concept  |------------>| Ter beoordeling   |------------>|  Gepubliceerd  |
   +-----------+             +-------------------+             +----------------+
        ^   afwijzen                  │
        └----------------------------└

7.2 Bewerken op het canvas

Je bouwt en wijzigt de workflow rechtstreeks op het diagram, met de muis of het toetsenbord:

• Fase toevoegen (Alt+N) zet een nieuw fase-knooppunt op het canvas.
• Overgang toevoegen (Alt+M) tekent een pijl van de ene fase naar de andere.
• Bewerk een geselecteerd knooppunt of pijl met E; verwijder het met Delete.
• Passend maken (F) zoomt het hele diagram terug in beeld.
• Sleep de fase-dozen om ze te ordenen zoals je proces het prettigst leest.

De editor respecteert je rechten: hij biedt alleen de knoppen voor bewerken, verwijderen en uitvoeren die je daadwerkelijk mag gebruiken, met dezelfde controles core.edit, core.delete en core.execute.transition die in sectie 9 worden beschreven.

7.3 Waar de indeling wordt opgeslagen

Wanneer je fases versleept, onthoudt Joomla hun posities. De coördinaten van elk fase-knooppunt worden als JSON opgeslagen in de kolom position van #__workflow_stages, een kolom die in Joomla 6.1 precies hiervoor is toegevoegd. Het canvas laadt zijn gegevens via kleine JSON-eindpunten die de workflow, zijn fases en zijn overgangen teruggeven, zodat het plaatje altijd overeenkomt met de onderliggende tabellen. De grafiek is alleen een vriendelijker gezicht op dezelfde fases en overgangen uit secties 3 en 4: wat je hier tekent, schrijft dezelfde rijen die je met de hand zou aanmaken.

9. Rechten en ACL

Workflow is alleen nuttig als de juiste mensen de juiste stappen kunnen doen, dus het is nauw verbonden met de toegangscontrole van Joomla.

9.1 De twee belangrijkste acties

9.2 Recht per overgang

Het slimme is dat core.execute.transition op een enkele overgang kan worden ingesteld, niet alleen op het hele component. Elke overgang is zijn eigen ACL-bron. Zo kun je de groep Schrijvers "Indienen ter beoordeling" laten uitvoeren terwijl alleen de groep Managers "Goedkeuren" mag uitvoeren. De workflow plus de rechten beschrijven samen wie inhoud vooruit mag duwen.

Overgang "Goedkeuren"  → tabblad Rechten
   ├─ Schrijvers: Overgang uitvoeren = Geweigerd
   └─ Managers:   Overgang uitvoeren = Toegestaan

9.3 Fases en workflows zijn ook bronnen

Workflows, fases en overgangen worden elk een ACL-bron wanneer ze opgeslagen worden, genest onder het component. Daarom dragen de workflow-tabellen een kolom asset_id: hiermee kun je rechten instellen op elk niveau van de hiërarchie, net als bij categorieën en artikelen.

11. Onder de motorkap: de PHP-API

Ontwikkelaars raken deze tabellen zelden rechtstreeks aan. Joomla biedt een kleine set klassen die het werk veilig doen.

11.1 De Workflow-klasse

De kernklasse Joomla\CMS\Workflow\Workflow stuurt overgangen aan. Je maakt hem voor een extensie en roept executeTransition() aan om items te verplaatsen. Hij leest de overgang, vuurt de events af, voert de plugin-acties uit en werkt #__workflow_associations voor je bij:

use Joomla\CMS\Workflow\Workflow;

$workflow = new Workflow('com_content.article');

// Verplaats artikel 42 en 43 via overgang id 2 ("Goedkeuren")
$workflow->executeTransition([42, 43], 2);

Achter die ene aanroep controleert de klasse of de overgang geldig is voor de huidige fase van elk item, verstuurt hij de events voor/na (sectie 12), laat hij de publishing- en notification-plugins hun werk doen, en schrijft hij ten slotte de nieuwe stage_id in de associatietabel.

11.2 Hoe een component workflow-ondersteuning aangeeft

Een component kiest voor Workflow door WorkflowServiceInterface te implementeren en WorkflowServiceTrait te gebruiken. Het component voor inhoud doet precies dit. De interface beantwoordt de vragen die de workflow-motor moet stellen:

use Joomla\CMS\Extension\Component;
use Joomla\CMS\Workflow\WorkflowServiceInterface;
use Joomla\CMS\Workflow\WorkflowServiceTrait;

class ContentComponent extends Component implements WorkflowServiceInterface
{
    use WorkflowServiceTrait;

    // Welke functies kan een overgang aansturen voor dit component?
    //   'core.state'    => true   (publiceren / depubliceren / archiveren / prullenbak)
    //   'core.featured' => true   (uitlichten / niet uitlichten)
}

Belangrijke methoden zijn onder meer isWorkflowActive($context) (staat workflow_enabled aan en ondersteunt het model het?), supportFunctionality($functionality, $context) (biedt dit component core.state of core.featured?) en filterTransitions() (welke overgangen zijn nu geldig voor een item?). Dit is de naad waar andere componenten in haken om workflow te krijgen.

13. Prestaties en probleemopsporing

Workflow voegt een klein beetje werk toe wanneer items worden opgeslagen en een paar extra tabellen aan de database, maar de kosten zijn klein, en die tabellen maken problemen makkelijk te traceren.

13.1 De prestatiekosten zijn klein

Een workflow-opzoeking is goedkoop. De huidige fase van een item vinden is een enkele geïndexeerde lezing op #__workflow_associations via zijn primaire sleutel (item_id, extension). De tabellen voor workflows, fases en overgangen zijn nietig naast #__content: een site met één workflow heeft één workflow-rij, een handvol fases en een handvol overgangen, hoeveel duizenden artikelen hij ook bevat. Het extra werk gebeurt wanneer een item wordt opgeslagen of een overgang afgaat, niet bij elke paginaweergave aan de voorkant, dus bezoekers merken er niets van.

13.2 De tabellen lezen om te debuggen

Omdat de status in vier kleine tabellen leeft, zie je met een paar query's precies waar elk item staat. Om de fase van artikel 42 te vinden:

SELECT s.title AS stage
FROM   #__workflow_associations AS a
JOIN   #__workflow_stages AS s ON s.id = a.stage_id
WHERE  a.item_id = 42
AND    a.extension = 'com_content.article';

Om de stappen op te sommen die een redacteur vanuit een bepaalde fase kan maken, lees je de gepubliceerde overgangen waarvan from_stage_id die fase is of -1 (Elke):

SELECT id, title, from_stage_id, to_stage_id
FROM   #__workflow_transitions
WHERE  workflow_id = 1
AND    from_stage_id IN (<huidige_fase_id>, -1)
AND    published = 1;

13.3 Veelvoorkomende dingen om te controleren

Wanneer inhoud zich vreemd gedraagt, ligt de oorzaak bijna altijd in deze tabellen of in de ACL:

• Geen rij in #__workflow_associations voor een item betekent dat het nooit de workflow is binnengekomen. Sla het item opnieuw op zodat het zijn standaardfase krijgt.
• Een overgang die de fase verplaatst maar niet publiceert, heeft een lege publicatiewaarde in zijn kolom options.
• Een item dat niet verder kan, heeft geen gepubliceerde overgang uit zijn fase, of de gebruiker mist core.execute.transition op de overgang die het zou verplaatsen.

15. SEO en metadata

Workflow heeft geen eigen tags in de paginakop, maar het heeft een echt, indirect effect op je SEO, omdat het bepaalt wat er überhaupt gepubliceerd wordt.

15.1 Niets halfaf gaat live

De meest voorkomende SEO-schade op teamsites is dat halfbewerkte of dubbele concepten op de live site glippen en geïndexeerd raken. Een workflow met een beoordelingsfase stopt dat: een artikel bereikt de status Gepubliceerd pas nadat iemand het goedkeurt, zodat zoekmachines afgeronde pagina's zien, geen werk in uitvoering.

15.2 Archiveren in plaats van verwijderen

Een fase Gearchiveerd (gekoppeld aan de gearchiveerde status) laat je oude inhoud netjes met pensioen sturen. Gearchiveerde artikelen verlaten de hoofdlijsten maar behouden hun URL, wat voor SEO veel beter is dan een pagina verwijderen en zo een dode link maken. Combineer een overgang "Archiveren" met een redirect-strategie voor inhoud die je echt weghaalt.

15.3 Consistente publicatiediscipline

Omdat publiceren door overgangen wordt geleid, worden je publicatiedatums en uitlicht-vlaggen consistent door de workflow gezet in plaats van ad hoc door elke redacteur. Consistent, bewust publiceren is stilletjes goed voor zowel lezers als crawlers.

17. Beste praktijken

Als je maar een paar dingen uit dit artikel onthoudt, onthoud dan deze:

• Schakel workflow alleen in als je een team of een proces hebt. Een solosite heeft er zelden baat bij en voegt klikken toe voor niets.
• Houd het aantal fases klein. Drie of vier benoemde fases dekken de meeste redactionele behoeften. Elke extra fase vermenigvuldigt de overgangen die je moet definiëren.
• Koppel publiceren zorgvuldig. Zorg dat de overgang naar je "live"-fase de actie Publiceren: Gepubliceerd draagt, anders verplaatst inhoud wel maar verschijnt hij nooit.
• Gebruik rechten per overgang. Dit is de echte reden om een workflow te draaien: laat schrijvers indienen maar alleen managers goedkeuren, met core.execute.transition.
• Schets de flow in de grafiek-editor voordat je de acties aansluit. De fases en pijlen zien maakt gaten en doodlopende wegen meteen duidelijk.
• Wijs workflows per categorie toe wanneer maar een deel van de site beoordeling nodig heeft. Laat de rest op de simpele standaard staan.
• Test de hele lus op een staging-kopie voordat je live gaat: indienen, goedkeuren, afwijzen, en controleer of de e-mails en de gepubliceerde status zich allemaal goed gedragen.

19. Samenvatting

Joomla Workflow verandert de simpele schakelaar "gepubliceerd of niet" in een redactioneel proces dat je zelf ontwerpt. Hij staat standaard uit en wordt per component ingeschakeld, te beginnen met artikelen:

• Voor redacteuren: inhoud beweegt door benoemde fases, en de enige stappen die je ziet, zijn de overgangen die toegestaan zijn vanaf waar het item staat.
• Voor beheerders: workflows, fases en overgangen, plus rechten per overgang, bepalen wie mag indienen, wie mag goedkeuren en wie mag publiceren, en met de visuele grafiek-editor ontwerp je de hele flow als een diagram.
• Voor ontwikkelaars: vier kleine tabellen, een enkele klasse Workflow, de WorkflowServiceInterface en de overgang-events voor/na leggen de hele motor netjes bloot, en de drie kernacties zijn gewoon plugins die je kunt kopiëren.
• Voor SEO: een beoordelingsfase houdt onafgewerkt werk uit de index, en een archiveerfase stuurt oude pagina's met pensioen zonder hun URL's te breken.

Zodra je de drie bouwstenen begrijpt, hoe de publicatieactie van een overgang de echte status zet, en waar de huidige fase wordt opgeslagen, kun je een proces ontwerpen dat bij je team past en precies traceren waarom een stuk inhoud wel of niet live is.

Als je redacteuren steeds per ongeluk dingen publiceren, of inhoud blijft halverwege hangen, lost een goed gevormde workflow dat meestal op. Het loont om de fases en rechten bewust te ontwerpen, want een workflow die bij je team past, verandert publiceren van een vrijbuiterij in een rustige, voorspelbare routine.