Confluence Output

The Confluence format publishes aprity-generated documentation directly to your Atlassian Confluence workspace. Pages are created with proper formatting, hierarchy, and metadata, making your Salesforce documentation available alongside your team's existing Confluence content. It is available on Enterprise plans only.

Prerequisites

Before using the Confluence output format, you must:

1. Have an active Confluence connector -- configure the OAuth 2.0 connection in the Connectors tab. See Connectors Overview for setup instructions.
2. Have Confluence Cloud -- the connector supports Atlassian Confluence Cloud. On-premise Confluence Server is not supported.
3. Have appropriate permissions -- the authorized Confluence user must have Create and Edit permissions in the target space.

warning

If the Confluence connector is not configured or the OAuth token has expired, the Confluence format tile in the Generate tab displays a warning. The scan will run but skip the Confluence publishing step.

How Publishing Works

When you select the Confluence output format and run a scan:

1. Generate -- aprity produces documentation in Confluence-compatible format.
2. Connect -- aprity authenticates with your Confluence workspace using the stored OAuth token.
3. Publish -- pages are created or updated in the configured Confluence space.

Page Hierarchy

aprity creates a structured page tree in Confluence:

aprity Documentation (parent page)
  Account
  Contact
  Opportunity
  Custom_Object__c
  ...
  Process Index
  Rule Index

The parent page acts as the root of all aprity-generated content. Each Salesforce object gets its own child page.

Page Content

Each Confluence page contains the same content as other aprity output formats, rendered with Confluence-native formatting:

• Headings and sections -- using Confluence heading styles.
• Tables -- formatted with Confluence table macros for field definitions, dependency lists, and rule summaries.
• Expandable blocks -- evidence sections use Confluence expand macros for collapsible content.
• Status badges -- rule types are displayed using Confluence status macros with color coding.

info

The Confluence output uses native Confluence formatting elements. Pages look and behave like any other Confluence page -- they support comments, inline editing, labels, and all standard Confluence features.

Update Behavior

First Scan

On the first scan with Confluence output enabled, aprity creates the parent page and all child pages in the target space.

Subsequent Scans

On subsequent scans, aprity updates existing pages in place. Pages are matched by a stable identifier stored in page properties. This means:

• Existing pages are updated with the latest documentation content.
• New objects produce new child pages.
• Page hierarchy is preserved.

caution

Manual edits to aprity-generated Confluence pages are overwritten on the next scan. If you need to add custom content, create separate pages linked from the aprity pages rather than editing them directly.

Deleted Objects

If a Salesforce object is removed from your org, the corresponding Confluence page is not automatically deleted. Remove it manually through the Confluence interface.

Configuring the Target Space

During connector setup, you specify the target Confluence space where aprity publishes documentation. To change the target space:

1. Navigate to the Connectors tab.
2. Click the settings icon on the Confluence connector card.
3. Select a different space from the dropdown.
4. Save the configuration.

Troubleshooting

Issue	Cause	Resolution
Publishing skipped	OAuth token expired	Re-authorize the Confluence connector in the Connectors tab.
Pages not visible	Insufficient permissions	Verify the authorized user has Create and Edit permissions in the target space.
Formatting issues	Confluence macros disabled	Ensure expand and status macros are enabled in your Confluence space settings.

Plan Availability

Plan	Confluence Available
Trial	No
Starter	No
Professional	No
Enterprise	Yes

When to Use Confluence

• Your team uses Confluence as its primary documentation platform.
• You want Salesforce documentation co-located with architecture, design, and process documentation.
• You need collaborative features like comments, inline edits, and labels on documentation pages.
• You want documentation accessible to team members who do not have Salesforce access.