Successfully!

Error!

Data Connection at Platform

  • Last update:  2020-12-11
  • I. Overview

    With the data connection option, users can create a new data connection without using the designer, view which databases are connected to the current report and make adjustments accordingly. The designer can be used to create JNDI and multidimensional data connections, and the data connections created on the platform can also be managed in the designer.

    You will learn
    • User Interface

      • Access the Local Decision-making Platform

      • Manage Data Connections

    • Select Type for New Data Connections

      • Commonly Used

      • All

      • Others

    • New Data Connection

      • Pattern

      • Authentication Method

      • JDBC Data Connection

      • JNDI Data Connection

      • Other JDBC

    • Manage Data Connections

    II. Instructions

    1. User Interface

     1.png

    Note:

    • Administrators need to grant permission to manage the Data Connection node under Manage first, for regular users to configure data connections

    • Only JDBC databases can use Connection Pool.

    Take the local decision-making platform in the designer as an example.

    1) Open the platform in Help -> Demo

    2.png     

    2) Click Manage -> Data Connection and go to the configuration panel

     3.gif


    2. Select Type for New Data Connections

    Click on the New Data Connection button and choose from 3 types, which are Commonly Used, All, and Others as shown below:

     4.gif

    1) Commonly Used: some commonly used database types will be displayed here, namely Hsql, IBM DB2, Microsoft SQL Server, MySQL and Oracle, as shown below:

     5.png

    2) All: all the database types that FineReport designer supports include ADS, Amazon Redshift, Apache Impala, Apache KYLIN, Apache Phoenix, DERBY, GBase 8A, GBase 8S, GBase 8T, H2, Huawei Cloud DWS, Fusioninsight elk, Fusioninsight HD, GaussDB 200, Hadoop Hive, HBase, HP Vertica, HSQL, IBM DB2, INFORMIX, KINGBASE, Microsoft SQL Server, MySQL, Oracle, Pivotal Greenplum Database, Postgresql, Presto, SAP HANA, SAP Sybase, SPARK, Sqlite, TeraData and TRANSWARP INCEPTOR:

     6.png

    Note:

    • You can filter the database types by checking Built-in Support and Plugin Support, and no result will be displayed if none of them are checked. Both options will be checked by default.

    • Once switched to another database type on the left, Built-in Support and Plugin Support will go back to default.

    • In Built-in Support, there are the data sources supported by the designer itself, and Plugin Support shows those need to install plugins.

    3) Others include JNDI Data Connections and Other JDBC, as shown below:

     7.png


    3. New Data Connection

    To set up new data connections, please follow the screenshot below:

    8.png 

    Note:

    • JDBC, JNDI Data Connection and adapted third-party data source plugins are all included in New Data Connection.

    • For those data connections which are not adapted, the platform can only get data source names, but not support creating, editing or viewing specific settings. To create, edit and view those settings, please use the designer.

    There might be some different information required for different databases when establishing new data connections. Below we will be introducing detailed information on Pattern and Authentication Method.

      • Pattern: there will be an extra setting for Pattern when establishing connections with Amazon Redshift, Apache KYLIN, Apache Phoenix, DEBRY, HP Vertica, IBM DB2, INFORMIX, Microsoft SQL Server, Oracle, Pivotal Greenplum Database, Postgresql, GBase 8S, GBase 8T, KINGBASE, Presto, SAP HANA, SAP Sybase and Hbase.

    Note:

    • The purpose of using Pattern here is to make it easier for other functions to access the data within a database, and you can just leave it in default value.

    • If the pattern selection process is not completed by databases, then the first pattern will be applied by default.

    • If a database doesn't require to choose a pattern, then you don't need to do this.

    • The default pattern is not editable until successfully connected to the database.

    • Pattern name should be added as a prefix when connecting databases with multiple patterns using SQL query.

      • Authentication Method: this option will only be available when establishing connections with APACHE IMPALA, Hadoop Hive, SPARK, TRANSWARP INCEPTOR, APACHE Phoenix and Hbase. Take Hadoop Hive as an example:

     9.png

    Note:

    • Clicking on the Authentication Method dropbox will open a list of options if the database supports multiple methods.

    • For the Kerberos method, the registered kdc client principal and keytab key path are required.

    1) JDBC data connection

    Take Oracle as an example. Click on New Data Connection and choose Oracle in Commonly Used, just as shown below:

     10.gif

      • Data Connection Name: must be unique and nonempty.

      • Data Connection URL: automatically generated and can be manually edited.

      • Advanced Setting: collapsed by default, click on it to expand.

     11.png

    2) JNDI data connection

    Click on New Data Connection and choose JNDI Data Connection in Others.

     12.gif

    3) Other JDBC

    If the required database type is not listed, please choose Other JDBC.

    Put the needed driver jar under %FR_HOME%\webapps\webroot\WEB-INF\lib, and restart the server.

    Click on New Data Connection, choose Other JDBC in Others, and manually input complete information on the data connection, such as driver name and URL. Click Test Connection, and once it's successfully connected, click Save.

     13.gif

     14.png

      • Data Connection information: Name, Driver, URL, Encoding (Auto is recommended. This option is supported on jar versions released on and after 27th Dec, 2018), Username and Password.

      • Test connection: test whether the database configuration is correct. If it's all good then a Connection Successful message will show, otherwise it will give detailed reasons for failure.


    4. Managing data connections

    Login the Decision-making System, go to Manage -> Data Connection -> Data Connection Management and click on the icon right after the database name:

     15.png

      • Test Connection: test whether the database configuration is correct.

      • Edit: edit configurations.

      • Clicking on an existing data connection will open the profile page, and users can directly make adjustments here.

      • Rename: rename the data connection.

      • Copy: copy the data connection and append "1" to the current name.

      • Delete: delete the database.

      • Data Connection Information: show the type and creator of the database.

    Note:

    • 17.png will not be displayed with database types that are not adapted.

    • For those data connections that are not adapted, such as specific third-party data source plugins, the platform can get the name of that data source, but not support creating, editing or viewing its specific settings. To create, edit and view those settings, please use the designer. JSON Dataset is one of the options, as shown below:

     16.png

     

     


    Attachment List


    Theme: Decision-making Platform
    Already the First
    Already the Last
    • Helpful
    • Not helpful
    • Only read

    Doc Feedback