pnp / pnp/powershell

[BUG] PnP Provisioning does not handle Dashboard Web Parts correctly

Open
#5,396 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
C#
Stars
904
Forks
407
Avg merge
9h 16m
Merged PRs (30d)
10

Description

Related to #5374

Summary

When provisioning a Communication Site using a PnP Provisioning template, the Dashboard for Viva Connections web part on Home.aspx may not render the ACEs stored on Dashboard.aspx.

The issue appears related to the web part’s serialized personalizationData.DashboardId, which includes the Site Pages list item ID of Dashboard.aspx.

The DashboardId has this shape: {sitecollectionid}_{siteid}_{sitePagesListId}_{dashboardPageListItemId}

So, the provisioned web part can end up pointing at the wrong dashboard (page) item unless the token is correctly resolved or post-processed. When this is the case, the Dashboard Web Part displays the default set of ACEs instead of those in Dashboard.aspx.

I think this all stems from the fact that PnP Provisioning treats the Dashboard Web Part as a Custom Web Part. Here is the relevant section of the XML:

<pnp:CanvasControl WebPartType="Custom" JsonControlData="{&quot;webPartId&quot;:&quot;9cc0f495-db64-4d74-b06b-a3de16231fe1&quot;,&quot;rteInstanceId&quot;:null,&quot;addedFromPersistedData&quot;:true,&quot;reservedHeight&quot;:243,&quot;reservedWidth&quot;:1204,&quot;controlType&quot;:3,&quot;id&quot;:&quot;d8c79f95-65f8-4b12-b558-85fbf55fa1a7&quot;,&quot;position&quot;:{&quot;controlIndex&quot;:3,&quot;zoneIndex&quot;:5,&quot;sectionIndex&quot;:1,&quot;sectionFactor&quot;:100,&quot;layoutIndex&quot;:1,&quot;zoneId&quot;:&quot;fb7ff564-69ef-49d3-a5e2-2a049096ce08&quot;},&quot;emphasis&quot;:{&quot;zoneEmphasis&quot;:0},&quot;flexibleLayoutPosition&quot;:{&quot;lg&quot;:{&quot;x&quot;:0,&quot;y&quot;:4,&quot;w&quot;:70,&quot;h&quot;:14}},&quot;properties&quot;:{&quot;numVisibleCards&quot;:6,&quot;dashboardURL&quot;:&quot;https://{fqdn}{site}/SitePages/Dashboard.aspx&quot;,&quot;personalizationData&quot;:{&quot;DashboardId&quot;:&quot;{sitecollectionid}_{siteid}_{listid:Site Pages}_7&quot;,&quot;DashboardFormFactor&quot;:&quot;Mobile&quot;,&quot;DashboardCardDetails&quot;:[],&quot;LastModifiedDate&quot;:&quot;2026-06-30T20:58:14.8267543Z&quot;},&quot;title&quot;:&quot; &quot;},&quot;serverProcessedContent&quot;:{&quot;htmlStrings&quot;:{},&quot;searchablePlainTexts&quot;:{},&quot;imageSources&quot;:{},&quot;links&quot;:{}},&quot;dynamicDataPaths&quot;:{},&quot;dynamicDataValues&quot;:{},&quot;dataVersion&quot;:&quot;1.0&quot;}" ControlId="9cc0f495-db64-4d74-b06b-a3de16231fe1" Order="3" Column="1" />

Expected behavior

When a site is provisioned with:

  • Dashboard.aspx
  • ACEs on Dashboard.aspx
  • a Dashboard for Viva Connections web part on Home.aspx

…the Dashboard web part should render the same ACEs returned by:

Get-PnPVivaConnectionsDashboardACE

Actual behavior

After provisioning:

  • Dashboard.aspx contains the expected ACEs.
  • Get-PnPVivaConnectionsDashboardACE returns the expected ACEs.
  • But the Dashboard for Viva Connections web part on Home.aspx may show a different set of ACEs.
  • Clicking See all from the Dashboard web part opens a URL like:
    /sites/[siteName]/_layouts/15/sharepointapp.aspx?disableRedirect=true&isFromDashboardWP=true

rather than directly rendering the Dashboard.aspx page canvas.

This makes troubleshooting confusing because:

  • Dashboard.aspx may appear correct - but not usually because the ACEs don't seem to be provisioned correctly, either.
  • The Dashboard web part has dashboardURL pointing to Dashboard.aspx.
  • But the rendered cards may not match the ACE controls on Dashboard.aspx.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the PnP provisioning handling for the Custom CanvasControl and its serialized JsonControlData, then compare the DashboardId and dashboardURL values on Home.aspx with the provisioned Dashboard.aspx. Reproduce the scenario with Dashboard.aspx, its ACEs, and the Dashboard for Viva Connections web part, and verify that the rendered cards match Get-PnPVivaConnectionsDashboardACE.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.