Page History
This section provides information on integrating how to embed various elements of Yellowfin into an existing a web-based application or intranet. This allows for seamless user and data integration, and for the replication of user security at the report data level.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 JsAPI 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 JsAPI is likely their best choice.
- The functionality you want to expose - the JsAPI 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 JsAPI 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 JsAPI; 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:
Choosing a Method
Choosing one method over the other, depends on your company's requirements and technical abilities. Consider the following cases to help you decide on a method:
Tight Integration
- Requires Yellowfin to be loaded into an external page, with custom header and footers added with links to your application. Tight integration can be loaded via iFrames also.
- Gives you control on the information to share with your users. You can provide them with a few interactive dashboards, reports, etc. with the same level of security. Or share the full range of functionality.
- Have the flexibility to include further Yellowfin functionality in the future.
- Allows you to control the exact functionalities your users can access, depending on their role function.
- Allows users to single sign-on into Yellowfin.
- Requires some development knowledge to write header/footer JSPs to pass relevant data to your application. (Yellowfin includes some examples of these in the \Yellowfin\Development\Examples directory.)
- The header and footer would require restyling to maintain your corporate brand. Click here to learn how to do this.
- This is the most recommended and widely used integration method.
JavaScript API
- Applying this method is suitable in cases where you want to quickly embed a chart or report into your website. This is a quick way to expose users to information, along with limited interactivity.
- The basic JavaScript method is a simple way to share information for public consumption, but with the advanced option, data can be filtered.
- This requires next to no development experience or knowledge.
- Supports single sign-on.
- Access to other Yellowfin functionality (such as the view builder, report list, administration, etc.) will not be provided.
- Only recommended if there is a requirement to share a chart or report.
IFrames
- Loads Yellowfin into your website by using IFrame tags.
- Single sign-on is possible.
- This method is not as secure as the other ones.
- Issues related to browser display can also arise.
- This is merely a means of embedding; one of the other integration methods would still be required.
Web Services
- This method uses web services to perform actions in your application that are passed to Yellowfin.
- Grants you with the most flexibility on the functionality to be included for your users.
- Requires developers with advanced knowledge of writing web services API.
- Supports single sign-on.
- Not all Yellowfin tasks can be performed with this option (such as setting configuration options).
- Reports can be displayed in your application and specified to use certain accounts.
Open Source Libraries
Free Open Source Software (FOSS) Statement
Yellowfin ships with some restrictive open source libraries. Yellowfin does not link to or directly reference these libraries, and Yellowfin’s use of these libraries is in compliance with each applicable open source license. Yellowfin is designed to compile independently and without reference to these open source libraries. It is, however, technically possible for a Yellowfin partner or end user to alter the Yellowfin application – for example, by adding additional pages and/or plug-ins and/or libraries – which could directly or by combination with those libraries, violate the open-source licenses applicable to the libraries shipped with Yellowfin. There are numerous situations where such license violations could occur, including, but not limited to, incorporation of database drivers and authentication processes into the Yellowfin environment.
The Yellowfin partner, or end user, must ensure that any additions or modifications to the Yellowfin code do not enhance or extend, in any manner, the scope of use of the open source libraries shipped by Yellowfin beyond the scope of use originally utilized by Yellowfin and do not link to or directly reference those libraries.
Yellowfin disclaims all liability and responsibility for any violation of any open source license caused by additions or modifications to the Yellowfin code.
...