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, or API Snapshot, then choose the Development macro 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.
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.
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 |
| 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, or the Boomi identity lacks that feature area’s access.