Like what you see? Have a play with our trial version.

This section provides information on how to embed various elements of Yellowfin into a web-based application or portal.


Available Integration Methods

 Yellowfin provides a range of different integration capabilities that broadly fall into the following two categories:

Content Integration

Individual items of content (reports, dashboards) can be embedded into the host application or web page. This can be done using the JavaScript API or using an iFrame. Using the JavaScript API allows for fine-grained control over the content and its interactions. Using iFrames provides a more out-of-the-box experience with less development effort but offers less ability to customize.

Application Integration

Previously we referred to this as Tight Integration. This basically involves integrating the whole Yellowfin application (this can be done as a full window or within an iFrame). Various custom elements can be included (such as a header containing a menu) that allow for seamless navigation to and from the host application. Various capabilities can be turned on or off to further customize and achieve the desired experience. Application integration is often the simplest method, can expose more of the Yellowfin application (including content creation capabilities such as report builder) and involves the least development effort.

 Yellowfin also provides a wide range of web-services that can be used to obtain content from the Yellowfin server in order to create custom user-interface objects.


Choosing a Method

 The choice of method will come down to a number of factors, including but not limited to:

  • The desired User Experience - what is the outcome you are aspiring to for your target application. For example, if you just want to bolt-on a full, modern BI experience for minimal effort - then Application Integration is likely the best option. However, if you want to seamlessly blend rich-BI content together with your own application content - then the JavaScript API is likely their best choice.
  • The functionality you want to expose - the JavaScript API for example, only allows for certain content types to be embedded - namely Dashboards and Reports (tables, charts or canvas). Other content - including self-service reporting via Data Discovery, Signals, Stories, Timeline etc - are only available through iFrame embedding or full Application Integration.
  • The available skills and time - creating a customized experience using the JavaScript API requires programming skills and typically will take slightly longer to achieve depending on the desired outcome. If time to market is more important than the look and feel, iFrames or Application Integration might be best.


All of these methods can be used together within the one application. You could have a landing page that seamlessly mixes content from the host application with rich content from Yellowfin using the JavaScript API; Signals or Stories embedded in iFrames; and a full Data Discovery self-service experience with an Application Integration - all within the one application.


Integration Capabilities

Each integration capability is described in the following sections:


Other Resources

Be sure to check out these other important resources for integrating Yellowfin:

  • No labels