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

The Confluence Data Model Documenter automatically generates Confluence documentation pages for your Fuuz data models. This article covers setup and how to use it.

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

1. All pages must have a unique name; because of this, all Data Model pages will be prefixed with 'Data Model:'. If there is an existing page with the same name as one you are generating, it will be replaced.
2. 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 will lead 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. Navigate to "Application Configuration":
   1. Search "Confluence Documentation Integration"
   2. Click the name hyperlink
3. In the form, fill out the following fields:
   • Application Description — This will be the description shown on the "Data Models" page
   • Space ID — The ID of the space you are targeting. This will be 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. Navigate to "Confluence Data Model Documenter".
2. Select one or more data models.
3. Press the sync icon.

4. 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

• Data Management Overview
• Data Model (Schema) Design Standards
• Fuuz Standard Packages