- 20 Mar 2024
- 1 Minute to read
- Print
- DarkLight
Integrate Tableau analytics
- Updated on 20 Mar 2024
- 1 Minute to read
- Print
- DarkLight
Zilliant allows you to embed Tableau analytics for a Zilliant product into any end user system. After prepping, follow one of two approaches for the analytics integration:
- 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.
Integrate with the Visual Analytics Dashboard
During integration into Salesforce, you can choose to configure the Visual Analytics Dashboard Lightning component to display Tableau analytics on any page. Each instance of this Lightning component in a page includes the following configuration parameters:
- Workbook—Name of the Tableau workbook. Must not include spaces.
- View—Name of the Tableau view. Must not include spaces.
- Dashboard Parameter 1-3—Field or parameter name in the Tableau workbook.
- sObject Field 1-3—API name of the sObject field passed into the corresponding Dashboard Parameter. This only applies when using the component on a Salesforce page.
- Dashboard User Info Parameter 1—Field or parameter name in the Tableau workbook.
- User Info Field 1—API name of the sObject field passed into Dashboard User Info Parameter 1. This name varies based on the user currently viewing the page.
- Height—Height of the Tableau dashboard when rendered on the page. Measured in pixels.
For example, if a record page contains:
- The field “zpf__CustomerId__c” with a value of 3000519
- The field “Name” with the value of Printer Paper | Heavy Weight Paper
Then configure the Visual Analytics Dashboard Lightning component with:
- The Workbook value of SalesIQActionAnalytics
- The View value of XSWSMoneyMap
- The Dashboard Parameter 1 value of CustomerId
- The sObject Field 1 value of zpf__CustomerId__c
- The Dashboard Parameter 2 value of ProductGroupParameter
- The sObject Field 2 value of Name
Zilliant then constructs the following web address to return the corresponding view from the Tableau server:
https://<server_name>//trusted/<trustedticket>/t/<sitename> /views/SalesIQActionAnalytics/XSWSMoneyMap?:embed=yes&:refresh&:toolbar=no&:tabs=no&CustomerId=3000519&ProductGroupParameter=Printer+Paper+%7C+Heavy+Weight+Paper&noUserParameters
Integrate with Report API
During integration into any end user system, Zilliant allows you to request the Report API to return the web address for a Tableau view. This address comes with a one-time use trusted ticket.
The basic syntax for a GET request to the Report API is:
GET {{ApiUrl}}/platform/Report/v1/[workbookName]/[viewName]?[queryParameters]
Replace [workbookName]
, [viewName]
, and [queryParameters]
(including brackets) with the desired workbook name, view name, and query parameters.
The GET request:
GET {{ReportApiUrl}}/platform/Report/v1/SalesIQActionAnalytics/XSWSMoneyMap?:embed=yes&:toolbar=no&:tabs=no&CustomerId=3001119
Returns the web address:
https://<server_name>//trusted/<trustedticket>/t/<sitename>/views/SalesIQActionAnalytics/XSWSMoneyMap?:embed=yes&:refresh&%3Aembed=yes&%3Atoolbar=no&%3Atabs=no&CustomerId=3001119