All Collections
Confluence Integration
Confluence Integration

Embed a SqlDBM project, subject area, diagram, or report in a Confluence page

Written by Serge Gershkovich
Updated over a week ago

With the Confluence integration, SqlDBM diagrams and reports can be embedded in a Confluence page and shared with the entire organization in read-only mode.

Quick demonstration:

Note, that this feature is only available in Standard Enterprise license. The integration is available for cloud-hosted plans.

Also note, this configuration must be performed by a user with Account Admin privileges in SqlDBM. See the document on Roles for instructions on how to assign Admin privileges.

Add the SqlDBM app from Confluence

Log in to your Confluence home with a user who is able to install Marketplace Apps and access the search function in the "Apps" menu.

Search for SqlDBM

Add the app to your Confluence account

Embed SqlDBM diagrams and reports to Confluence pages

Once SqlDBM has been added from the Confluence marketplace, you can start to embed projects, subject areas, diagrams, and reports from SqlDBM.

To work with Reports in the Confluence integration, users must also have a SqlDBM Data Governance license in addition to their Standard Enterprise license.

To begin: Enter the edit mode on any Confluence page.

To embed your work from SqlDBM, type forward-slash ("/") followed by "SqlDBM" to bring up the app element. Alternatively, add it from the "Insert" (+ icon) at the top of the page.

- or -

Now follow the rest of the steps in the video below to complete the integration depending on whether you would like to embed diagrams or reports.



SqlDBM Properties in Confluence

Below are the available properties that can be customized when embedding SqlDBM content:

  • Project

    • Select the project that you wish to embed from.

  • Display

    • Select the "Relationship diagram" or "Report page" from the project to embed.

  • Revision

    • SqlDBM projects embedded in Confluence can be configured to dynamically display the latest version or a static, historical state.

    • Choose "Last Revision" to always display the latest version of the project.

    • Or, choose a historical revision to fix a static version of a project as at that point in time.

  • Subject Areas

    • Choose a specific subject area or "Include all".

  • Diagrams

    • Choose a specific diagram or "Include all".

  • Macros Height

    • Select the height, in pixels of the embedded frame.

Once all options are configured as you would like, Save and Publish the Confluence page to complete the process.

Managing SqlDBM Content in Confluence

The SqlDBM embed can be managed by users with editor rights in Confluence and a SqlDBM modeler license.

  • In editing view, simply select the pencil icon to return to the SqlDBM Properties panel to alter the selected diagram.

  • Editors can adjust the width of the embedded SqlDBM content.

  • Use the delete button in this interface to remove diagrams as needed.

Interacting with Diagrams in Confluence

Confluence users can:

  • Interact with diagrams through simple navigation the cursor across the tables and relationship lines.

    • Zoom in and out by scrolling.

    • Click and drag to move position in the diagram.

  • If a Subject Area or an Entire Project is embedded, users can toggle between the available schemas and diagrams, as seen below:

Interacting with Reports in Confluence

Confluence users gain full access to the metadata captured in SqlDBM Reports, including the ability to:

  • Use the search bar to find columns, descriptions, Governance fields, and field values.

  • Navigate between objects using the left panel, organizing schemas, tables, flags, fields, etc.

  • Read object details, including descriptions and related comments from within the SqlDBM project.


Did this answer your question?