Notifications // Swarm 2014.1: User Guide

Notifications

Swarm can be configured to provide generic notifications of committed changes in the Perforce service, taking the role of a review daemon.

Notifications configuration is expressed with a notifications block in the data/config.php file, similar to the following example:

<?php
    // this block should be a peer of 'p4'
    'notifications' => array(
        'honor_p4_reviews'      => false,           // defaults to false
        'opt_in_review_path'    => '//depot/swarm', // defaults to ''
        'disable_change_emails' => false,           // defaults to false
    ),

honor_p4_reviews: When set to true, Swarm sends notification emails for every committed change to all users where the change matches one of their Reviews: paths.
opt_in_review_path: This option specifies a special depot path, which typically would not exist in the Perforce service. When a path is specified, users must include this path in the Reviews: field of their user spec to cause Swarm to send the user a notification for every committed change that matches one of their Reviews: paths.
disable_change_emails: When set to true, notifications for committed changes, based on the Reviews: field and the users and projects you follow, are disabled.

Note

If your Perforce service already has a review daemon in operation, users receive two notifications for Reviews: paths. You may want to deprecate the review daemon in favor of Swarm's change notifications.