Skip to main content

Metric Dictionary Structures

Output templates for Brief and Detailed Metric Dictionary documents.

Formulas, calculation types, parameter values and defaults, and joins or blends are not available through the Tableau MCP. Wherever a template asks for one, write "Not available via MCP; confirm with the owner" (for a calculated field's Type and Inputs, "confirm with data owner") unless the user supplied the formula.

Brief Metric Dictionary Structure​

Target: ~1 page. One-liner definitions for quick lookup.

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Metric Dictionary — [Datasource Name] (Summary)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Datasource: [Name] | Owner: [from list-datasources, else Not available via MCP; confirm with the owner]
Fields documented: [count] | Scope: Measures & Calcs

MEASURES
| Metric | Definition | Direction |
|--------|-----------|-----------|
| [Name] | [One-line plain-language definition] | ↑/↓/→ |
| [Name] | [One-line plain-language definition] | ↑/↓/→ |
[One row per measure]

CALCULATED FIELDS
| Field | What It Does | Type |
|-------|-------------|------|
| [Name] | [One-line explanation from name/description] | [confirm with data owner] |
| [Name] | [One-line explanation from name/description] | [confirm with data owner] |
[One row per calc. Brief dictionaries never include a parameters table.]

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Length target: 30-60 lines. Table-based, scannable.

Detailed Metric Dictionary Structure​

Target: 3-5 pages. Full field-level documentation.

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Metric Dictionary — [Datasource Name]
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Generated by Tableau Scribe | [Date]
Datasource: [Name] | LUID: [ID]
Owner: [from list-datasources if it returned one, else Not available via MCP; confirm with the owner]
Project: [same rule]
Total fields documented: [count]
Scope: [Measures & Calcs Only / All Fields]

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

PRIMARY MEASURES

[Metric Name]
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
• Definition: [What this measures in plain language]
• Business context: [Why someone would look at this]
• Directionality: [Higher is better / Lower is better /
Depends on context]
• Aggregation: [SUM / AVG / COUNT / COUNTD / etc.]
• Data type: [Integer / Float / Currency / Percentage]
• Typical range: [Based on sample query, if available]
• Related metrics: [Other measures often used alongside]
• Caveats: [NULL handling, edge cases, known issues]

[Repeat for each primary measure]

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

CALCULATED FIELDS

[Calc Name]
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
• Definition: [What this calculates in plain language]
• Plain-language logic: [How it works, from the name and
description only; if neither explains it, "confirm with data
owner". NO formulas unless the user supplied one]
• Type: [confirm with data owner — or Row-level / Aggregate /
LOD / Table Calc if the user supplied the formula]
• Inputs: [confirm with data owner — or the fields the user's
formula names]
• Directionality: [Higher/Lower/Context-dependent]
• When to use: [In what analysis context is this relevant]
• Caveats: [Filter sensitivity, NULL behavior, version reqs]

[Repeat for each calculated field]

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

SECONDARY MEASURES (if present)

[Briefer format — Definition + Aggregation + Data type only]

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

KEY DIMENSIONS (if all-fields scope selected)

[Dimension Name]
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
• Definition: [What this categorizes]
• Cardinality: [Low (<12) / Medium (13-50) / High (>50)]
• Typical values: [List 3-5 example values from a TOP-5 sample
query; omit for name, email, phone, address, or ID fields]
• Common use: [Filter / Color encoding / Row grouping / etc.]

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

DATE FIELDS (if all-fields scope selected)

[Date Field Name]
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
• Definition: [What event/action this date represents]
• Granularity: [Day / Month / Quarter / Year typically used]
• Range: [Earliest to latest in data, from sample]
• Primary use: [Time-series axis / Filter / Cohort assignment]

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

PARAMETERS (if all-fields scope selected and parameters exist)

[Parameter Name]
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
• Purpose: [What user decision this enables]
• Type: [String / Integer / Float / Date / Boolean]
• Allowable values: [Not available via MCP; confirm with the owner]
• Default: [Not available via MCP; confirm with the owner]
• What it controls: [Not available via MCP; confirm with the owner]

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

FIELD RELATIONSHIPS & NOTES

- [Any important relationships between fields]
- [Joins, blends, or data model notes: Not available via MCP; confirm with the owner]
- [Fields that should NOT be used together (different grains)]
- [Deprecation notes if any fields appear unused/stale]

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━