For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configuration

Everything about how the extension behaves in your dashboard is set in the configuration dialog: which schemas it writes to, how the form looks, when data is refreshed and who may change what. This section walks through every screen in it.

Open the configuration

The cog overlay in the extension

The configuration is only available while you are editing the dashboard in Tableau. There are two ways in:

  • Tableau's own extension menu, via Configure...

  • The cog icon in the extension header, which opens an overlay with Configure Extension, Open Management Console and Cancel.

Both open the same dialog. Your users never see the cog — it only appears in authoring mode, and the configuration cannot be saved outside it.

The first time round there is nothing to configure yet, and the extension shows It's time to add your first schema! with a Start configuring button.

How the dialog is laid out

The configuration dialog, on General › Schemas

Three tabs across the top:

Tab
What it covers

General

Settings for the extension as a whole: which schemas are connected, authentication, popup behaviour, theming, tabs, mapping and import/export.

Worksheet-schema

Settings per connected schema: the General tab, Field formatting and Form builder.

Changelog

What changed in which version, plus support and documentation links.

Start with General to connect a schema, then open Worksheet-schema to configure each one.

Save and refresh

Nothing you change is stored until you press Save in the toolbar. While there are unsaved changes the button carries a blue dot, and the dialog keeps a floating message in view: You need to save the changes before closing the dialog!

Refresh pulls the latest settings from the back end, which is what you need after a schema was changed in the management console.

Shortcut
Action

Ctrl/Cmd + S

Save

Ctrl/Cmd + R

Refresh

Ctrl/Cmd + W

Close the dialog

Where to start

  1. Connect a schema to a worksheet under General > Schemas.

  2. Set up how records are created and refreshed under Worksheet-schema > General.

  3. Shape the form and the overview under Field formatting and Form builder.

  4. Match the extension to your dashboard under General > Theming.

Last updated

Was this helpful?