Quick Start Guide - Amazon QuickSight Connector for Confluence¶
This guide helps you quickly set up and use the Amazon QuickSight Connector for Confluence. Perfect for users familiar with Amazon QuickSight administration who want to embed dashboards and visuals in Confluence.
Prerequisites¶
Before you begin, ensure you have:
- Confluence Cloud Administrator permissions
- Amazon QuickSight Administrator access to manage the allowed-domain list for embedding
- An active Confluence Cloud space with page creation permissions
Step 1. Installation¶
- Install Amazon QuickSight Connector for Confluence on the Atlassian Marketplace on your desired Confluence instance.
- Once installed, you can find Amazon QuickSight Connector for Confluence in the top-level Apps menu, under Manage apps.
- The app does not require any admin configurations.
Step 2. Configure Amazon QuickSight to allow embedding visuals from Atlassian products¶
In order to embed visuals from QuickSight on your Atlassian Cloud instance, you need to add the Atlassian Cloud domains to the Allow list of static domains through the QuickSight console. Please follow the instructions in the Amazon QuickSight User Guide: Allow listing static domains and add the following Atlassian domains, including subdomains:
https://[your-subdomain].atlassian.net
https://prod.atlassian-dev.net
Information
The Amazon QuickSight Connector app is built with Atlassian Forge technology. The app is served by Atlassian from a subdomain under http://prod.atlassian-dev.net
that is both random and unique. Therefore, the https://prod.atlassian-dev.net
domain and its subdomains need to be added to the QuickSight allow list such that the Content Security Policy (CSP) set by Amazon QuickSight will allow the embed code to function.
The configured settings should be similar as shown below:
Step 3. Test embedding an Amazon QuickSight visual in a Confluence page¶
The app does not require any global or space level configuration. You can start embedding QuickSight visuals once you've finished the above steps. Let's give it a try.
Information
You can embed both dashboards and visuals. See Amazon QuickSight User Guide for more details on embedding visuals and dashboards.
-
Get the embed code from Quick Sight.
For visuals, click
Embed Visual
:For dashboards, first click
Share dashboard
:Then click
Copy embed code
: -
Create a new Confluence page or start editing a page. Type
/quicksight
into the page editor and Confluence should prompt you with the Amazon QuickSight macro, select to proceed: -
Hover over the inserted and click edit to bring up the config panel for the macro, where you can enter the embed code from QuickSight and choose the alignment of the visual.
Frequently Asked Questions (FAQs)¶
FAQ-1. Why can't I see the embedded visuals?¶
There are a few possible reasons:
- The Atlassian Cloud domains, including subdomains, are not added to QuickSight's allowed domains for embedding. Please refer to the steps above to ensure they are added.
- Your internet browser's "Block all cookies" setting is turned on. QuickSight requires this setting to be turned off in your browser.
-
You are not logged into Amazon QuickSight, and your dashboard is only shared with registered users. Please log in as a registered user of QuickSight and try again.
-
Your dashboard is not shared publicly for viewing without logging into QuickSight. Please review Amazon QuickSight User Guide: Turning on Public Access to Visuals and Dashboards with a 1-Click Embed Code for instructions if you want to allow public access to the visuals.
References¶
- Embedding visuals and dashboards for registered users with a 1-click embed code, Amazon QuickSight User Guide
- Turning on public access to visuals and dashboards with a 1-click embed code, Amazon QuickSight User Guide