Features

Macro Editor UI Tour

A complete visual walkthrough of the macro editor - where everything is and what it does.

Configure Report

Header Section

The top bar contains the primary controls for your report configuration.

Configure Report

Configure Report

Header ElementDescriptionNotes
Data SourceToggle between Spaces and Custom CQLChanges the Source Value field behavior below it
Source ValueThe actual query or space/page selectionCQL text for CQL mode; visual selector for Spaces mode
Result LimitMax records to returnDefault 50. Can be set to any number (e.g. 100, 500)
Report TypeDisplay format selectorTable, List, Paragraph, Grid, Charts
SavePublish the report to Confluence pageCloses editor after saving
CloseExit without savingPrompts if unsaved changes exist

Left Panel - Data Expansions

Load metadata fields required for columns, filters, and charts.

Configure Report

  • Search box - real-time filtering of expansion fields by name
  • Checkbox selection - check any group to load its fields
  • Favorites / Pinned - click the star icon to pin frequently used fields to the top
  • Hierarchical groups - organized by Structure, Body & Metadata, History
Expansion CategoryKey Fields
Structureancestors, children, descendants, container
Body & Metadatabody, metadata, operations, restrictions, version
Historycontributors, lastUpdated, previousVersion, nextVersion, ownedBy

Center Panel - Live Preview & Tools

The center panel is your main workspace - it shows results and provides all preview and debug tools.

Configure Report

ElementWhat It Does
Live PreviewDisplays report results in real-time. Updates automatically as configuration changes.
Filter PanelApply filter rows (Operator + Property + Value). AND logic, top-to-bottom execution.
ExploreSwitch to Explore mode - lists all available fields with types and sample values.
ExportDownload data as CSV (Table view) or JSON (all views). Includes copy-to-clipboard.
Edit (Lock/Unlock)Templates are locked after applying. Click Edit to unlock and modify.
PaginationPrevious/Next buttons, page numbers, results-per-page selector.

Right Panel - Configuration Tabs

Four tabs for configuring your report structure, applying templates, importing recipes, and inspecting raw data.

Configure Report

TabPurposeKey Actions
ColumnsDefine what data appears and how it is formattedAdd, Edit, Delete, Reorder, Duplicate, Hide columns
TemplatesBrowse and apply 35 tabular + 17 chart templatesSearch, select, apply - auto-configures everything
ImportImport JSON recipes to recreate report configurationsPaste JSON, validate, search, copy config
RawInspect raw JSON returned from ConfluenceView, search, expand/collapse, copy field paths

Saved Report on Confluence Page

After clicking Save, the macro editor closes and your live report appears directly on the Confluence page.

Configure Report

ElementWhere It AppearsWhat It Does
Report Title / HeaderTop of the macroShows the report name or description (if configured)
Table with Columns & RowsMain bodyDisplays live Confluence data - updates automatically as content changes
Search BoxTop of reportFilters visible rows by keyword - does not change the data source
Export Button (CSV/JSON)Top toolbarDownloads current report data - CSV for spreadsheets, JSON for integrations
Pagination Controls (Prev/Next)Bottom of reportNavigate between pages of results - shows current page and total count
Edit Button (pencil icon)Top right of macroReopens the macro editor - only visible to users with edit permission on the page

Complete Workflow Summary

  1. Set Data Source (Header) - choose Spaces or Custom CQL and enter source value
  2. Load Expansions (Left Panel) - select metadata groups needed for your columns
  3. Check Live Preview (Center) - confirm data is returning correctly
  4. Use Explore (Center) - discover available field paths and types
  5. Configure Columns (Right → Columns) - define what to display and how
  6. Apply Filters (Center) - refine which records appear
  7. Set Report Type + Result Limit (Header) - choose format and data size
  8. Inspect Raw View if needed (Right → Raw) - verify JSON paths
  9. Click Save (Header) - publish the live report to your Confluence page