← Documentation home

Live View (macro)

• Data Dictionary
• Documentation Coverage
• Setup Audit Trail
• Flow Visualizer
• ERD

Data Dictionary

Live View is MetaSync’s interactive global page inside Confluence — a live, filterable view of your synced org that anyone with space access can open, not just admins. Find it via the Confluence Apps menu. Unlike the published documentation pages, Live View is rendered on demand and always reflects your last sync. It has five tabs — Data Dictionary, Documentation Coverage, Setup Audit Trail, Flow Visualizer and ERD; this is the first.

Note — Who can see Live View data. Live View’s data is gated server-side on Confluence access: every tab’s data call checks — as the viewing user — that they can see the space/page the macro sits on, so Confluence’s own permission model decides. Viewers without access to that space get a single informational panel (with a Retry) instead of data. Calls that arrive without a page context (e.g. from the MetaSync dashboard) fall back to the admin / granted-access rule from Additional access.

Warning — Each viewer sees a one-time “Allow access” prompt. Because that check runs as the viewing user, Atlassian asks each person for consent the first time they open Live View — a one-time Allow access dialog naming MetaSync. Accepting it is what lets MetaSync confirm what they’re allowed to see; it grants MetaSync nothing beyond that check. A viewer who declines or dismisses it gets the access panel instead of data, and the decision sticks for the session: reload the page, accept the prompt, then use Retry. If the prompt doesn’t reappear, ask the viewer to reload in a new tab. See Live View: “You don’t have access to this data”.

The Data Dictionary tab is a cross-object index of every field in your org, flattened into one searchable table. It’s built from the field index MetaSync accumulates during sync, so it stays small and fast.

Note. A banner above the table reads N fields across M objects · last synced <date>, confirming the freshness of the data. Live View reflects the most recent sync — run a sync to refresh it. See How syncing works.

The columns

• Object — The object’s label, with its API name shown underneath in monospace.
• Field — The field’s label.
• API name — The field’s API name, in monospace.
• Type — The field’s data type (Text, Picklist, Lookup, etc.).
• Req — A ✓ if the field is required, otherwise a dash.
• PII — A High or Medium badge if the field is classified as personally identifiable, otherwise a dash. Drawn from Salesforce Data Classification — see PII & data classification.
• Enc — An Enc badge if the field is encrypted, otherwise a dash.
• Source — Custom or Standard — whether the field is custom-built or a standard/managed-package field.
• Doc — Yes (green) if the field has a description or help text, No (amber) if it has neither.

Searching and filtering

• Search box — matches across object API name, object label, field API name and field label.
• All objects dropdown — restrict to one object.
• All types dropdown — restrict to one field type.
• PII only checkbox — show only fields classified as PII.
• Encrypted checkbox — show only encrypted fields.
• A live N matches counter sits at the right of the controls.

Warning — Display cap. The table renders up to 1000 matching rows on screen at once; when more match, the counter reads (showing 1000). Narrow with the filters or the search box to reach fields beyond the cap. (There is no per-object expand/collapse — every field is a flat row.) See Truncation & display limits.

Note. If the table is empty it means no fields are indexed yet: run a MetaSync sync with Objects enabled, then reload. See Metadata Types & scope.

Warning — An empty state is never a disguised failure. Every Live View tab distinguishes “nothing stored yet” from “we couldn’t read it”. If the underlying read fails, the tab shows a red Error: … line instead of the empty state. That matters because Live View is usually opened by non-admins, who can’t run a sync — telling them to “run a sync” when the real problem is a storage read failure would send them down a dead end. A permission decision is different again, and is shown once for the whole macro as the informational access panel above — never as a red error on each tab.

Documentation Coverage

The Documentation Coverage tab of Live View scores how well your Salesforce schema is documented, on a 0–100 scale, and shows exactly which objects are dragging the score down. Like the rest of Live View it reflects your last sync.

The composite score

A large 0–100 score sits at the top. It’s a weighted composite of three of the metric rows below — documented fields count double the others:

Coverage formula (from computeCoverage in src/features/data-dictionary.ts)

overallScore = round( pctDocumented × 0.5  +  pctHelpText × 0.25  +  scoreSensitiveClassified × 0.25 )

Where pctDocumented is the share of fields with a description or help text, pctHelpText the share with help text, and scoreSensitiveClassified is the Detected-sensitive fields classified row — not the Fields PII / sensitivity classified row. All are whole-number percentages.

Warning — The third term is the detected-sensitive row, not the PII-classified row. These two metric rows are both shown on the page and they usually differ, because they have different denominators: Fields PII / sensitivity classified is measured against every field, while Detected-sensitive fields classified is measured only against the fields MetaSync’s detector flagged as sensitive. The score uses the detected-sensitive one. Substituting the PII-classified row into the formula above will not reproduce the score you see.

Note — An org with no detected-sensitive fields scores full marks on that term. When the detector finds no sensitive fields at all, scoreSensitiveClassified is 100, not 0 — an org with nothing to classify carries no classification debt and is not docked for it. That contributes the full 25 points. This is why a schema with no PII can still score respectably while showing 0% on the PII-classified row.

Colour thresholds

Every percentage badge and progress bar is colour-coded so weak areas jump out:

The metric rows

