workflow.md

Layout and Workflows

Reaction template display (layout) and workflow rules are created and stored in the Package registry.

A workflow is similar to package.registry entries, but package.layout entries are defined by the following properties:

• It does not control routes anywhere.

• each workflow in the package registry has a definition in Shops

• stores status in a collection specified in Shops

• collections should have attached Workflow schema

• audience is just another label for 'permissions', essentially just permissions for UIX.

• can be used to control page layout for the content manager

• audience can be used to control different check out, different product views, for users with different roles..

• a workflow controls "the how and where" of layout components

• can be used to trigger events from analytics events

• to disable a workflow template remove audience roles

• routes could be dynamically generated from registry

The default workflow configuration components are configured in the following manner:

Shops Collection

    "layout" : [
        {
            "layout" : "coreLayout",
            "workflow" : "coreLayout",
            "theme" : "default",
            "enabled" : true
        },
        {
            "layout" : "coreLayout",
            "workflow" : "coreCartWorkflow",
            "theme" : "default",
            "collection" : "Cart",
            "enabled" : true
        },
        {
            "layout" : "coreLayout",
            "workflow" : "coreOrderWorkflow",
            "theme" : "default",
            "collection" : "Orders",
            "enabled" : true
        }
    ]

Package Registry - Layout

Available in the Packages collection, ie: package.layout

"layout" : [
        {
            "template" : "checkoutLogin",
            "label" : "Login",
            "workflow" : "coreCartWorkflow",
            "container" : "checkout-steps-main",
            "audience" : [
                "guest",
                "anonymous"
            ],
            "priority" : "1",
            "position" : "1"
        },
        {
            "template" : "checkoutAddressBook",
            "label" : "Address Details",
            "workflow" : "coreCartWorkflow",
            "container" : "checkout-steps-main",
            "audience" : [
                "guest",
                "anonymous"
            ],
            "priority" : "2",
            "position" : "2"
        },
        {
            "template" : "coreCheckoutShipping",
            "label" : "Shipping Options",
            "workflow" : "coreCartWorkflow",
            "container" : "checkout-steps-main",
            "audience" : [
                "guest",
                "anonymous"
            ],
            "priority" : "3",
            "position" : "3"
        },
        {
            "template" : "checkoutReview",
            "label" : "Review Payment",
            "workflow" : "coreCartWorkflow",
            "container" : "checkout-steps-side",
            "audience" : [
                "guest",
                "anonymous"
            ],
            "priority" : "4",
            "position" : "4"
        },
        {
            "template" : "checkoutPayment",
            "label" : "Complete",
            "workflow" : "coreCartWorkflow",
            "container" : "checkout-steps-side",
            "audience" : [
                "guest",
                "anonymous"
            ],
            "priority" : "5",
            "position" : "5"
        },
        {
            "template" : "coreOrderCreated",
            "label" : "Created",
            "workflow" : "coreOrderWorkflow",
            "audience" : [
                "dashboard/orders"
            ]
        },
        {
            "template" : "coreShipmentTracking",
            "label" : "Tracking",
            "workflow" : "coreOrderWorkflow",
            "audience" : [
                "dashboard/orders"
            ]
        },
        {
            "template" : "coreOrderDocuments",
            "label" : "Preparation",
            "workflow" : "coreOrderWorkflow",
            "audience" : [
                "dashboard/orders"
            ]
        },
        {
            "template" : "coreProcessPayment",
            "label" : "Process Payments",
            "workflow" : "coreOrderWorkflow",
            "audience" : [
                "dashboard/orders"
            ]
        },
        {
            "template" : "coreShipmentShipped",
            "label" : "Shipped",
            "workflow" : "coreOrderWorkflow",
            "audience" : [
                "dashboard/orders"
            ]
        },
        {
            "template" : "coreOrderCompleted",
            "label" : "Completed",
            "workflow" : "coreOrderWorkflow",
            "audience" : [
                "dashboard/orders"
            ]
        },
        {
            "template" : "coreOrderAdjustments",
            "label" : "Adjusted",
            "workflow" : "coreOrderWorkflow",
            "audience" : [
                "dashboard/orders"
            ]
        }
    ]

Collection Workflows

For each collection using a workflow, a workflow schema is attached. The state/status of a workflow is stored as an object on each document in the collection.

"workflow" : {
    "status" : "checkoutLogin"
    "workflow": ["new", "checkoutLogin"]
},

Where status is the current workflow, and workflow are the workflow steps that have begun, or finished processing.

If workflow.workflow contains the current workflow.status, that means the workflow is processing, and when status now longer contains the workflow, but it exists in workflow.workflow the workflow has been completed.

Workflow Schema

For reference, the Workflow schema is:

ReactionCore.Schemas.Workflow = new SimpleSchema({
  template: {
    type: String,
    optional: true
  },
  label: {
    type: String,
    optional: true
  },
  provides: {
    type: String,
    optional: true
  },
  audience: {
    type: [String],
    optional: true
  },
  status: {
    type: String,
    optional: true
  },
  workflow: {
    type: [String],
    optional: true
  }
});