Document that 'Track referencing basefields' must be checked to track some sources

Created on 26 October 2020, over 4 years ago
Updated 15 May 2025, 17 days ago

Problem/Motivation

I installed entity usage on a site, with the default settings. I couldn't seem to get custom menu links to appear in the usage statistics. After debugging a bunch I finally saw the "Track referencing basefields" option and checked that, which seemed to work.

Proposed resolution

Better document what the "Track referencing basefields" field does, and that it is required in order to track custom menu links, redirects and any other source entities.

Also perhaps check this by default? It is quite confusing that custom menu link and redirect are included in the source and target entities by default, but they don't work as expected until the setting is enabled.

Remaining tasks

  1. Confirm that this is correct?
  2. Agree on how best to document this. Either in the handbook, or via additional help text for the field.

User interface changes

TBC

📌 Task
Status

Active

Component

Documentation

Created by

🇦🇺Australia pameeela

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Thank you for this! I didn't know why custom menu links weren't being tracked, and this issue helped me solve the problem.

    I can confirm that enabling "Custom menu link" in source and target is not enough for menu links to be tracked in usage. You have to also enable "Track referencing basefields" in the entity usage settings. I agree that it's confusing that "Custom menu link" is enabled by default in both source and target, but it doesn't work without "Track referencing basefields," which is not enabled by default. It would make sense for either both to be enabled or both disabled. I think resolving the at-odds settings first makes sense. Documentation would certainly help, but it doesn't fix the disconnect with the default settings.

    This ticket is 5 years old, so it may be outdated, but I do find that redirects work without enabling "Track referencing basefields." Some work was done on that recently, so maybe that cleared up the issue with redirects.

  • It seems to me from this merged commit that redirects should always have base fields tracked, but that doesn't appear to be the case based on testing I just did. It also doesn't seem intuitive to have one setting discreetly enabling a setting that you manually have not enabled.

  • 🇪🇸Spain marcoscano Barcelona, Spain

    Thanks for raising this up, it had felt outside of my radar.
    In recent work we have added support for redirect and as part of that we realized it didn't make much sense to expose redirects to be used as source but not track redirect basefields, since that's the only way redirects can be linked to other entities. Because of that now if redirects are selected as source/target, we disregard the option to track basefields and also track redirects since that's the intended most specific behavior.

    I would be happy to move forward the same special-casing for menu links, since that's apparently the same scenario?

Production build 0.71.5 2024