Deploying a Custom Connector

JDBC is one of the most widely supported Java APIs for connecting to a variety of relational databases. With Sisense's custom connector, you can leverage JDBC drivers to connect to additional data sources.
For a complete list of supported connectors, see Data Source Connectors.

Sisense provides a platform for you to create a connector for a non-native JDBC-supported data source.


Some data sources may not fully support all functionality used by Sisense and, therefore, some functionality may not work.

The following are three common use cases:

  • A custom connector to an ElastiCube model. This is used for CData connectors. See Connecting to Custom Connectors with JDBC Drivers


    Connecting Sisense to an ElastiCube to Google Analytics using a CData driver.

  • A custom connector to a Live model using one of the Sisense-provided dialects. This is used to connect to a live model, where the data source can work with a dialect that is similar to the Sisense-provided dialect.


    Connecting Sisense to a live Amazon Aurora PostgreSQL source that can use the Sisense-provided PostgreSQL dialect with Amazon Aurora JDBC driver.

  • A custom connector to a Live model using your own custom dialect.


    Connecting Sisense to a live MongoDB source with a custom dialect.

To create a custom connector:

  1. Click the Admin tab.

  2. From the Server & Hardware menu, click System Management.

  3. In the System Management pane, click Configuration.

  4. In the System Configuration page, scroll to the bottom and click Manage Connectors.

  5. In the left pane menu, click +JDBC Connector. The Create JDBC Connector page appears.

  6. Populate the mandatory parameters:

    • Connector ID - Enter the ID of the connector.

    • Display Name - Enter the display name that identifies the connector in the Data Designer.

    • Upload jar file - Upload the relevant JDBC driver JAR file for the location that you want to connect to (see Connecting to Custom Connectors with JDBC Drivers.) You must verify that the JAR file has been tested.

      Note: Some connectors require more than one JAR file (for example, the CDATA Rest connector). You are expected to update each JAR file and save them, but the last file to load must be the JDBC driver.

    • Class name - Enter the name of the main class from the driver, taken from the driver provider. The connector uses this name to connect to the driver.

  7. If necessary, open the Advanced Configuration drop-down and populate the optional parameters:

    • Enable custom query (default: true) - Enable or disable the use of a custom query. When enabled, the data modeler can use a custom import query for the connection.

    • Fetch relations - Allows using and adding relationships between tables in the data model.

    • Upload a connector icon - Upload the SVG file with the icon to display for this connector in the Connections list. The name of the file must be icon.svg.

    • Node color - Select a color, in Hex format only, to identify the connector in the Data Model. It is recommended to use the color schema of the data source.

    • Parameters delimiter - The delimiter that separates connection string parameters.

    • SQL query delimiter - The delimiter that separates SQL statements. It is used for custom import queries.

    • Default connection string - Used when creating the specific connection in the data model. Use parameters as instructed by the driver’s provider.

    • Connection string parameters - The connection string parameters that are added to all connections.

    • Connection properties - Additional properties for every connection created by this connector.

    • Connection set functions - Supported functions: autoCommit, readOnly, transactionIsolation.

    • Statement set functions - The JDBC function called after every connection is established.

    • Enable connector for Live - Enable this for live JDBC usage. To enable this connector for live models, you must provide a dialect file.

      • Select a dialect from a supported Provider - Select a dialect from the relevant provider (for the list of providers, see Analytical Engine Overview). The selection determines the syntax of the generated SQL query.

      • Upload dialect - Upload your own dialect, a manual Java class to resolve SQL dialect issues.

  8. Click Create.

Now that you have created the custom connector, see Creating a Custom Connection, including: