Add user_dashboard core extension (alpha) #27792

colemanw · 2023-10-11T23:39:28Z

Overview

There is a hidden thing in CiviCRM called the "User Dashboard" (not to be confused with the "Home Dashboard" or any of the component dashboards like CiviEvent). There are no menu links to it so it's hard to find, but if you stumble upon it at civicrm/user a wonder of non-configurable hardcoded-ness awaits your users.

Before

The user dashboard looks exactly like this. Aside from the ability to turn panes on and off, there are no configuration options (not even hooks for developers to make changes), so if this exact screen doesn't suit your idea of a delightfully user-friendly portal for your constituents, too bad:

After

If you enable the new "User Dashboard" extension,civicrm/user gives you this instead. It's an Afform of Search Displays, and absolutely everything about it can be configured via the FormBuilder and SeachKit UIs.

Technical Details

The way this extension picks up Search Displays to go on the default version of the Afform is by tag. So any other extension could add a packaged SavedSearch simply by tagging it "User Dashboard".

Comments

This reproduces all the tables but not the self-service links so I've tagged this extension as "alpha" until we figure those out.

civibot · 2023-10-11T23:39:31Z

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...

If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
For more information about contributing, see CONTRIBUTING.md.

Quick links for reviewers...

➡️ PR Demo site (can be rebuilt with the command test this please).
📖 Review standards
🗒️ Review template (brief or verbose)

➡️ Online demo of this PR 🔗

eileenmcnaughton · 2023-10-11T23:52:22Z

As this is Alpha / disabled by default & does not affect anything outside the extension itself then merge at will @colemanw

eileenmcnaughton · 2023-10-12T02:16:45Z

@colemanw note that the built in dashboard has some self-service links for events, recurrings

colemanw · 2023-10-12T02:43:24Z

@eileenmcnaughton I've just added the 2 missing tables so we've got parity on all the displays now. Just missing the self-service links. Maybe not too difficult, just need to figure out how to reproduce that functionality with... something.

eileenmcnaughton · 2023-10-12T02:52:08Z

@mattwire @MegaphoneJon I feel like I've seen both of you work in this area?

allinappliadmin · 2023-10-12T07:00:18Z

this is a cool extension complementary to the GDPR one so all contacts really know what's known and stored about them.

aydun · 2023-10-12T08:45:32Z

Tried to enable this extension on the test server but got "No option list found for 'tags'"

aydun · 2023-10-12T15:55:46Z

test this please

aydun · 2023-10-12T16:08:31Z

It enables ok and looks great... until I tried disabling the Pledges component and got:

Civi\API\Exception\NotImplementedException: API (Pledge, get) does not exist (or the extension it belongs to is not enabled). in Civi\API\Request::create() (line 51 of /home/jenkins/bknix-dfl/build/core-27792-15yxa/web/sites/all/modules/civicrm/Civi/API/Request.php).
The website encountered an unexpected error. Please try again later.

Likewise Member:

Civi\API\Exception\NotImplementedException: API (Membership, get) does not exist (or the extension it belongs to is not enabled). in Civi\API\Request::create() (line 51 of /home/jenkins/bknix-dfl/build/core-27792-15yxa/web/sites/all/modules/civicrm/Civi/API/Request.php).
The website encountered an unexpected error. Please try again later.

colemanw · 2023-10-12T16:11:38Z

@aydun do you get those on the dashboard page itself or elsewhere on the site?

aydun · 2023-10-12T16:19:36Z

@colemanw Just on the dashboard page

colemanw · 2023-10-12T16:28:16Z

@aydun ok, that's probably due to the 'cleanup' policy of the managed entities. I've switched it to "always" and that seems to fix it.

Includes search displays to replace the user dashboard, minus the action links

aydun · 2023-10-12T23:15:45Z

@colemanw All looks good for the searching and display and disabling/enabling components works as expected. Could merge now or wait to add the self-service actions.

colemanw · 2023-10-12T23:50:30Z

Thanks @aydun aside from that it's pretty well complete so I'll merge now so people can play with it.

composerjk · 2023-12-07T02:44:06Z

Just a minor note on @colemanw's statement of:

There are no configuration options at all

One can at least enable/disable the sections that are shown on the dashboard via CiviCRM > Administer > Customize Data and Screens > Display Preferences, in the Contact Dashboard section, e.g., we currently only show contributions and memberships (though we may add events as we move from to Civi for events):

Will be nice to see some configurability once the self-service options are added to the new user_dashboard core extension for membership renewal and events.

colemanw · 2023-12-07T15:40:31Z

Thanks @composerjk for pointing that out. I did notice that option while working on this and had updated the PR code to respect that setting but forgot to update the description. Updated it now.

colemanw · 2023-12-07T15:41:53Z

ext/user_dashboard/user_dashboard.php

+  // Transition note: the legacy dashboard used a setting ('user_dashboard_options')
+  // to control which panes are enabled.
+  // This new extension uses a tag.
+  // For the next year or so, we'll conditionally tag the searches in this extension based on that setting.
+  // When the transition is complete, the setting can be deleted and this class can be simplified to unconditionally
+  // tag all SavedSearches in this extension.
+  $legacySetting = Civi\Api4\Setting::get(FALSE)
+    ->addSelect('user_dashboard_options:name')
+    ->execute()
+    ->first();
+
+  // If the legacy setting corresponding to this pane is enabled, tag it


@composerjk this

civibot bot added the master label Oct 11, 2023

colemanw force-pushed the userDashboard branch from 1901bbe to f368b40 Compare October 11, 2023 23:43

colemanw force-pushed the userDashboard branch from f368b40 to beed9ba Compare October 12, 2023 02:08

colemanw force-pushed the userDashboard branch from beed9ba to d16518f Compare October 12, 2023 02:39

colemanw mentioned this pull request Oct 12, 2023

APIv4 - Prevent fatal errors when getOptions returns an empty array #27793

Merged

colemanw force-pushed the userDashboard branch from d16518f to eb32414 Compare October 12, 2023 16:26

Add user_dashboard core extension (alpha)

78a329c

Includes search displays to replace the user dashboard, minus the action links

colemanw force-pushed the userDashboard branch from eb32414 to 78a329c Compare October 12, 2023 20:22

colemanw merged commit 0255a72 into civicrm:master Oct 12, 2023
3 checks passed

colemanw deleted the userDashboard branch October 12, 2023 23:49

This was referenced Oct 14, 2023

FYI: Changes to User Dashboard coming... twomice/com.joineryhq.cdashtabs#10

Open

Tags - Add label field, enable tags as Managed Entities #27752

Merged

Improve formatting for recurring contributions in user dashboard #25058

Closed

colemanw commented Dec 7, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add user_dashboard core extension (alpha) #27792

Add user_dashboard core extension (alpha) #27792

colemanw commented Oct 11, 2023 •

edited

civibot bot commented Oct 11, 2023

eileenmcnaughton commented Oct 11, 2023

eileenmcnaughton commented Oct 12, 2023

colemanw commented Oct 12, 2023

eileenmcnaughton commented Oct 12, 2023

allinappliadmin commented Oct 12, 2023

aydun commented Oct 12, 2023

aydun commented Oct 12, 2023

aydun commented Oct 12, 2023 •

edited

colemanw commented Oct 12, 2023

aydun commented Oct 12, 2023

colemanw commented Oct 12, 2023

aydun commented Oct 12, 2023

colemanw commented Oct 12, 2023

composerjk commented Dec 7, 2023

colemanw commented Dec 7, 2023

colemanw Dec 7, 2023

Add user_dashboard core extension (alpha) #27792

Add user_dashboard core extension (alpha) #27792

Conversation

colemanw commented Oct 11, 2023 • edited

Overview

Before

After

Technical Details

Comments

civibot bot commented Oct 11, 2023

eileenmcnaughton commented Oct 11, 2023

eileenmcnaughton commented Oct 12, 2023

colemanw commented Oct 12, 2023

eileenmcnaughton commented Oct 12, 2023

allinappliadmin commented Oct 12, 2023

aydun commented Oct 12, 2023

aydun commented Oct 12, 2023

aydun commented Oct 12, 2023 • edited

colemanw commented Oct 12, 2023

aydun commented Oct 12, 2023

colemanw commented Oct 12, 2023

aydun commented Oct 12, 2023

colemanw commented Oct 12, 2023

composerjk commented Dec 7, 2023

colemanw commented Dec 7, 2023

colemanw Dec 7, 2023

Choose a reason for hiding this comment

colemanw commented Oct 11, 2023 •

edited

aydun commented Oct 12, 2023 •

edited