Skip to main content

Workflows

Workflows extends WinnerWare with reusable workflow activities for common communication and content-handling scenarios.

Overview

This module is used when administrators want to automate repeated communication or content lookup steps inside workflow definitions instead of building custom code for each case.

Key Features

  • Adds an activity to email a new user.
  • Adds an activity to email specific users.
  • Adds an activity to notify specific users.
  • Adds an activity to notify users in selected roles.
  • Adds an activity to retrieve published content by content item ID.

How It Works

The module adds workflow activities only when the related platform features are enabled:

  • Users + Email for email activities
  • Users + Notifications for direct user notifications
  • Users + Roles + Notifications for role-based notifications

This keeps the workflow toolbox aligned with the features available in the tenant.

Configuration

ActivityWhat administrators configure
Email New UserSubject and body templates for newly created users.
Email Specific UsersSelected users plus subject and body templates.
Notify Specific UsersSelected users to receive the notification.
Notify Users In RolesThe roles that should receive the notification.
Retrieve Published ContentA JavaScript expression that resolves to the content item ID to load.

Template support

The email activities support Liquid templates, and they also support shortcodes when shortcode support is available in the tenant.

Usage

Use this module when workflow definitions need to send messages to targeted users or fetch published content as part of a broader automation sequence.

Example setup

One clear workflow pattern is:

  1. enable WinnerWare workflow support alongside the email or notification features the tenant already uses
  2. create a workflow that reacts to the business event you care about
  3. add Email New User, Email Specific Users, Notify Specific Users, or Notify Users In Roles as needed
  4. use the retrieve-content task when the workflow also needs to load a published content item before the next step
  5. save and test the workflow with real tenant data

Developer Notes

  • The module registers its activities through conditional startup classes.
  • The email tasks include built-in guidance for using workflow input values such as username, email, and password.
  • The retrieve-content task expects a JavaScript expression that resolves to a content item ID.
  • The module also includes a migration used to correct workflow-start behavior.