Page tree

This documentation corresponds to a historical version of Yellowfin

Access the latest release, or view a list of available versions of the documentation.

Skip to end of metadata
Go to start of metadata

Overview

 Yellowfin now has an open connector framework, which enables users to connect to third-party web applications. Some connectors are available through the Yellowfin Marketplace, while others can be developed by third-parties.

 

Connector Information

Connectors come in the form of a .jar or .yfp package, which contains all the files required to create and use the connector. Connectors can be packaged on their own, or with pre-built sample content. Sample content may include Views, Reports, and Dashboards.

 

Loading Connectors

1. To begin, you will need to navigate to the Plugin Management page in the Admin Console. You can do this by;

a. Navigating directly to the Plugin Management page through the Left Side Navigation panel, or

b. Navigating to the Admin Console and then selecting the Plugin Management page from the Admin list on the right.

 

Left Side NavigationToolbar

You will now be on the Plugin Management page.

2. From here, you will need to click the Add button in order to start loading a new connector.

3. Drag & drop your connector onto the New Plugin window, or click on the icon to open browse in order to locate it.

4. Your connector will now be processed - the time this takes will vary depending on the size of the connector pack.

5. You now need to complete the connector by providing a name and description. This will help users understand what the plugin should be used for.

6. Click Submit to load your connector.

You will now see your new connector in the plugins list.

See Plugin Management for more information on different types of plugins.

 

Using Connectors

In order to use your new connector you will need to create a new data source in Yellowfin. Each connector has it's own requirements for use, so click on the connector you wish to use to find out what it requires.

Some generic instructions can be found below.

1. Create a new Data Source by using one of these methods:

 

    • Left Side Nav - open the left side navigation panel, click on Create, select the Data Source option

 

    • Top Right Button - click on the create button, select the Data Source option.

 

    • Toolbar - click on the Create link in the toolbar, select the Data Source option.

    • Admin Console - navigate to the Admin Console, open the Data Sources section, click on the Add button.


You will now see the New Connection lightbox.

Left Side NavigationTop Right (with Left Side Nav enabled)
ToolbarAdmin Console

2. Select the connector you wish to use to set up your data source.

3. Fill in the details required by the connector. In this example, you will need to complete the Name and Description.

This should describe the specific connection, rather than the connector, as you can use the connector multiple times.

 

4. Complete the Connection Instructions. Each connector will have different requirements that will need to be completed in order to successfully access your data. In this example you will need to Authorise Google Analytics. 

5. Once you have followed the connection instructions you will be able to complete the connection. From here you have a range of options available to you:

 

    • Advanced Connection Editor - this will take you to the Data Source page in the Admin Console and allow you to edit all the advanced options available for your data source.

    • Test Connection - this will allow Yellowfin to test the connection parameters you provided to ensure it can connect to your data source.

    • Create View - this will allow you to create a View based on the connection.

    • Launch Pre-Built Content (optional) - this will allow you to install any pre-built content that may come with the connector.

    • Save & Close - this will allow you to save your connection and close the New Connection lightbox, returning you to the page you were on previously.

    • Cancel - this closes the New Connection lightbox without saving your connection, returning you to the page you were on previously.

 

Your connection is now complete.

 

  • No labels