Macro Reference
BoomiSight macros turn Boomi data into focused Confluence page sections. Use detailed macros when the Boomi context is a main part of the page. Use compact or inline macros when the page needs a dense status signal.
Configure Macros In The Confluence Editor
Section titled “Configure Macros In The Confluence Editor”Insert BoomiSight macros from the Confluence element browser. Search by the individual macro title, such as Integration Landscape Summary, Process Snapshot, API Snapshot, or Custom Process Properties and XREF, then choose the BoomiSight entry for the installed app environment.
Resource-specific macros open their own configuration view after insertion. Do not save a macro configuration until the resource, environment filters, date windows, and optional URL fallback are correct for the page.
Process Snapshot
Section titled “Process Snapshot”Use Process Snapshot when a runbook needs one Boomi process with deployment, drift, shape, connector, execution, and latest status context.
The detailed Process Snapshot shows the process name, freshness, component type, folder, shape count, connector action count, drift state, latest run, last status, 24-hour run/error counts, average duration, latest error, deployment table, source links, and Refresh.
The compact Process Snapshot is for dense pages that need the same process identity with less vertical space.
Configuration:
- Search process.
- Pick process from cached resources.
- Resource ID manual fallback.
- Resource URL optional fallback.
- Include configuration dependencies in detailed mode when the page should show verified Process Property and XREF relationships from the process’s current Boomi Build graph.
When configuration dependencies are enabled, the detailed macro can show safe Process Property and XREF structure, provenance, freshness, and added/removed/unchanged refresh summaries. These relationships describe the selected process’s current Boomi Build graph; they are not an environment-specific or historical deployed-version graph. Existing Process Snapshot macros remain unchanged until an author enables the option.
Supported authoring:
- Manual macro insertion.
- Supported Boomi build URLs can auto-convert to the detailed Process Snapshot macro when Confluence editor conversion succeeds.
Business Process Health Badge
Section titled “Business Process Health Badge”Use Business Process Health Badge near headings, checklists, or release decision blocks when readers need an inline execution health signal.
Configuration:
- Search process.
- Pick process.
- Resource ID and optional URL fallback.
- Optional display name.
- Optional environment filter.
The badge summarizes recent execution outcomes using the execution monitoring dataset. If execution data is unavailable or empty for the selected window, the badge should be interpreted with the same caution as the Execution Dashboard.
Atom Health
Section titled “Atom Health”Use Atom Health for Boomi Atom, Molecule, or Cloud runtime details.
Detailed mode is best for runbook runtime sections. Compact mode is best for dense runtime lists.
Configuration:
- Search atom.
- Pick atom.
- Resource ID manual fallback.
- Resource URL optional fallback.
Supported Boomi runtime URLs can auto-convert when they include an atom identifier and Confluence editor conversion succeeds.
Environment Summary
Section titled “Environment Summary”Use Environment Summary when a page needs environment classification, attached runtimes, and deployment counts.
Detailed mode provides more operational context. Compact mode supports summary tables or overview pages.
Configuration:
- Search environment.
- Pick environment.
- Resource ID manual fallback.
- Resource URL optional fallback.
Supported Boomi environment URLs can auto-convert when they include an environment identifier and Confluence editor conversion succeeds.
API Snapshot
Section titled “API Snapshot”Use API Snapshot for Boomi API service visibility. Detailed mode gives a fuller API card; compact mode gives a dense API reference.
Configuration:
- Search API resources.
- Pick API.
- Resource ID manual fallback.
- Resource URL optional fallback.
APIM details appear when available. If APIM metadata is unavailable, BoomiSight can still show Platform API-derived information and explain the partial state in API Governance and Diagnostics.
Custom Process Properties And XREF
Section titled “Custom Process Properties And XREF”Use Custom Process Properties and XREF when a Confluence page needs safe structural documentation for author-selected Process Property or Cross Reference components without exposing their values.
Configuration:
- Search and pick one or more Process Property components from cached resources.
- Search and pick one or more Cross Reference components from cached resources.
- Use the manual component fallback only for a known component when picker discovery is unavailable.
- Refresh facts when the selected component structure has changed in Boomi.
The Process Properties table can show sanitized component and property names, type, whether a default is present, persisted state, and allowed-value count. The Cross Reference table can show a sanitized table name, capped column names, column count, and row count.
Raw defaults, allowed values, password values, environment overrides, XREF rows and cells, source payloads, and internal identifiers remain hidden. Component display names can link to a validated Boomi Build destination for the configured space. The browser receives that validated navigation URL when a user opens the link, but the visible cell text remains the sanitized component name.
Author-selected components document those components only. Their presence in this macro does not prove that a process uses them. Use a detailed Process Snapshot with configuration dependencies enabled when the page needs verified process relationships.
Supported Boomi Build Link Routing
Section titled “Supported Boomi Build Link Routing”When Confluence editor conversion succeeds, a canonical Boomi Build component link can route by the component’s verified current type:
- Process links open a detailed Process Snapshot.
- Process Property and Cross Reference links open the custom structural view for that selected component.
BoomiSight accepts only the supported HTTPS Boomi Build route on the exact platform.boomi.com host and validates the component against the configured space. Malformed, external, lookalike, inconsistent, or unsupported links do not become BoomiSight navigation destinations.
Process Deployment History
Section titled “Process Deployment History”Use Process Deployment History when a page needs a chronological deployment timeline for one Boomi process.
Configuration:
- Search process.
- Pick process.
- Resource ID and optional URL fallback.
- Optional environment filter.
This macro depends on deployment history access.
Process Executions
Section titled “Process Executions”Use Process Executions when a runbook needs the latest execution rows and recent error concentration for one process.
Configuration:
- Search process.
- Pick process.
- Resource ID and optional URL fallback.
- Optional environment filter.
This macro depends on execution monitoring access and recent execution rows for the selected process and environment scope.
Process Blast Radius
Section titled “Process Blast Radius”Use Process Blast Radius before a change to understand shared connector dependencies and potentially impacted peer processes.
Configuration:
- Search process.
- Pick process.
- Resource ID manual fallback.
- Resource URL optional fallback.
This macro is strongest when Connector Inventory is enabled and refreshed.
Integration Landscape Summary
Section titled “Integration Landscape Summary”Use Integration Landscape Summary at the top of architecture or operations pages. It summarizes portfolio-level process, API, connector, environment, and health metrics from cached BoomiSight datasets.
Configuration:
- No per-resource configuration is required.
- Refresh uses the current space cache and dataset flags.
Release Notes
Section titled “Release Notes”Use Release Notes when a page needs deployment changes across a UTC date window.
Configuration:
- Start date in UTC.
- End date in UTC.
- Optional environment filter.
- Refresh Environment List.
- Save Macro Configuration.
The macro summarizes deployments, deployers, environments, and updated components for the selected window.
Choosing The Right Macro
Section titled “Choosing The Right Macro”| Need | Best macro |
|---|---|
| One process with deployment and drift context | Process Snapshot |
| One inline business health signal | Business Process Health Badge |
| One runtime health section | Atom Health |
| One environment summary | Environment Summary |
| One API service card | API Snapshot |
| Safe Process Property or XREF structure chosen by the author | Custom Process Properties and XREF |
| Verified current-Build Process Property/XREF relationships for one process | Detailed Process Snapshot with configuration dependencies enabled |
| Deployment timeline for a process | Process Deployment History |
| Recent execution rows for a process | Process Executions |
| Connector dependency impact | Process Blast Radius |
| Portfolio-level runbook summary | Integration Landscape Summary |
| Release-window deployment notes | Release Notes |
Refresh And Data Notes
Section titled “Refresh And Data Notes”Macros use the configured space cache and can request fresh data when the macro includes a Refresh action. Empty macro states can mean the selected resource has no matching data, the relevant dataset is disabled, the relevant facts are not cached yet, or the Boomi identity lacks that feature area’s access. Unknown is not the same as zero; read the displayed freshness and warning state before interpreting an empty table.