Skip to main content
Keel Docs Showcase

Assignments and notifications

What it does

Items of a list can be assigned to a Pimcore user or role, so everyone sees who works on what. Keel adds an Assigned to column, Unassigned and Assigned to me filters, the assignee in the editor, an Activity tab with notes, and an Assigned to me card on the overview. A status field, if you name one, is logged with who changed it and when.

How it works for admins and editors: Assignments and Assignments & activity.

Default

Off. Only the classes you list get assignments.

Options

KeyDefaultWhat it does
assignments.classes.<Class>.status_fieldnoneSelect or text (input) field whose changes are logged with who and when
assignments.classes.<Class>.roles[] (all roles)Roles that can be picked, by name or ID
assignments.notifytrueSend the assignee a Pimcore notification when an item is assigned to them

Write Booking: ~ for a class with assignments and notes, but no status log.

Example

yaml
keel:
    assignments:
        classes:
            Enquiry: { status_field: status, roles: [sales-team, lettings-team] }    # role names: example values
            Booking: ~
        notify: false     # the team gets its tasks by e-mail from another tool

With notify: false, nobody gets a notification when an item is assigned. The assignment, the activity and the notes are written as usual. Other notifications – mentions, new notes, followed items, workflow steps (Notifications & following) – are not affected.

The status field must be a select or text (input) field with its own database column: not localized, and not inside a field collection or object brick. Other field types are not supported: keel:setup --check warns about a status field that does not exist or is the wrong type.

What admins change in Customize

In Customize → Lists, the person switch turns assignments on or off per class, and picks the status field. That choice wins over keel.yaml until Reset to automatic. roles and notify are only in keel.yaml.