​

Upgrading from v1#

While the changelog (opens new window) is the most comprehensive list of changes, this guide provides high-level overview and organizes changes by category.

​

Concept#

In Workflow 2, there's now a concept of Reviews in additionl to Submissions, to better represent the approval workflow.

In Workflow 1, a new submission was created each time an entry needed to be submitted for review. In addition, any actions (approved, rejected or revoked) would modify that single submission, leading to a lack of understanding of all the steps leading to a (hopefully) approved submission. For example, a review process might take several iterations to get right, all of which are tracked as separate submissions.

Now, in Workflow 2, a single Submission is created by an editor, and used for the duration of the review process. The only way a submission can be completed (so an editor can start another submission process) is for the Editor to revoke the submission, or a Publisher approving it. Rejections and Reviewer approvals will not complete a submission.

In addition to this, each time an action is performed on an entry, a Review is created. This helps to keep track of everything that happens during the review process from start to finish. As such, a single submission can have multiple reviews. Attributes like status are no longer stored on a submission, but on a review. We have added several methods to assist with getting the "latest" status, what type of user role the owner of the review was, and more.

For example, if you'd like to know the status of a submission, that's technically going to be the status of the most recent review on that submission. But you can still use submission.status to get this. Likewise, if you wanted to get the Editor, or Publisher from the most recent review, that's the same submission.editor, etc.

This should hopefully lead to a much better picture of the reviewal process.

​

Events#

The following events have changed:

// Workflow v1
use verbb\workflow\services\Submissions;

Event::on(Submissions::class, Submissions::EVENT_PREPARE_EDITOR_EMAIL, function(EmailEvent $event)
Event::on(Submissions::class, Submissions::EVENT_PREPARE_REVIEWER_EMAIL, function(EmailEvent $event)
Event::on(Submissions::class, Submissions::EVENT_PREPARE_PUBLISHER_EMAIL, function(EmailEvent $event)
Event::on(Submissions::class, Submissions::EVENT_BEFORE_SEND_EDITOR_EMAIL, function(EmailEvent $event)
Event::on(Submissions::class, Submissions::EVENT_BEFORE_SEND_REVIEWER_EMAIL, function(EmailEvent $event)
Event::on(Submissions::class, Submissions::EVENT_BEFORE_SEND_PUBLISHER_EMAIL, function(EmailEvent $event)

// Workflow v2
use verbb\workflow\services\Emails;

Event::on(Emails::class, Emails::EVENT_PREPARE_EDITOR_EMAIL, function(EmailEvent $event)
Event::on(Emails::class, Emails::EVENT_PREPARE_REVIEWER_EMAIL, function(EmailEvent $event)
Event::on(Emails::class, Emails::EVENT_PREPARE_PUBLISHER_EMAIL, function(EmailEvent $event)
Event::on(Emails::class, Emails::EVENT_BEFORE_SEND_EDITOR_EMAIL, function(EmailEvent $event)
Event::on(Emails::class, Emails::EVENT_BEFORE_SEND_REVIEWER_EMAIL, function(EmailEvent $event)
Event::on(Emails::class, Emails::EVENT_BEFORE_SEND_PUBLISHER_EMAIL, function(EmailEvent $event)

​

Front-end Submissions#

The front-end submissions should use the correct action endpoint for Craft.

​

Emails#

Email templates have changed slightly to factor in the new review variable present in emails. Because an email is essentially triggered on any action performed by a review, it makes sense to update the templates to reflect this information, rather than the overall submission.

You should only need to update your email templates if you're using custom ones, or have modified the default ones in your System Messages settings.

​

Submission Queries#

The following query params has been removed:

• dateApproved
• dateRejected
• dateRevoked

​

Submissions#

The following attributes for reviews have changed.

​

Reviews#

The following attributes for reviews have changed.