This documentation corresponds to a historical version of Yellowfin

Icon

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

Skip to end of metadata
Go to start of metadata

Data Source Details

The detail section contains metadata that assists users select the right source and view for their reports.

  1. Type in the Business name and description for the source – this is displayed to an end user when writing reports to assist them to make the correct decision about the source of the data they wish to report off.
  2. Using the max row limit you can constrain the maximum size of a query against the source – you may choose unlimited as depicted.
  3. Allowing the database to be Writable will enable you to use this source to store either view caching data or imported csv data.
  4. If you have set the source to writable you will have the option to make the source the default storage for csv imports.
  5. Define the time zone region for the source – this is used for managing scheduling and broadcasting if your users are located in a different time zone from the source system.

Security Setting

The security settings allow you to determine whether access to the connection needs to be restricted, whether to apply source filters and whether broadcasts are permitted.

  1. Select Unsecure or Secure. If you select secure an additional step will be added to your connection wizard.
  2. Permissions against the source allow you to determine what actions are permitted. You may choose to stop users from creating broadcast reports or subscribing to reports that are initiated from the source.
  3. Source Filters are used to create Privatised filters for users based on data within the source.

See Source Security and Source Access Filters for more information.

Connection Parameters

The connection to the source system must be specified. The connection parameters define how Yellowfin accesses a database.

  1. Select you connection method. Generally this will be JDBC.
    Note: Some data sources such as Access and Lotus Notes will require an ODBC connection. Please refer to specific Connection documentation for non-standard SQL data sources.
  2. Select a Database from the list. You can either select the database you are using or choose a ‘Generic JDBC/ODBC Data Source’ from the list. Yellowfin recommends that you choose the database you are using from the list unless you need to add extra parameters to the end of the connection string. The generic options allows for this.
  3. If you have chosen the non-generic option, fill in the Host, Port, Database Name, Username, Password, and any other options required, then proceed to the Connection Management section below. Otherwise, continue with these steps:
  4. Select a driver appropriate for your database type.
    Note: If the appropriate driver, for your data source, is not in the list then you will have to:
    1. Copy the JDBC driver into the yellowfin\appserver\webapps\root\web-inf\lib directory
    2. Restart Yellowfin
    3. If the DB Name is not in Yellowfin's list you will need to edit the web.xml file found in: yellowfin\appserver\webapps\root\web-inf
    4. Locate <param-name>JDBCDrivers</param-name> in the file, and add your driver to the list, for example:
    5. Save your changes and restart Yellowfin.
    6. You should now be able to locate your driver using the Generic JDBC Data Source option
  5. Define the Database URL: The connection string is of the format:
    jdbc:<db driver string>://<host>:<port>/<database>
    where the <db driver string> is the specified driver string for the db, <host> is hostname or IP address, <port> is the TCP/IP port that the database listens on and <database> is the database you are attempting to connect to.
  6. Insert the username and password for the Yellowfin to connect to and access the database. Your password will be encrypted when stored in the Yellowfin repository.
  7. Select your Schema – the scheme is used internally to partition tables within the database. Select the appropriate schema for the Yellowfin user.
  8. To test the connection, click the ‘test connection link’. If successful a connection succeeded message will be displayed. You should also see a list of tables found using the selected database schema.

In Memory (Columnar) DB Connection Parameters

Connection settings for the in-memory database don’t have variables so you only need to select ‘Columnar DB’ from the database list.

  1. You will not be required to set a username or password for this connection, so just leave the fields blank.
  2. To test the connection, click the ‘test connection link’. There will be a popup message informing you that no username was set, click OK. If successful a connection succeeded message will be displayed.
  3. The source is now ready for use to cache views to.

For more information on the In Memory DB and whether it's right for your situation, see this Yellowfin Forum post: http://www.yellowfinbi.com/YFForum-How-does-the-In-Memory-DB-work-and-will-it-make-my-reports-run-faster-?thread=108180

Database Specific URL Formats

Each database platform has its own specific connection string parameters. The table below provides you with a guideline for completing the database URL. The port numbers provided are the default port numbers for the specified database. You will need to confirm the port details for the database that you are connecting to.

