Scroll

CData Drivers

As of v2018.2, additional database connection types are available using ADO.NET drivers provided by CData Software Inc., in partnership with Exago Inc., to connect to database types not natively included in the application.

Exago BI now officially supports MongoDB and Elasticsearch databases out-of-box, via paid CData driver support.

Note: The Exago BI web server must have full permissions for the Drivers folder in the Web Application installation directory.

CData drivers are initially available for a 30 day trial period. Using a CData driver in production requires a paid license. Once a successful connection is made to a data source using a CData driver, a 30 day trial will begin. At the end of the 30 days, a license will have to be obtained to continue using the driver.

To obtain a license key for a CData driver, please submit a support request.

Licensing and support

CData licenses for Exago BI are purchased from Exago Inc. (not from CData Software Inc.). Please submit a support request to purchase a license key for a CData driver.

Note: The required license is an internally generated license specific to Exago, and is not interchangeable with a CData license.

Exago Inc. may refuse support for CData drivers that are not included with the Exago BI installation and not licensed through Exago Inc. If such support is requested, Exago may require a purchase of service hours.

License model

CData driver licenses are not included with the base Exago BI license, and are purchased separately or as add-ons to the Exago license agreement.

Purchasing a CData driver license grants you one provider per product per year. More specifically:

One (1) CData driver license applies to the following:

  • One CData driver provider (e.g. "MongoDB ADO.NET Provider")
  • One product in which Exago BI is embedded (products are defined as per your individual Exago license agreement)
  • One or more Exago instances comprising the product (an instance is an installation of the Web Application or Scheduler Application)
  • One or more data sources (databases) of the provider type and pertaining to the product
  • One calendar year of usage, renewed annually

This information may differ according to the terms of your individual license agreement. Please make sure to verify your specific terms with your business department.

Configuration file

When using a CData driver, the application will refer to a file in your installation directory under 'Config/Other' named cdataconfig.json. The application will look to this file for information about the CData driver that is being added and how it will behave in the application.

Initially, the license key value for built-in CData sources is ‘TRIAL’, and they will be available as data source types in the Admin Console when creating a new connection.

cdataconfig.json

{
 "mongodb":
 {
    "FriendlyName":"MongoDB",
    "License":"TRIAL",
    "DateFormat":"YYYY-MM-DD HH:mm:ss",
    "Delimiter":"[]",
    "TopRowLimitSQL":"",
    "BottomRowLimitSQL":" LIMIT {0}",
    "dbInfo":{
            "Provider":"System.Data.CData.MongoDB",
            "TableSchema":"Collection:\"Tables\",
Restrictions:[null, \"@database@\"],
NameColumn:\"TABLE_NAME\",
SchemaColumn:null",
            "ViewSchema":"Collection:\"Views\",
Restrictions:[null, \"@database@\"],
NameColumn:\"TABLE_NAME\",
SchemaColumn:null",
            "ProcedureSchema":"Collection:\"Procedures\",
Restrictions:[null, \"@database@\"],
NameColumn:\"ROUTINE_NAME\",
SchemaColumn:null"
    }
 }
}

This configuration file is composed of JSON objects that contain specific information for how the data type will appear and behave in the application. These objects are explained in more detail in the table below.

Attribute name

Description

Name

The outer label for the JSON object is the simplified name for the driver being added.

FriendlyName

The name of the data source type that will appear in the Admin Console

License

The license value to use the driver. By default this value will be 'TRIAL'.

DateFormat

The specified Date format of dates returned by the data source.

Delimiter

Characters used to surround table names when passing SQL.

TopRowLimitSQL

Top row limiting syntax. For limiting the rows returned when using a Top filter.

BottomRowLimitSQL

(Optional)

Bottom row limiting syntax. For limiting the rows returned when using a Bottom filter.

dbInfo

This is another JSON Object with properties that define schema for the data source. These are equivalent to the corresponding fields in the Admin Console Database Settings.

Provider

This is the name of the library that is obtained from CData for the database driver. This will always have the format of ‘System.Data.CData.<name>’, where <name> is the proper name of the source type (i.e. MongoDB).

TableSchema

Table schema retrieval properties.

ViewSchema

View schema retrieval properties.

ProcedureSchema

Procedure schema retrieval properties.

Adding additional data source types

A list of additional data sources supported by CData can be found on the CData website. Not all sources listed are supported by Exago BI. If you are interested in using a CData driver that is not provided with the Exago installation, please submit a Support request or contact your Customer Success manager.

When adding an additional CData driver, the driver must be placed in the Drivers folder in the web application installation directory.

When setting up an additional data source, create a new configuration in the cdataconfig.json configuration file.

When a full license key is obtained, the value must be placed in the License key value pair in the object within cdataconfig.json (see below). The server hosting the application will not have to be restarted. The next time the application is accessed, the connection will be available with the new license.


Hidden Article Information

Article Author
Matthew Cherny
created 2018-08-13 14:59:55 UTC
updated 2019-03-02 20:47:21 UTC

Labels
no labels yet!
Have more questions? Submit a request