How to show the Q-button in dashboard embedding

Question & Answer
, , ,
1

I have a dashboard that displays the Q-button (that says ‘Ask a question about this dashboard’ in the center of toolbar) when viewed on QuickSight site/console. I’m trying to get the button to display while embedded on my Salesforce tab.

  • I’ve given the permission for “QuickSight:GenerateEmbedUrlForRegisteredUsers” to all users (“resource”: “*”).
  • I’m using the REST endpoint (/accounts/{account-id}/embed-url/registered-user) to get the embed url, passing the InitialDashboardId & FeatureConfiguration{AmazonQInQuickSight:{DataQnA:{Enabled:true}}} in request body.
  • In UI javascript, I’m using the embedding sdk to call embeddingContext.embedDashboard(frameOptions, contentOptions), where contentOptions includes toolbarOptions: { dataQnA: true, executiveSummary: true, buildVisual: true }, and the embed_url is set to ‘url’ prop of frameOptions.

The embed url is retrieved and the dashboard is embedded in an iframe as expected; however, the Q-button is missing. I can’t seem to make the embedDashboard() to render the button. BTW, the QuickSight user for whom the embed url is retrieved has READER_PRO license.

Is embedDashboard() supposed to be able to render the button? If so, what am I doing wrong?

2

Hello Raja,

First of all Welcome to the QuickSight Community.

To display the Q-button in an embedded QuickSight dashboard, you need to understand how the Q topic and dashboard embedding work together. When embedding a dashboard with an associated Q topic, the Q topic doesn’t automatically show up in the embedded view.

This is expected behavior as confirmed by AWS staff in the QuickSight Community.

For your specific implementation, there are two separate embedding approaches:

  1. If you create an embed for the dashboard, the Q topic doesn’t show up

  2. If you create an embed for the Q topic, it does not show the dashboard

You need to embed both elements separately as QuickSight supports different embedding elements including: Refer here

  • QuickSight dashboards and visuals

  • QuickSight Q search bar

  • Amazon Q in QuickSight

For embedding the Generative Q&A experience (which is the recommended replacement for the embedded Q Search Bar), you should use the Amazon QuickSight embedding SDK with specific configurations.

When using the SDK, you can customize the layout and appearance of the embedded experience using the panelType property, which can be set to either ‘FULL’ or ‘SEARCH_BAR’.

Refer here

To properly implement this functionality, you should refer to the documentation on “Embedding the Amazon Q in QuickSight Generative Q&A experience” which provides detailed steps for both registered and anonymous users. For Reference see here

Hope this helps.

Cheers,

Deep