Skip to main content

Sharing projects using iFrame

SqlDBM Support
Updated

Overview

An iFrame is an HTML element that allows you to embed external content, such as another webpage, directly within your own site or application.

 

Using iFrames in SqlDBM allows to view database diagrams and project details without leaving the platform of choice.

 

 

iFrame Features

  • Read-Only Access. The iFrame displays database diagrams without editing capabilities. Users can zoom in and out but cannot modify elements.

  • Embedding Options:

    • iFrame supports embedding for ERD diagrams, subject areas, and revisions.

    • iFrame content is accessible to any authorized user on the website where the iFrame is hosted.

  • Permissions and Access Control:

    • Only admins and modelers can generate iFrame embedding codes in SqlDBM.

    • If an admin/modeler loses permissions in SqlDBM, the embedded content remains visible to authorized users.

Setting Up iFrame

How to add an IFrame

  1. In SqlDBM,navigate to Dashboard Integrations iFrame integrations.

     

  2. Click Add an iFrame button.

     

  3. Configure iFrame settings:

    • Label. Name of the iFrame.

    • Domain. A domain represents the unique address or location of a website on the internet without the protocol (https). Domains ensure secure and controlled access to embedded content. When using SqlDBM's iFrame integration, specifying allowed domains is essential for security purposes, restricting the visibility and usage of embedded diagrams exclusively to authorized websites. At least one domain needs to be entered and need to be inserted comma-separated. Examples of domains: myorg.attlassian.net or myorg.collibra.com

    • Project. SqlDBM project from where the iFrame is going to be generated (with autocomplete search).

    • Additional content settings:

      • Revision and subject area selection from the selected project.

         

  4. Click Generate Code to create an embedding link.

  5. Copy the generated iFrame embedding code and integrate it into the target website. In some cases, like the Collibra integration, only the URL is needed, in those cases copy the content within parentheses.

 

Editing an iFrame

  • Admins and modelers can modify iFrame settings via the Edit iFrame option.

 

 

Deleting an iFrame

  1. Select the iFrame checkbox.

  2. Click Delete and confirm the action.

  3. Deleted iFrames cannot be restored—new embedding links must be generated.

 

 

Security and Authorization

Access Restrictions

  • iFrame URLs cannot be opened directly in a browser.

  • Embedded content remains accessible only within the authorized application.

  • If a subscription expires or a contract is terminated, all associated iFrames become inaccessible.

Security Measures

  • Domain validation ensures content is accessible only on allowed domains.

  • JWT token-based security prevents unauthorized access.

  • SqlDBM manages session-based authentication for admins and modelers.

iFrame Behavior

UI and Interaction

  • Diagrams maintain a light theme.

  • Users can zoom and switch between subject areas (if no subject are was selected).

  • Displays scale value, project name with link, and database type.

Error Handling

Common error messages:

  • Unauthorized Access: Token/domain validation failed.

  • Project Not Available: The project was deleted or archived.

  • License Expired: Subscription or contract termination.

  • General Error: Backend issue—contact support.

 

Integration with third-party apps

Instructions for specific integrations like Confluence and Collibra are provided here. Links to official source documentation are also available.

 

iFrame Confluence Integration 

To embed SqlDBM projects in Confluence, follow the steps and suggested guidelines below. 

Open a Confluence page in edit mode. 

Add an iFrame component to the page (click the plus icon on the menu bar and type "iframe")

 

For the best viewing experience, change the width to full width.

 

Click the edit button on the bottom of the iframe to edit the properties and provide the following parameters:

URL: the URL part of the iframe code (enclosed in double quotes, starting with "https"

 

Width: 100% for responsive screen sizing.

Height: 100% for responsive screen sizing.

 

Preview your embedded project and hit "Update" on the top Confluence menu to save your changes.
 

 

iFrame Collibra Integration

  1. Create a new iFrame with the desired Collibra domain.

  2. Copy the generated URL

     

  3. In Collibra, edit a Dashboard and select a new Embeded Widget

  4. Configure the new Widget.

  5. Paste the URL from step 2, remove the Run in sandbox option, and hit Save

Check the original Collibra documentation.

 

Other Integrations

 

 

 

 

 

Related articles