Document your Application using Atlassian Confluence and our Pre Built App

Document your Application using Atlassian Confluence and our Pre-Built App

Article Type: How-To Audience: Developers, App Admins Module: How To

Fuuz includes a pre-built package that automatically generates Confluence documentation pages for your data models. This article covers setup and usage, along with some known limitations of the Confluence V2 API.

Important: The following are limitations of the Confluence V2 API:

• All pages must have a unique name. Because of this, all Data Model pages are prefixed with Data Model:. If there is an existing page with the same name as one you are generating, it will be replaced.
• Auto-generated pages cannot be archived — they must be deleted.
• The Confluence V2 API currently doesn't allow you to re-activate a page once it has been archived. This leads to issues when trying to generate new documentation for an archived Data Model page.

Setup

1. Install the Fuuz package "Confluence Data Model Documentation" from the Fuuz Packages screen.
2. Open Application Configuration, search for "Confluence Documentation Integration", and click the name hyperlink.
3. In the form, fill out the following fields:
   • Application Description — the description shown on the Data Models page.
   • Space ID — the ID of the space you are targeting. This is an integer that you can find in the URL when navigating through the Confluence space.
   • Confluence Connection — a connection needs to be set up that can authenticate with Confluence and read/write to the space.

How To Use

1. Open the Confluence Data Model Documenter.
2. Select one or more data models.
3. Press the sync icon.

If successful, you will see a green notification appear at the bottom right. If unsuccessful, you will receive a red notification at the bottom right.

See Also

• Confluence-Data-Model-Documenter
• Dynamic-Field-Configurations
• The-Power-of-Data-Flows-Unlocking-Industrial-Intelligence-with-Fuuz

---

Source: support.fuuz.com