Skip to main content
Keel Docs Showcase

Assignments

Assignments let a team see who works on what: each item of a list can be assigned to a Pimcore user or role, its status changes are logged with who and when, and colleagues can leave internal notes. For editors, see Assignments & activity.

Assignments are off until you turn them on for a class – during installation, in Customize, or in config/packages/keel.yaml.

Turn them on

During installation

bin/console keel:setup asks "Which lists should support assignments (who works on what)?" – pick any of the content classes (default: none). For each class picked it asks for the status field (logged with who and when), offering the class's select and text fields, or None. The answers go into keel.yaml as shown below.

In Customize

In Customize → Lists, each list has a person switch: on, the list's class gets assignments; next to it, pick the status field or No status log. Save applies it for everyone right away – no deploy, no cache clearing. Lists of the same class switch together.

What you choose here overrides keel.yaml; a class you don't change keeps the keel.yaml setup. Reset to automatic removes the overrides (and every other customization), so keel.yaml applies again. Turning assignments off hides the column, the filter, the editor panel, the Activity tab, the menu badge and the overview card – the stored assignees and the activity stay, and come back when you turn it on again. While it is off, the stored assignees stay protected: a save from an editor cannot remove or change them, and a copy still starts unassigned. Status changes made while it is off are not logged, so the activity has a gap for that time. The roles option can only be set in keel.yaml.

In keel.yaml

List the classes in config/packages/keel.yaml:

yaml
keel:
    assignments:
        classes:
            Enquiry: { status_field: status, roles: [] }
            Booking: ~                     # assignments and notes, no status log
OptionDefaultDescription
status_fieldnoneField whose changes are logged with who and when (see below)
roles[]Roles that may be picked, by name or ID. An empty list offers every role.

For each listed class, Keel adds the Assigned to column (people who may change an item can assign it right from that cell), the Unassigned and Assigned to me filters, Assign to… in the bulk bar, the assignee in the editor, the Activity tab, the badge in the menu and the Assigned to me card on the overview. The card can be switched off in Customize like any other card.

What is logged

ChangeLogged asWho
Assigned, reassigned or unassignedan assignment entry with the previous and the new assigneethe user who assigned
The status field changeda status entry, before → after (with the choice labels)the user who saved; System for imports and scripts
Internal notethe note's textits author

Entries are stored as Pimcore notes on the item (types keel-assign, keel-status, keel-note), so they also appear under Notes & Events in Pimcore. The assignee itself is stored as the item's property keel_assignee (user:<id> or role:<id>).

  • Assigning and adding notes never save the item and create no version.
  • The status is logged on every save of the item: in Keel, in Pimcore's own editor (Studio or classic), by an import or a script. Saving only a version (without publishing) is not logged.
  • The status field must be a select or text (input) field with its own database column. A localized status field, or one inside a field collection or object brick, is not logged – choose a plain field.
  • Keel owns the keel_assignee property: if someone edits or removes it in Pimcore's Properties tab, Keel puts the stored assignee back on save. Change the assignee in Keel. This holds for every class, also while assignments are switched off for it.
  • A copy (copy and paste, duplicate) always starts unassigned.
  • An item restored from the recycle bin keeps the assignee it had when it was deleted.

Permissions

WhoMay
Anyone with save on the itemAssign, reassign and unassign it
Anyone with view on the itemSee the assignee and the activity, add notes
Users and roles who can list the itemBe picked as assignee
  • A role can be picked when it has the Data Objects (objects) permission and its own object workspaces allow listing the item. Users who get that role are then notified and see the item under Assigned to me.
  • Inactive users cannot be picked.
  • Every assignment is checked again on the server: assigning to someone who cannot see the item is refused, whatever the screen shows.
  • Assignee names are visible to everyone who can see the item – that is the point of the feature.

Notifications

Keel uses Pimcore's own notifications. They show in Keel's bell and in Pimcore Studio's bell, which stay in step (Notifications & following), and they count in each user's Daily brief on the overview. The assignee gets one; for a role, every active member who can see the item gets one. A bulk assignment sends one notification per person for each batch of up to 500 items, on the server too. The text follows each recipient's Pimcore language (English, Croatian or German).

A developer can switch these notifications off for the whole project with assignments.notify: false in keel.yaml (Setup → Assignments); assignments, the activity and notes keep working.

When users or roles are deleted

Items assigned to a deleted user or role keep the assignment and show (removed user) or (removed role). Filters and the activity keep working; reassign the items in bulk to someone else.