Confluence Data Model Documenter

Confluence Data Model Documenter

  1. Setup
  2. How To Use

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, must be deleted.

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

    1. Application Description

      1. This will be the description shown on the “Data Models” page

    2. Space ID

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

    3. Confluence Connection

      1. A connection needs to be setup 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.

    • Related Articles

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

      The following issues are limitations of the Confluence V2 API 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 ...

    • How to Export Data From Fuuz

      In this how to video, we explain how to use the built in features of the Fuuz platform "Export Data" to create sophisticated data exports, in CSV or JSON. Data exports can be single model, or nested model data exports, which makes it extremely simple ...

    • Processing Model

      The JSONata processing model The JSONata type system JSONata is a superset of JSON and the JSONata type system is a superset of the JSON data types. In common with all functional programming languages, the function is also a first-class data type. ...

    • How to Create APIs Using Data Flows in Fuuz

      How to Create APIs Using Data Flows in Fuuz Estimated Time: 5–7 minutes Skill Level: Intermediate Overview This guide explains how to create RESTful APIs using Data Flows in Fuuz. Unlike the GraphQL-based method covered in a previous tutorial, this ...

    • How to Import Data to Fuuz

      In this video we cover the method used to import mass amounts of data into Fuuz. Generally this will be best practice when you're initially setting up your application for the first time, doing your mass data migration using this tool is the ...