What you should know before embedding
Embedding supports app-in-app capability and allows integration of Tellius components (Search, Vizpads, Insights) into another application.
Benefits of embedding
Enables white labeling
Facilitates unlimited customization as per unique requirements
Promotes reusability and adoption
Native apps can be powered by Tellius engines
Types of embedding
Tellius provides two types of embedding:
via embedding URL
via backend APIs
Embedding URL
Using the iFrame method, users can embed Tellius as part of another application. Here's how it works:
The embedding URL for different components will be available on Tellius platform.
Copy and code the URL into the required page.
Tellius interface will be retained in the embedding app.
The embedding app and Tellius communicate via postMessages. For every activity, the embedding app needs to send a request to Tellius, and Tellius will send the response.
Choose embedding URLs if you need to,
Visualize results in Tellius interface
Cut down time and effort on development
APIs
In this method, Tellius provides you with the backend APIs for different functionalities. Tellius interface is not retained, and users are free to create their own UI. APIs call for more technical expertise.
Choose APIs if you need,
To develop own UI using Tellius APIs
More customization and control over your interface
Performing actions on embedded Tellius
Once Tellius is embedded into an app, the required actions can be performed from the Tellius interface. If not (in situations where only individual components are embedded), please make use of actionTypes provided for each Tellius component that is communicated via postMessage.
Glossary
iFrame - An inline frame (iframe) is an HTML element that embeds an HTML page within another app.
postMessage() - A browser API that facilitates secure communication between Tellius and the embedding app.
utm_source - A unique identifier added to embedding URLs, generated by Tellius. It helps control permissions, access levels, and tracks the context of the embedded content (like Vizpads, Insights, or Search). It ensures that the right data, filters, and settings are applied when loading embedded components. Unlike security tokens (e.g., JWT), utm_source is a random code used for context, not for authentication.
Limitations
For now, embedding of individual components (search bar, query results panel, list views) is not available.
Troubleshooting
If you have any trouble with the embedding, go to the browser and open developer tools (or press F12).
Click on the Console tab and check for any page loading errors.
If the following error is found, then the cross-domain (CORS) setting is incorrect.
Please reach out to the Tellius support team for assistance.
Last updated
Was this helpful?