AEM Workflows

🔍 What Is It?

AEM Workflows are built on the OSGi-based CQ Workflow engine. A workflow consists of:

• →Workflow Model — The definition of the process (steps and transitions)
• →Workflow Instance — A running execution of a workflow model
• →Workflow Steps — Individual actions (participant step, process step, etc.)
• →Payload — The content being processed (usually a page or asset path)
• →Workflow Inbox — Where users see tasks assigned to them

Built-in Workflow Models:

• →Request for Activation (page approval)
• →DAM Asset Update (asset processing)
• →Request for Deactivation
• →Scheduled Activation

🎯 Why Do We Need It?

Workflows automate content governance processes:

• →Approval workflows — Content must be approved before publishing
• →Asset processing — Automatically generate thumbnails, extract metadata, transcode video
• →Notification workflows — Notify teams when content changes
• →Custom business processes — Any multi-step content operation

Without workflows, these processes would be manual, error-prone, and hard to audit.

🏗️ What Happens in Real Projects?

Common Real-World Workflows:

1. Content Approval — Author writes → Editor reviews → Legal approves → Publish
2. Asset Ingestion — Upload image → Generate thumbnails → Extract EXIF → Index for search
3. Campaign Launch — Build pages → QA review → Stakeholder approval → Schedule publish
4. Content Archival — Identify old pages → Notify owner → Archive or delete

In enterprise projects, workflow design is a significant part of the requirements phase — mapping business processes to AEM workflow models.

⚙️ How It Works

Workflow Step Types:

• →Participant Step — Assigns a task to a user/group. Workflow pauses until they complete it.
• →Dynamic Participant Step — Determines the participant at runtime (e.g., based on content path)
• →Process Step — Executes Java code (OSGi service). Used for automated processing.
• →OR Split / AND Split — Branching and parallel execution
• →Container Step — A sub-workflow
• →Goto Step — Loop back to a previous step

Workflow Launcher:

Automatically triggers a workflow when content changes. Configure in Tools → Workflow → Launchers. Example: trigger "DAM Asset Update" whenever an asset is created or modified.

💻 Example

Custom Workflow Process Step — A Java OSGi service that implements a custom workflow step.

@Component(
    service = WorkflowProcess.class,
    property = {
        "process.label=Send Approval Email"
    }
)
public class SendApprovalEmailProcess implements WorkflowProcess {

    @Reference
    private EmailService emailService;

    @Override
    public void execute(WorkItem workItem, WorkflowSession session,
                        MetaDataMap args) throws WorkflowException {
        // Get the payload (the page being processed)
        String payloadPath = workItem.getWorkflowData()
            .getPayload().toString();

        // Get process arguments from workflow model config
        String recipientEmail = args.get("recipientEmail",
            "approver@mysite.com");

        // Send notification email
        boolean sent = emailService.sendEmail(
            recipientEmail,
            "Content Awaiting Approval",
            "Please review: " + payloadPath
        );

        if (!sent) {
            throw new WorkflowException(
                "Failed to send approval email for: " + payloadPath
            );
        }
    }
}

🤔 Common Confusions

🚨 Common Production Issues

✅ Best Practices

🏛️ Architect's Note

💬 Frequently Asked Questions

🎯 Key Takeaways

🔗 Related Topics

🎯 Practice this topic in interviews

↗ Where this topic fits