Name

URLFormat

DB2 UDB

jdbc:db2://<host>:<port446>/<database>

HSQLDB server

jdbc:hsqldb:hsql://<host>:<port9001>/<database>

HSQLDB embedded

jdbc:hsqldb:<database>

IBM AS/400

jdbc:as400://<host>naming=sql;errors=full

Informix

jdbc:informix-sqli://<host>:<port1533>/<database>:informixserver=<dbservername>

JDataStore

jdbc:borland:dslocal:<file>

JDBC/ODBC Bridge

jdbc:odbc:<datasource>

MySQL

jdbc:mysql://<host>:<port3306>/<database>

Oracle Thin

jdbc:oracle:thin:@<host>:<port1521>:<sid>

Oracle OCI

jdbc:oracle:oci:@<host>:<port1521>:<sid>

PostgreSQL

jdbc:postgresql://<host>:<port5432>/<database>

Progress

jdbc:jdbcProgress:T:<host>:<port2055>:<database>

SQL Server (jTDS)

jdbc:jtds:sqlserver://<host>:<port1433>;DatabaseName=<database>

Sybase ASE (JConnect)

jdbc:sybase:Tds:<host>:<port2048>/<database>

Sybase ASA (JConnect)

jdbc:sybase:Tds:<host>:<port2638>/<database>

Yellowfin In-Memory

jdbc:columnar://localhost

ODBC Connections - JDBC-ODBC Bridging

If you intend to connect Yellowfin to a database which does not have a native JDBC driver (e.g. Lotus Notes and MS Access) then you will need to use a JDBC-ODBC connector. You will still select connection method and JDBC but the driver you select will have to be a bridge to the ODBC source.

Included with the standard Java Runtime environment is the Sun JDBC-ODBC driver. This driver allows a JDBC connection to an existing ODBC source. In all cases it is more reliable to connect to a database via a native JDBC driver. In the case that a JDBC driver doesn’t exist for the source database, this may be a viable alternative.

On the database source page, by default, the Sun JDBC-ODBC driver will be available in the driver drop down. It is listed as sun.jdbc.odbc.jdbcodbcDriver.

The syntax for this driver is:
jdbc:odbc:<data-source-name>[ ;<attribute>=<value>]
where data-source-name is a registered ODBC data-source, followed by any data-source specific attributes.

For more information about the Sun JDBC-ODBC driver please visit: http://java.sun.com/j2se/1.5.0/docs/guide/jdbc/getstart/bridge.doc.html

Note: You can also consider using 3rd party JDBC-ODBC bridges that have been optimised for the database you wish to connect to. Please see the installation manual for more details.

Connection Management

The connection management section provides the mechanism for optimising the connections to the data source.

  1. Complete the Minimum and Maximum connections. These determine the number of connection within the connection pool.
    For example if you have a maximum of 5 connections and 5 users create very large reports at the same time no other user will be able to access the source until these reports have completed processing.
    Yellowfin automatically creates and keeps the minimum connects open and will use up-to the maximum if required. Setting the connections permits you to optimise system resources.
  2. Refresh Time is hours before the database connections are refreshed.
    The refresh recycles the connections after the set period. This is done to ensure that no connections have become stale / or been left open even though the user is no longer using them.
  3. The timeout is the time that is allowed for the SQL statement to return results. If queries against this source are likely to be large this field will have to be set to accommodate them.

Connection Availability

To disconnect from a source database you can make a connection unavailable. This is useful if the DBA of the source database requires all connections to that database to be closed. Select unavailable from the connection management options.

Note: Whilst the connection is closed users will not be able to edit or add views or run any reports from the source.

OLAP Source Connection

An OLAP source connection differs from a standard JDBC connection.
Select XMLA OLAP as the connection type. Refer to OLAP connection documentation for details for each OLAP source type.

Database Connection Issues

Some databases require specific configurations for JDBC connections to be successful. These issues and the resolution of them are outside the context of this guide. Please refer to the forum (http://www.yellowfinbi.com/YFForum.i4) for information on your specific database, for example: Access, Progress and Lotus Notes.