- 20 Mar 2024
- 3 Minutes to read
- Print
- DarkLight
Prep for analytics integration
- Updated on 20 Mar 2024
- 3 Minutes to read
- Print
- DarkLight
Zilliant allows you to embed Tableau analytics for a Zilliant product into any end user system.
To prep for analytics integration:
- Verify the web addresses of the desired Tableau content.
- Set the size of published dashboards to Automatic.
This ensures that the dashboard’s size will adapt to the size of the Tableau view’s frame in your end user system.
- Filter Tableau content as desired by adding query parameters.
To integrate Tableau analytics into an end user system, follow one of two approaches:
- Configure Zilliant’s Visual Analytics Dashboard Lightning component to display Tableau analytics on any page. Perform this during integration into Salesforce.
- Integrate with Zilliant’s Report API to return the web address for a Tableau view with a one-time trusted ticket.
Verify a Tableau web address
To use Tableau content for an integration, make sure the content is published to the tenant’s Tableau Server site. Zilliant staff generally manage this Tableau content.
When you publish a Tableau workbook to a Tableau Server, Tableau assigns the workbook a name and displays each dashboard or sheet in the workbook as a separate view with a unique web address. Depending on your user permissions and the content published, the views will resemble the following image.
To verify a view’s web address, navigate to the desired view and read the page URL.
Add a query parameter
Tableau allows you to filter views or set the value of workbook parameters by adding query parameters to a Tableau server address. A query parameter is a case sensitive key-value pair.
For more information, read Tableau’s documentation about adding filters to embed code for views and about how view URLs are structured.
Set a workbook field value
To set the value of a workbook field through a Tableau web address, add a query parameter that meets the following requirements:
- The query parameter’s key must match a field name in the workbook.
- The query parameter’s key must contain a
%20
where the corresponding field name contains a space.For example,If a field’s name in the workbook is “Customer Id,” then the key of the query parameter based on this field is
?Customer%20Id=
.As best practice, avoid this complexity by initially naming workbook fields without spaces. For example, instead of naming a field "Workbook Field," name it "WorkbookField."
NoteDo not alter worksheet and view names in a web address. These names should not have spaces or character substitutes.
For example, for a view called “Customer Spend” in a workbook called “Sales IQ Action Analytics,” the view’s address should include
CustomerSpend
andSalesIQActionAnalytics
in its navigation.
To add a query parameter, you don’t have to configure the corresponding workbook field as a filter on a published view. However, as best practice, configure the desired views with the filter already present for testing prior to publishing the workbook.
Set a workbook parameter value
Setting a workbook parameter value through a Tableau web address allows you to filter across multiple dashboards and data sources. To do this, add a query parameter that matches the desired parameter’s name in the workbook.
Tableau allows you to further apply worksheet-level filters that reference the workbook parameter. For example, if you create a workbook parameter called “CRM_User,” then modify it with the query parameter ?CRM_User=
. To check if “CRM_User” matches the value of a “Salesperson Name” field:
- Create a field in the workbook with the appropriate calculation.
- Add the calculated field to the filter shelf of your desired views.
- Set the new filter to “TRUE” to only include data where the “Salesperson Name” value matches the “CRM_User” value.
Depending on your user permissions and your Tableau content, the filter will resemble the following image.
For more information, read Tableau’s documentation about filtering across multiple data sources using a parameter.