schubergphilis / tableau-confluence-plugin

Plugin for confluence to show Tableau graphs within Confluence
Apache License 2.0
14 stars 7 forks source link
confluence embed-tableau-reports hacktoberfest java

Topics:

Tableau Server Configuration

Disable client ip checking

Run following tabadmin commands: Note tabadmin can be found here: "C:\Program Files (x86)\Tableau\Tableau Server\7.0\bin"

tabadmin set wg_server.extended_trusted_ip_checking false
tabadmin configure
tabadmin restart

Whitelist your confluence server(s)

Run following tabadmin commands:

tabadmin set wgserver.trusted_hosts "192.168.1.1, 192.168.1.2" (where 192.168.1.x are your confluence hosts)
tabadmin configure
tabadmin restart

The comma separated list of ip addresses should be within double quotes with a space after each comma.

For more information see the tableau server admin reference (page 224 / 225 / 229): http://downloads.tableausoftware.com/quickstart/server-guides/en-us/server_admin7.0.pdf

Installation of plugin

Configuration of plugin

Now that you have installed the plugin, configure your tableau hosts

Use a key, for instance: 'prod' or 'production' and a value 'http://tableauserver' or 'https://tableauserver' It's possible to enter multiple hosts, but the first entry is the default entry.

Optionally, you can specify a seperate internal address by adding -internal, for example 'prod-internal': 'http://internaltableau'

Optionally, to disable trusted authentication client side, use the key 'disableclienttrustedauth' and set the value to 'true' trusted authentication is still used for exporting to word/pdf

There is one special entry for debugging purposes, and that is the key 'debugusername', with this entry you can override the username that is used for trusted authentication.

If your tableau instance requires a domain to authenticate you users, you can configure it with the key 'domain', for instance 'mydomain.local'.

Embed tableau reports in confluence

Possible parameters:

Parameter Default value Description
title name of report, this title is shown when opening the full page interactive view from the 'interactive button'
workbook workbook name on the Tableau server (case sensitive)
view name of the view in the workbook (case sensitive)
height 550 height in number of pixels
width 1280 width in number of pixels
environment prod option to point to other environment configured in section 'Configuration of plugin', for example use acc for acceptance environment
interactive false opens sheet in interactive mode
embed true embed in page
toolbar true show or hide the toolbar
tabs false show tabs for all reports within the workbook
borderstyle extra css borderstyle properties, like 'border:red 1px solid' or 'background-color:gray'
button false option to add a button 'Interactive view' to the non interactive (png) view and open the interactive view in a window
noprint false when setting this option to true, this report will be skipped when printing / exporting to pdf or word
parameters send extra parameters to the report
refresh false refresh will invalidate the tableau cached png
site to specify the site to use

Basically there are two modes

Examples:

Basic example:

{tableau-plugin:workbook=TestWorkbook|view=Sheet1}

Set width and height

{tableau-plugin:workbook=TestWorkbook|view=Sheet1|width=1500|height=800}

Open interactive view and point to acceptance environment

{tableau-plugin:workbook=TestWorkbook|view=Sheet1|interactive=true|environment=acc}

Example of using parameters

{tableau-plugin:workbook=TestWorkbook|view=Sheet1|parameters=colour=blue&othervalue=100}