Overview, installation and quick start

Entity Activity creates per-user activity logs and notifications for content entity create, update, and delete operations. Users subscribe to entities, and log generators decide which activity produces a log.

Requirements

• The Token contributed module.
• The Drupal core Text, User, and Serialization modules.

Installation

Install the module with Composer, then enable Entity Activity and its dependencies.

composer require drupal/entity_activity

Quick start

1. Go to /admin/config/content/entity-activity/settings and enable the content entity types that users can subscribe to.
2. For each enabled entity type, place the Subscribe on component in the required view modes, or place the provided subscription block.
3. Assign subscription and log permissions to the appropriate roles.
4. Go to /admin/config/content/entity-activity, add a generator, and configure at least one log generator plugin.
5. Save and enable the generator.

The supported content entity types implement ContentEntityTypeInterface and have a canonical link template. Custom modules can alter the supported entity types by subscribing to entity_activity.support_entity_type; the custom module must then provide any subscription-generation behavior needed for entity types without canonical pages.

How Entity Activity works

A subscription connects a user to an entity and, where applicable, a translation. When a configured entity operation occurs, enabled log generator plugins find matching subscriptions and create log entities for their owners. Logs and subscriptions are fieldable content entities, so site builders can add fields and configure displays.

Similar projects

The Message and Flag modules can be combined to implement similar workflows. They are broader frameworks; Entity Activity is focused on subscriptions and activity logs.