When you open a Tableau workbook (.twb, .twbx) or a Tableau data source (.tds, .tdsx) in the RapidDox desktop app, you can generate documentation straight away — or choose to customise it depending on your needs through a six-step flow. This page documents every option in each step, in the order you encounter them.
See What Gets Extracted for what each section contains, and Sample Output Coverage for examples of the final document.
Step 1 — Background information
Provide the metadata that prints on the cover page and inside headers/footers.
| Field | Purpose |
|---|---|
| Company Name | Prints on the cover page and in the document header. |
| Logo | Upload an image (max 2 cm × 6 cm in the output). Used in the cover page header. |
| Description | Free-text "Background" paragraph included near the top of the document. |
| Requested by | Person or team who asked for the documentation. |
| Developed by | Person or team who built the Tableau content. |
| Requested Date / Completed Date | Dates printed on the cover page. |
| Audience | Intended readers of the documentation. |
Step 2 — Select Dashboards, Worksheets & Storyboards
Choose which workbook objects to include in the documentation. Each list supports include/exclude via checkbox and drag-to-reorder; an "Excluded" chip area below shows everything you've turned off.
- Dashboards — toggle each dashboard; "Select All" / "Unselect All" shortcut.
- Worksheets — toggle each worksheet; "Select All" / "Unselect All" shortcut.
- Storyboards — toggle each Tableau Story; "Select All" / "Unselect All" shortcut.
Step 3 — Dashboard / Worksheet images
RapidDox auto-picks the thumbnail images embedded in the workbook. If those are too low-res for your output, you can replace them.
- Import a PDF file with HQ images — pick a PDF (typically an export of the same workbook from Tableau) and RapidDox extracts the page-by-page images at full resolution.
- Export to PPT — exports the current image set to PowerPoint for manual editing.
- Assign images — pick the target (Dashboard, Worksheet, or Storyboard) and map imported images to specific objects.
Step 4 — Sorting
Apply multi-level sorting to specific metadata tables in the output. Sorting is auto-saved as you configure it.
- Sorting switch — master ON/OFF for the whole step. When OFF, the document uses Tableau's native order.
- Select table to configure — currently Tables & Fields and Calculated Fields.
- Sorting Levels (up to 3) — Level 1 is the primary sort, Levels 2 and 3 are tie-breakers. For each level:
- Sort by — pick the column to sort.
- Direction — A–Z or Z–A.
- Custom order — drag a list of values into a specific order instead of alphabetical.
- Move up / Move down / Remove — re-prioritise or delete the level.
Step 5 — Section ordering & column selection
The heart of customisation. Every section in the output is listed in groups, each with a drag handle to reorder and a checkbox to include/exclude. Sections that produce tables also expose a nested list of columns — those, too, can be reordered and turned off individually.
Background Information
- Include/Exclude — show or hide the entire Background page (description, requested-by, dates, audience).
General Information (15 sections)
Each row is a section you can reorder or turn off. Applies to tells you which file types the section is available for — Workbook, Data Source means all four (.twb, .twbx, .tds, .tdsx); Workbook only means just .twb and .twbx. Sections that produce a table also expose nested column toggles, listed in the last column; the callout at the top of this page lists which column toggles are themselves workbook-only.
| # | Section | Applies to | Column toggles |
|---|---|---|---|
| 1 | Summary Stats | Workbook, Data Source | — |
| 2 | Data Source | Workbook, Data Source | — |
| 3 | Custom SQL | Workbook, Data Source | — |
| 4 | Data Source Filters | Workbook, Data Source | Data Source, Field Name, Field Selection, Selected Field Value(s), Field Wildcard, Field Condition, Field Limit, Context Filter |
| 5 | Worksheets Mapping | Workbook only | Is Used |
| 6 | Dashboards Mapping | Workbook only | — |
| 7 | Logins Used | Workbook only | — |
| 8 | Tables & Fields | Workbook, Data Source | Data Source, Source Database, Table Name, Field Name, Remote Field, Data Type, Is Used, Folder, Dimension/Measure, Hidden, Comment |
| 9 | Calculated Fields | Workbook, Data Source | Calculated Field Name, Tableau Field Name, Data Source, Formula, Is Used, Folder, Dimension/Measure |
| 10 | Groups | Workbook, Data Source | Is Used |
| 11 | Hierarchies | Workbook, Data Source | Is Used |
| 12 | Parameters | Workbook, Data Source | Parameter Name, Data Type, Allowable Value Type, Current Value, Values, Is Used |
| 13 | Sets | Workbook, Data Source | Is Used |
| 14 | Bins | Workbook, Data Source | Is Used |
| 15 | Workbook Map | Workbook only | — |
Unused Objects in Workbook
- Unused Fields
- Unused Datasources
- Unused Worksheets
- Unused Parameters
- Unused Calculations
- Unused Hierarchies
- Unused Sets
- Unused Groups
- Unused Bins
Dashboards
Per-dashboard sub-sections that appear under each dashboard in the document:
- Summary Stats
- List of Worksheets using this Dashboard
- Parameters
- Quick Filter(s)
- Action(s)
- Dashboard Map
Worksheets
Per-worksheet sub-sections:
- List of Dashboards using this worksheet
- Data Sources
- Blends
- Filters
- Hidden Elements
- Actions
- Marks
- Calculated Fields
- Columns & Rows
- Applied Sortings
Storyboards
- Individual Storyboard Summary
- Filters
Layout Options (still on Step 5)
- Include Header — when on, the header text field is used on every page.
- Include Footer — bottom-of-page footer text.
- Include Center Footer — additional centred footer line.
Step 6 — Export
Pick one of five output formats:
| Format | Best for |
|---|---|
| Microsoft Word (.docx) | Editing or re-branding in any word processor. |
| Portable Document (PDF) | Sharing, print, email. |
| Microsoft Excel (.xlsx) | Section-by-section tables for analysis. |
| Web HTML | Publishing to an intranet or cloud. |
| CSV | Importing the metadata into other tools. |
Looking for the Tableau Prep flow? See Customise — Tableau Prep. Working with Power BI files? See Customise — Power BI.