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

Overview

Yellowfin has an open connector framework for connecting third-party web applications. Visit the Yellowfin Marketplace to find preset connectors ready to install, or develop your own.

Connector file types

Connector file types include .jar and .yfp archives.  Connectors can be packaged on their own, or with pre-built sample content. Content could include views, reports, and dashboards, depending on the connector's purpose.

Connector location

Connectors are stored with other plugins. You can see a list of any connectors already added to your Yellowfin instance on the Plugin Management admin page within Yellowfin. From this page, you can upload new connectors, see the files associated with connectors, and delete connectors that are no longer needed.

Using data with a connector

A connector is already configured to do what it's intended to do. You simply create a new data source within Yellowfin and configure it to use the connector. The connector itself needs no configuration.


Adding a connector

Start by downloading a connector from the Yellowfin Marketplace or elsewhere, then follow the steps below to get started.

Some connectors require a number of security steps to ensure data exchange remains secure. In these special cases, the Yellowfin Marketplace will include an additional link to download a printable PDF with detailed instructions to ensure you have as much information as possible.

General steps

  1.  From the Yellowfin burger bun  menu in the top left corner, click on Administration, then Plugin Management
    The Plugin Management dialog box will be displayed:

    If you have already installed any other plugins or connectors, they will be listed here.
  2. Click on the Add button to display the New Plugin dialog box
  3. Supply a name and a description, which will be used to list the connector on the Plugin Management page, then upload the connector.
  4. Click on the Submit button to add the connector to your Yellowfin instance.


Creating a data source

After adding a connector, you're ready to configure your data source.

Note that each connector has its own requirements for connecting to a source, so no two dialog boxes look the same. In the example below, we've used the simple Reporting Services connector for our data source. 

Also note that the Yellowfin UI provides a variety of ways to add a new data source (see Creating a Basic Data Source Connection for details). They all perform the same function. We've used our favorite method below.

  1. In Yellowfin, click on the Create  button in the top right corner to display a menu
  2. Click on Data Source

    The New Connection dialog box will be displayed:
  3. Click on a connector listed in the 'Or choose a platform' section (we've chosen Report Services)
    A dialog box with your connector's connection fields will be displayed:
  4. Fill in the credentials required
  5. Click on the arrow to the right of the blue button to see what options are available (described below), then select the most appropriate action from the list.

New data source actions

The table below describes the different options available while you're working with a new data source.

ActionDescription
 Advanced Connection EditorSelecting this option takes you to the Advanced Connection Editor, which displays all the options available for your  connector. Here, you can to further tweak and check your connections, including usage parameters, the connection pool and more.
Test ConnectionSelecting this option sends a request to Yellowfin to test the connection parameters. A confirmation message will be displayed if successful, or an error message if there is a problem.
Create ViewSelecting this option creates a new Yellowfin view based on the data connection.
Launch Pre-Build ContentSelecting this option will trigger the installation of any pre-built content that may ship with the connector. This may save you time in creating views, reports, dashboards, tabbed dashboards or any other content.
Save & CloseSelecting this option lets you save what you've configured and complete the setup any time later on.
CancelSelecting this option closes the current connector configuration without saving any of your changes.

The steps above may differ for individual connectors. Check the  list below for customized instructions for some connectors to help you get started quickly.


Detailed instructions for popular connectors

top

  • No labels