Introducing Astrato Embeds
The Embed feature in Astrato lets you take content from a published workbook and embed it in other web-based material. The content retains its interactivity and connection to the live source data meaning you have a single source of truth for your analytics wherever they’re used.
Share key live content from the business applications your team uses every day - CRM, HubSpot, Confluence, publicly on your website or in another SaaS product.
Contents
How Astrato Embeds works
The Embed feature creates a link to the source content you select from a published workbook. You can use the Embed link within an HTML <iframe> tag (Inline Frame) on a destination web page - or you can use the link on its own to display the content in a web browser.
Please note: Although most web browsers support the <iframe> tag, not all web-based text editors do. Please check with your Astrato Administrator or the documentation of the destination application or platform where you want to embed content.
Enabling the Embed feature for External Links (Administrators only)
The first step to using the Embed feature for external links requires your Astrato Administrator to enable its use.
Requirement: Data connections & Data View
For external links, the data connection and data view must be set to Visible to everyone, since all users, including anonymous users can have access to the embed, if the link has been shared with them.
Figure 1: Embed Links option in the Administration settings in Astrato.
From the Administration settings in Astrato, click View beside the Embed links or click here to get started
Use the toggle switch on the system settings page to allow users to create Embed links visible externally.
Figure 2: Switch to enable or disable external embed links.
Adding the allowed domains for external Embed links destinations
Administrators manage the list of domains allowed to embed Astrato content. This ensures that the live data source access stays inside approved platforms and applications.
The error message: Domain not added. Please contact your administrator displays if you have not added the domain to your list of allowed sites.
ℹ If nested frame are in use, make sure all URLs loading Astrato's iFrame are including in the allow list
Figure 3: List of allowed domains.
On the Allow List tab, click the button (+) New Domain to enter the Domain URL of the site your users want to embed content from their published workbooks. This applies to domains restricted to users with permission to view the Workbook and any externally available domains.
Click on the Items list tab to view all the items you’ve allowed.
Click the three dots on the right to Edit or Delete the domain.
Figure 4: Enter the Domain URL and click Save.
Adding subdomains
Replace the subdomain name with an (*) asterisk (as a wildcard). This allows all subdomains to be used as Embed link destinations within that domain.
Using the example in Figure 4, you'd enter *.lighting.force.com in the Domain URL field.
Creating Embed links
To create an Embed link, you must have one of the following roles: Creator, Workspace Owner, or Administrator.
⚠ Please note: There is no support for Actions within embedded objects, groups, or sheets.
Selecting the object to embed
Figure 5: Object source options for Astrato Embed links.
From your published workbook, select the object.
Right-click on the content from a published workbook that you want to embed.
Select the type of object to embed from the list: single object, grouped objects, or whole sheet.
Selecting a single object as an Embed link
Please ensure the object you want to use as an Object embed link is not layered under other objects. You can paste the link in the browser to check you've selected what you want to use.
This ensures you can click on it easily from your published workbook to create the link to the object.
Selecting a group of objects as an Embed link
The parent object group is used as the source of your Embed link when you select the option to create a Group objects Embed link. The nested group of objects (child) of a parent object group can’t be selected for use as a group.
Setting Embed link view permissions
Selecting - Restricted views
All Creators can generate restricted Embed links within their domain and share the link with other Astrato users in their company. This function for Creators does not need to be enabled by Astrato Administrators.
⚠ Please note: Viewers of any content in Astrato must have permission to view the underlying data.
Selecting - External (anyone can view)
The option to select 'External' is only available to action if your Administrator has enabled the feature for External Embed links.
⚠ Please note: Restricted links are not displayed when viewed in a browser's Incognito mode.
Figure 6: Select Embed link view permissions.
Select the view permissions for the source content, either Restrict: only users with view permissions managed centrally with the Enterprise Authentication feature will see any embedded content or External. External allows anyone with the Embed link to view the content in a browser.
Selecting Copy Link or Copy Embed code
Select Copy Link if you need the URL.
Select Copy embed code if you need the code with the <iframe> tag included.
Copy the URL and paste it into a browser to check your embed link works.
Figure 7: Select either the Copy Link or Copy embed code.
Tip: it is good practice to include a title attribute with an <iframe> as screen readers use it to read out the content inside the <iframe>.
Filtering embedded source data
You can apply a filter (as a parameter) to the view of the source data on an embedded sheet, thereby restricting the scope of the visible data.
Use this feature to produce contextual embeds, highlighting the data most relevant to where you've shared your embedded data.
Click the tick box Include applied filter to customize the view of the source data.
Click Create.
Figure 8: Astrato Embed filter source data
You can append a filter to a link by adding the filter query to your URL. The filters added to the link are structured as follows:
#queryFilter=Schema/Table/Field in ('value')"So, for example:
#queryFilter=Sales/Territory/Country in ('United States')"This filter query applies a filter on the United States in the Country field from the Territory table in the Sales schema.
The second example shows how to pass selections in multiple fields:
#queryFilter=Default/Territory/'Sales Country' in ('Australia', 'Canada') and Default/'Product Category'/'Product Category' in ('Bikes')
*Custom Data fields and Inline Table fields aren't supported for filtering in embed URL
🔒 Extending Security
For added security, duplicate your embed filter field and hash the value. This way, the value of the field is not revealed to the view, providing an added layer of security. If filters are removed, all data will be visible
Passing variables value in the embed link
An embed link can include values for variables defined in the workbook.
This can be used to control the display of the content by showing and hiding objects, setting the titles of objects, showing different languages for different users, and more.
You can append a variable value to a link by adding the variable tag to your URL. The variables added to the link are structured as follows:
#variable=variable_name:my name
For example:
#variable=vTop:10&variable=vIsMale:false&variable=vText:This is a nice app
This example sets the values for different variable types:
vTop a numeric variable, vIsMale a boolean variable, and vText a string variable
The example below combines passing a variable value and applying a filter on a field.
#variable=vTop:10&queryFilter=Default/Territory/'Sales Country' in ('Australia', 'Canada')
Adding a Refresh parameter to your Embed link
At the end of your Embed link, add the code:
[Embed link]#refreshData=60
In this example, the chart data refreshes every 60 seconds.
Managing Embed links
Viewing and Sorting Embed links
Administrators can see all Embed links; however, users with a Creator role can only see the Embed links they’ve made.
There are detailed sorting and searching options to help you manage your Embedded links.
From the Items list tab, the options are:
Name (Embed link), with the icon showing the type of link (object, group, sheet)
Workbook name
Created by
Permission type (External or Restricted)
Item link
Embed code
The icon beside the link name is linked to the type of object the link is for:
 | The chart icon indicates the Embed link is for a single object. |
 | Two squares inside a box indicate the Embed link is for a group. |
 | The icon showing a chart with a layer indicates the Embed link is for the whole sheet. |
Amending Embed link permissions
Users can change a link’s view permissions from Restricted to External or vice versa.
To modify an Embed link's permissions:
Click the box beside the links you want to change.
The 'modify embed link permission' dialogue displays. With the question, 'Who can view this?'
Select the option you want, Restrict or External.
Click Modify to amend permission or Cancel if you don't want to make the change.
Exporting from embeds
To create a new embed and enable export, be sure to check the Enable data export.
For existing embeds, enable export data. You can view existing embeds here.
First, select the embed link you wish to edit.
Then modify the embed link as shown below.
Troubleshooting
Nested iFrames
If nested frame are in use, make sure all URLs loading Astrato's iFrame are including in the allow list.
Data connections & Data View
For external links, the data connection and data view must be set to "Visible to everyone", since all users, including anonymous users can have access to the embed, if the link has been shared with them. See full guide here.