Skip to content
Flowdence Flowdence Docs

Build a Boomi Operations Runbook

Use this tutorial when a team wants one Confluence page that explains a Boomi integration and its operational posture.

Outcome

Section titled “Outcome”

The page gives readers enough Boomi context to inspect process health, deployment state, runtime/API dependencies, connector blast radius, and release-window changes without leaving the runbook for every question.

Where To Open

Section titled “Where To Open”

Open or create the Confluence runbook page, then insert BoomiSight macros from the editor.

Guided Flow

Section titled “Guided Flow”
  1. Add an Integration Landscape Summary near the top of the page for portfolio-level context.

Boomi architecture page with BoomiSight context

  1. Confirm the summary macro renders current space metrics before readers use the page for release review.

Integration Landscape Summary macro

  1. Add a Process Snapshot for the primary process.
  2. Configure the Process Snapshot from the editor. Prefer resource search and picker selection when the cache is current; use manual fallback only when the resource is known and search is unavailable.

Detailed Process Snapshot macro

  1. When the runbook needs verified Process Property and XREF relationships, enable Include configuration dependencies on the detailed Process Snapshot. The resulting section describes the selected process’s current Boomi Build graph, not an environment-specific deployed version.

Process Snapshot configuration dependency option

Use Custom Process Properties and XREF separately when the author needs to document selected structural components without claiming that a process uses them.

Custom Process Properties and XREF structure

  1. Add Atom Health for the runtime that matters to the runbook.

Atom Health macros

  1. Add Environment Summary when the page needs environment classification or attached runtime context.

Environment Summary macros

  1. Add API Snapshot when the integration exposes a Boomi API service.

API Snapshot macros

  1. Add Process Deployment History to show release and deployment chronology.
  2. Add Process Executions when recent process runs matter to support or incident response.

Process Deployment History and Process Executions macros

  1. Add Process Blast Radius before documenting a risky connector or credential change.

Process Blast Radius macro

  1. Add Release Notes for the relevant UTC date window when the runbook supports a release review.

Release Notes macro

Success Checklist

Section titled “Success Checklist”
  • Each macro has a clear reader-facing purpose.
  • The page uses detailed macros for primary evidence and compact/inline macros for dense status signals.
  • Every configured macro points to the intended Boomi resource or date window.
  • Current-Build Process Property/XREF relationships are shown only when the author deliberately enables them on a detailed Process Snapshot.
  • Author-selected Process Property/XREF components are not described as process relationships unless the Process Snapshot verifies that association.
  • Empty states are explained as data state, permission state, or an intentional filter.
  • The page avoids exposing Boomi API tokens, raw property values, XREF row values, internal identifiers, or admin-only credentials.

Video

Section titled “Video”

This walkthrough is a live Confluence browser recording of the runbook page. Deployment account columns are visually redacted for public documentation.

Download video: Runbook macro walkthrough