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

    • Data Model Deployment Logs

      Open the Fuuz app. Select the Fuuz dropdown menu. Select the System option. Select the Data Modeling option. Select the Data Model Deployment Logs option. From here, it is possible to perform the following task or tasks. Search for a data model ...

    • Data

      Screen elements in the “Data” section all have built-in mechanisms to query data from Fuuz to display on the screen. These screen elements have configurable properties in the “Data” property section that allow the user to configure what Data Model is ...

    • System Model Definition Query

      The System Model Definition is helpful in training your AI Models, building queries and exposing your application ontology to visual graph tools. Navigate to the API Explorer: Remove the boilerplate query, and replace the query with the query defined ...

    • Data Flow Models

      Open the Fuuz app. Select Fuuz → System → Orchestration → Data Flow Models dropdown menu. Or type Data Flow into the Search Bar: It is possible to perform the following task or tasks. Search for a data flow model. View the Model Info of a node. ...

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