Signed Embed

Integrate Notebooks into your application.

Signed Embed allows you to directly embed Codatum Notebooks into your own applications while utilizing your existing authentication system. This integration enables your application users to access Codatum Notebooks and Dashboards without leaving your application environment.

This feature may be referred to as "White Label Embedding" or "Embedded Analytics" on other platforms.

Key Features

  • Secure Embedding in Existing Applications:

    • Secure access control using authentication tokens

    • User authentication leveraging your existing system without requiring Codatum accounts

  • Multi-tenant Data Access:

    • Restrict each customer's data access to their own data subset by configuring server-side fixed parameter values for different clients

    • Create a single notebook that serves multiple client organizations with appropriate data isolation

  • Interactive Experience:

    • Enable parameter adjustments for personalized analysis

    • In-depth exploration with Explorer functionality

    • Data download capabilities

  • Flexible Integration:

    • Exchange messages between your application and embedded Notebooks

Configurable Options

  • Publish Settings

    • Page Selection:

      • Select specific pages to include in the embedded view

    • Access Control:

      • Enable/disable data download

      • Enable/disable data explorer functionality

  • Signed Embed Settings (Configure settings)

    • API keys:

      • Specify permitted API keys for authentication

    • Externalized parameters:

      • Server-side fixed value: Cannot be modified by client

      • Server-side default value: Initial value is set server-side, but can be modified by client

      • (Not specified in externalized parameters: Uses the default value embedded in the notebook, can be modified by client)

    • Allowed origins:

      • Restrict domains permitted to embed the notebook

  • Display Options for iframe Embedding

    • Some display options are available including theme selection and SQL visibility settings. Please refer to the setup guide for details.

By combining these settings, you can finely control the security, functionality, and appearance of embedded Notebooks.

Multi-tenant Implementation Tip

Multi-tenant data access allows a single notebook to serve multiple customers while ensuring each customer only sees their own data.

Using "Server-side fixed value" parameters, you can create data segregation by filtering data or switching tables/schemas based on client identifiers.

Next Step

For setup instructions, please refer to the next page.

How to Set Up Signed Embed

Last updated

Was this helpful?