Documenting a Tableau Prep flow?
This page covers
.twb, .twbx, .tds, and .tdsx files. For .tfl and .tflx Prep flows, see Sample Output — Tableau Prep.Exports:Word (.docx)Excel (.xlsx)PDFHTMLCSV
Summary Statistics
A header section that gives readers a one-glance picture of the workbook size and shape.
- No. of DashboardsTotal number of dashboards in the workbook.
- No. of WorksheetsTotal number of worksheets across all dashboards.
- No. of Data SourcesDistinct data sources used in the workbook.
- No. of Data Source FiltersFilters applied at the data-source level.
- No. of Custom SQLCustom SQL statements referenced.
- No. of FieldsTotal fields across all data sources.
- No. of Calculated FieldsUser-defined calculated fields.
- No. of ParametersParameters declared in the workbook.
- No. of GroupsDistinct named groups defined in the workbook.
- No. of HierarchiesDistinct drill-down hierarchies defined in the workbook.
- No. of SetsDistinct sets defined in the workbook.
- No. of BinsDistinct numeric bin fields defined across all data sources.
- No. of StoriesTableau Story objects in the workbook.
Data Sources
Where every dashboard's data actually comes from — connection types, sources, and joins.
- Data Source AliasThe alias name of the data source as seen in the workbook.
- Data Source TypeThe connection type (e.g. live, extract, published).
- SourceThe system the data comes from — Excel, MySQL, PostgreSQL, Snowflake, etc.
- JoinsHow tables in this source are joined together.
Custom SQL
Every piece of custom SQL embedded in the workbook, captured verbatim.
- Data Source AliasWhich data source the SQL belongs to.
- Custom SQL NameThe name given to the custom SQL block.
- Custom SQLThe full SQL expression as written in Tableau.
Data Source Filters
Filters applied at the data-source level — including selections, conditions, and limits.
- Data SourceThe data source this filter belongs to.
- Field NameThe field that's being filtered.
- Field SelectionThe selection mode used (in/out, range, etc.).
- Selected Field Value(s)Specific values picked, when applicable.
- Field WildcardWildcard expressions used in the filter.
- Field ConditionConditional logic applied to the filter.
- Field LimitTop/bottom N limits applied.
- Context FilterWhether the filter is set as a context filter.
Worksheet & Dashboard Mapping
Which worksheets live on which dashboards (and storyboards), and which are unused.
- Dashboard / Storyboard NameThe container the worksheet appears on.
- Worksheet NameThe worksheet name as defined in the workbook.
- Object TypeWhether the container is a Dashboard or a Storyboard.
- Used in Workbook?Indicates whether the worksheet is referenced anywhere.
Storyboard-Dashboard Mapping
Maps each storyboard to the dashboards it references. Only appears for workbooks (.twb / .twbx) that contain Tableau Stories.
- Storyboard NameThe name of the Tableau Story.
- Dashboard NameEach dashboard nested inside that story.
Logins Used
Database credentials configured per data source. Only appears for workbooks (.twb / .twbx) with embedded connection credentials.
- Data Source AliasThe data source the credential belongs to.
- LoginThe username or credential name configured in the connection.
Tables & Fields
The complete field inventory — every field from every table in every data source, with metadata.
- Data SourceThe data source this field belongs to (hidden for .tds files).
- Source DatabaseThe underlying database or file the table comes from.
- Table NameThe table or logical table the field lives in.
- Field NameThe field name as it appears in Tableau.
- Remote Field NameThe original field name in the source system (alias resolution).
- Data TypeThe field's data type: string, integer, float, boolean, date, etc.
- Is UsedWhether this field is referenced by at least one worksheet (hidden for .tds files).
- FolderThe folder this field is organised into, if any.
- Dimension / MeasureWhether Tableau classifies this field as a dimension or a measure.
- HiddenWhether the field is hidden from the workbook's field list.
- CommentAny description or comment attached to the field in the data source.
Calculated Fields
Every calculated field, with its full formula — searchable and copyable.
- Calculation NameThe user-given caption of the calculated field.
- Tableau Field NameThe internal Tableau field name, which may differ from the display caption.
- Data SourceWhich data source the calculation belongs to (hidden for .tds files).
- FormulaThe complete expression behind the calculation.
- Is UsedWhether the calculated field is referenced by any worksheet (hidden for .tds files).
- FolderThe folder this calculated field is organised into, if any.
- Dimension / MeasureWhether Tableau classifies this field as a dimension or a measure.
Parameters
Parameters defined in the workbook — type, default, and allowed values.
- Parameter NameThe display name of the parameter.
- Data TypeInteger, Float, String, Boolean, Date, etc.
- Allowable Value TypeWhether the parameter accepts any value, a fixed list, or a numeric range.
- Current / Default ValueThe default value the parameter starts with.
- Allowed ValuesThe specific list or range of values permitted.
Groups
Named groupings that combine individual dimension members under a custom label.
- Group NameThe caption of the group as it appears in the workbook.
- Data SourceThe data source this group belongs to.
- Grouped ValuesThe sub-group names and the member values they contain.
- Is UsedWhether the group is referenced by any worksheet.
Hierarchies
Drill-down level definitions — the ordered field sequence that Tableau navigates on expand.
- Hierarchy NameThe name of the hierarchy as defined in the workbook.
- Data SourceThe data source this hierarchy belongs to (hidden for .tds files).
- FieldsThe ordered list of field levels that make up the hierarchy.
- Is UsedWhether the hierarchy is referenced by any worksheet (hidden for .tds files).
Sets
Fixed or calculated subsets of dimension members, used for in / out comparisons and set actions.
- Set NameThe name of the set as defined in the workbook.
- Data SourceThe data source this set belongs to.
- Filter DetailsThe filter conditions that define which members are in the set.
- Is UsedWhether the set is referenced by any worksheet.
Bins
Numeric buckets created for histogram charts and grouped continuous analysis.
- Bin NameThe caption of the bin field as it appears in the workbook.
- Data SourceThe data source this bin belongs to.
- Source FieldThe numeric field used to create the bin.
- Bin SizeThe width of each bucket.
- Is UsedWhether the bin is referenced by any worksheet.
Unused Objects
Spot worksheets, parameters, calculations, and more that no longer earn their keep.
- Unused WorksheetsWorksheets defined but never placed on a dashboard.
- Unused ParametersParameters that no calculation, filter, or worksheet references.
- Unused Calculated FieldsCalculated fields that no worksheet references.
- Unused HierarchiesHierarchies not referenced by any worksheet.
- Unused SetsSets not referenced by any worksheet.
- Unused GroupsGroups not referenced by any worksheet.
- Unused BinsBins not referenced by any worksheet.
- Unused FieldsTable fields not used in any worksheet.
- Unused Data SourcesData sources not referenced by any worksheet or dashboard.
Per-Dashboard Breakdown
For each dashboard: a focused view of its summary stats, worksheets, parameters, and quick filters.
- Dashboard — Summary StatsWorksheet count, parameter count, and other dashboard-level metrics.
- Dashboard — Worksheets UsedThe worksheets placed on this specific dashboard.
- Dashboard — Parameters UsedParameters wired into this dashboard.
- Dashboard — Quick Filters AppliedVisible quick filters on the dashboard.
Per-Worksheet Breakdown
For each worksheet: the dashboards it appears on, the data it queries, any data blends, all filters applied, and hidden mark members.
- Dashboards Used InEvery dashboard this worksheet is placed on.
- Data Sources UsedThe data sources queried by this worksheet, with connection type and join details.
- BlendsData blend relationships: primary data source, blended field, secondary data source, and blended field.
- Filters AppliedAll filters on the worksheet — member, relative date, categorical, quantitative, and action filters.
- Hidden ElementsMark members that are hidden on this worksheet.
Per-Storyboard Breakdown
For each Tableau Story: an ordered list of story points with the dashboard or worksheet each point displays.
- Storyboard NameThe name of the Tableau Story.
- Storypoint NameThe title of each individual story point.
- Object TypeWhether the story point shows a Dashboard or a Worksheet.
- Dashboard / Worksheet NameThe name of the object displayed in that story point.
Workbook Map
A visual hierarchy tree of the full workbook structure. Rendered for workbooks under the display threshold.
- Full Workbook TreeNested map showing storyboards → dashboards → worksheets in a single scrollable view.
- Per-Dashboard Sub-treeA focused drill-down tree for each dashboard, shown inline with its dashboard report.
- Per-Storyboard Sub-treeA focused drill-down tree for each storyboard, shown inline with its storyboard report.
Output Formats
The same source-of-truth content, exported to whichever format your audience expects.
- Microsoft Word (.docx)Editable handoff document for stakeholders and reviews.
- Microsoft Excel (.xlsx)Tabular form for analysis or further processing.
- Adobe PDFFormal handoff, governance reviews, audit packs.
- HTMLInternal portals, wikis, knowledge bases.
- CSVRaw data for ingestion into other systems or back into Tableau.
Generate this from your own workbook
Try RapidDox free for 7 days — all features unlocked, no credit card required. Start your free trial or see pricing.