Table of Contents

What you should know before embedding

Ramya Priya Updated by Ramya Priya

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:

  1. via embedding URL
  2. 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.
  • WebSockets - A WebSocket is a bidirectional, stateful, faster (than HTTP) protocol used for client-server communication (mostly used for the Search component).

Limitations

  • SSO is not supported in iFrame.
  • For now, embedding of individual components (search bar, query results panel, list views) is not available.

Troubleshooting

  1. If you have any trouble with the embedding, go to the browser and open developer tools (or press F12).
  2. Click on the Console tab and check for any page loading errors.
  3. If the following error is found, then the cross-domain (CORS) setting is incorrect.
No 'Access-Control-Allow-Origin' header is present on the requested resource.

  1. Please reach out to the Tellius support team for assistance.

For more information, please check out the Embedding FAQs page.

Did we help you?

Contact