• Fields with descriptions — Fields that have a description set, out of all fields.
• Fields with help text — Fields that have help text, out of all fields. (Weighted 25% of the score.)
• Fields documented (desc or help) — Fields with either a description or help text. (Weighted 50% — the heaviest.)
• Fields PII / sensitivity classified — Fields with a security classification or compliance group set, out of all fields. (Shown for context; not the term used in the score.)
• Detected-sensitive fields classified — Of the fields MetaSync’s detector flagged as sensitive, the share carrying a Salesforce classification. (Weighted 25% — this is the score’s third term. Scores 100 when nothing was detected.)
• Objects fully documented — Objects where every field is documented, out of all objects. (Shown for context; not part of the score.)

Least-documented objects

Below the metrics, a Least-documented objects table lists up to the 10 worst objects (ascending by documented %), each with its label and API name, a documented-% badge, and a documented / total field count — your prioritised to-do list.

How to improve the score

1. Start with the objects in the Least-documented table — fixing the worst objects moves the score fastest.
2. In Salesforce Setup, add field descriptions and help text to fields that lack them (documented fields are weighted 50%).
3. Classify the fields MetaSync detected as sensitive using Salesforce Data Classification (Security Classification and Compliance Group). Classifying a detected-sensitive field is what moves the score’s third term — classifying an unflagged field changes the PII-classified row but not the score. See PII & data classification.
4. Run a MetaSync sync, then reopen this tab — the score refreshes from the new index.

Note. An empty state (No fields indexed yet) means you need to run a sync with Objects enabled first. For a downloadable, per-object version of this analysis with a to-document checklist, see the Documentation Coverage report in Governance.

Warning — This score and the Governance report’s score are computed differently. Governance also publishes a 0–100 Documentation Coverage figure, and the two numbers will not match — deliberately. This page scores the field-documentation surface (documented %, help text, detected-sensitive classification). The governance report additionally weighs object descriptions and uses its own weights, stated in that report’s own Summary. Neither is wrong; they answer slightly different questions. Quote whichever you use with its formula, and don’t reconcile one against the other.

Setup Audit Trail

The Setup Audit Trail tab of Live View is a browsable log of configuration changes in your Salesforce org, drawn from the Salesforce Setup Audit Trail and captured on each sync. It reflects the most recent sync.

Warning — Configuration changes only. The Setup Audit Trail records configuration changes (who changed which setting) — not record data changes. And Salesforce only retains it for about 180 days, so the timeline is a rolling window. A banner states this: N changes from the Setup Audit Trail (config changes only, not record data; Salesforce retains ~180 days). To keep audit history beyond that window, use the Change History report in Governance.

The columns

• When — The date and time the change was made.
• User — The user who made the change; if performed on behalf of someone, a via <delegate> note appears underneath.
• Type — A colour-coded badge derived from the action: Created (green), Changed (blue), Deleted (red), or Other (grey).
• Section — The Setup area the change occurred in (or a dash).
• Detail — The human-readable description of what changed.

Filters

• Search box — matches across the detail, section, user and action text.
• All users dropdown — filter to changes made by a single user.
• All change types dropdown — filter by Created, Changed, Deleted, or Other.
• A live N matches counter sits at the right of the controls.

Note. If the timeline is empty (No change history stored yet), run a MetaSync sync with Setup Audit Trail enabled in Metadata types, then reload.

Flow Visualizer

The Flow Visualizer tab of Live View draws each of your Salesforce Flows as a diagram, in the style of Flow Builder. Pick a flow from the dropdown (grouped into Active and Inactive, with an element count beside each) to render its canvas. It reflects your last sync.

Reading the diagram

Each element is drawn as a Salesforce-style shape, colour-coded by type, so the flow’s structure is readable at a glance:

• Diamond — Decision and Wait elements — the branching points. Each outgoing path is labelled with its outcome.
• Hexagon — Loop elements — with for each and after last paths.
• Rectangle — Screen and data elements (Record Create / Update / Delete / Lookup).
• Rounded rectangle — Actions, Apex, Subflows, Assignments and other elements.
• Green Start — The synthetic start node the flow runs from.

Connectors are colour-coded too: normal paths are grey, decision outcomes orange, fault paths red (dashed), and loop paths magenta. Click any element to open a side panel with its description, configuration detail, and — for decisions — each outcome’s conditions (field operator value).

Flow type, entry criteria and variables

• A type badge next to the picker shows how the flow runs — Record-Triggered (with before/after save and the create/update timing), Scheduled, Screen Flow, Platform Event, or Autolaunched — plus the trigger object.
• Entry criteria — for record-triggered flows, the conditions under which the flow runs are shown above the diagram (field operator value, joined by the flow’s AND/OR logic).
• Variables — an expandable list of the flow’s declared variables with their data type and whether each is a collection, input or output.

Note. The same diagram (shapes, type badge, entry criteria and variables) is also embedded on each Flow’s published documentation page, rendered as an image. If the Flow Visualizer is empty, run a MetaSync sync with Flows enabled in Metadata types, then reload.

ERD

The ERD (Entity Relationship Diagram) tab of Live View shows how your objects relate to one another. Each box is an object; each arrow points from the object holding a lookup or master-detail field to the object it references, labelled with the field(s) backing the relationship. It reflects your last sync.

Relationships are derived from the object dependency graph MetaSync builds during sync — the same data behind Change Impact — so the diagram stays consistent with the rest of your documentation. Self-referencing hierarchies (an object looking up to itself) are omitted to keep the diagram readable.

Note. A companion Entity Relationship Diagram page is also published into your Confluence space (under the home page), with the diagram as an image plus a full relationship table for large orgs. If the ERD is empty, run a MetaSync sync with Objects enabled, then reload.