collective.contentrules.mustread 1.0a2

Setup contentrule

Add a new content rule.

Typically you’ll use Read confirmation requested as the triggering event.

This is fired when a user calls the @@request-read-confirmation view on a content object which is linked in the actions dropdown of content items if the user has the Request read confirmation permission.

You can also use other event triggers such as Object added to this container or Workflow state changed if this makes sense for your use-case.

As action choose Request read confirmation and configure it:

Email source

The email address notifications and reminders get send from (From: header)

Role

Currently the users who get notified of the read request are defined by a global, acquired or local role you can chose (similiar to collective.contentrules.mailtorole

We also support roles granted to groups and also support looking up users in nested groups

Maybe we’ll add support to alternatively choose groups and users directly in the future.

Acquired Roles

Also notify users which acquired Role from a parent object

Global Roles

Also notify users which have been granted Role in the user or group control panel.

Notification Subject

Subject of notification email

Notification Message

Text for the notification email. You can use all the replacement variables of plone.stringinterp and in addition the Content action specific variables)

Reminder Subject

Subject of reminder email

Reminder Message

Text for the reminder mail.

If empty, no reminder is sent

Deadline Delay

Number of days a read request must be confirmed within. Will be used to compute the deadline of requests.

Reminder Delay

Defines how many days before the deadline a reminder email will be sent.

Usage

After setting up the content rule you simply call the @@request-read-confirmation view on a content object.

This should be available in the actions dropdown of content items for users having the Request read confirmation permission.

For the users matching the role-filter defined in the action, a mustread database entry gets created and a notification email is sent out.

You’ll see a satusmessage indicating which usernames got notified.

If you want your users to get notified again some days before the deadline, you’ll want to Setup a reminder.

You can also Setup an expiration notification (an email report of missed read requests - which documents have missed requests and which users did not read the document).

There is a csv export (@@read-statistic-csv) that lists all mustread records (useful as audit-log or doing advanced spreadsheet-magic).

0  7  *   *   *     wget --quiet -O- --user=admin --password=admin --auth-no-challenge http://127.0.0.1:8080/Plone/@@send-read-reminders > /dev/null

Todos

• Report View for objects - shows mustread records for an object or context including child-objects.

  • A heading for each object, links to mustread report for this object

  • Table listing with sortable columns:

    username, deadline, read-at, status (read, read too late, not read)

• Add cleanup options to report view

  • Remove a single mustread entry

  • Remove all mustread entries

• Report view for users (link usernames in report for object)

  Table listing all objects the user has read, not read, read too late.

• limitation of types that offer must-read actions is done by marker interface (see archetypes.zcml) - there might be nicer ways

• implement dexterity behaviour for ICanBeMarkedAsMustRead

• Idea: separate content-action for notifications so we can define multiple notifications with different delays and texts

• Idea: allow to call @@send-read-reminders w/o authentication using a secret (similar to munin.zope)

Translations

This product has been translated into

• English

• German

Installation

Install collective.contentrules.mustread by adding it to your buildout:

[buildout]

...

eggs =
    collective.contentrules.mustread

zcml =
    collective.contentrules.mustread-archetypes

and then running bin/buildout

Install it via the addon configuration panel (Plone/prefs_install_products_form)

And make sure to configure the Database for collective.mustread

Contribute

• Issue Tracker: https://github.com/collective/collective.contentrules.mustread/issues

• Source Code: https://github.com/collective/collective.contentrules.mustread

Support

If you are having issues, please let us know via the issue tracker

License

The project is licensed under the GPLv2.

Contributors

• Harald Friessnegger, harald@webmeisterei.com

Changelog