New Connectors Framework
  • 08 May 2022
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

New Connectors Framework

  • Dark
    Light
  • PDF

From Sisense Linux V8.2.4, Sisense uses the new connectors framework for the following connectors:

  • Snowflake
  • Redshift
  • Postgre
  • MySQL
  • Google BigQuery
  • Oracle

The new connectors framework resolves issues related to memory consumption, and improves the performance of the supported connectors. After installing Sisense Linux V8.2.4, all connectors supported by the new framework reside in /opt/sisense/storage/connectors/framework/(connector name), each in its own folder.

Each connector folder contains 4 files:

  • config.yaml.imported: This configuration file defines common connector parameters (like connection string parameters and setters). This file is only for reference.
  • Jar file: This is the JDBC driver of the connector. You can change or upgrade this file, as described in Upgrading Connectors.
  • manifest.json: The connector UI manifest file that displays fields used when adding the connector. This file cannot be modified directly, as it will be overwritten during upgrades or restarts. Instead, create and use a file named manifest.custom.json instead of the default manifest.json.
  • Icon.svg: The connector's icon is displayed in the UI when adding a new connector.
Note:

In rare cases, you may have modified the description.json file of your legacy connector. If so, this file is ignored and you must reconfigure your connector, as described in Configuring Connectors in the Configuration Manager.

Viewing Supported Connectors

Sisense will be releasing more connectors on the new framework. You can view a list of all the connectors currently supported by Sisense by executing the following in command the Sisense CLI:

si connectors list

Disabling Connectors

If you prefer to work with legacy connectors, you can disable connectors that are built on the new framework. When disabled, the legacy connector will be used to handle model building, query, and build flows. This can be useful if a connector in the framework does not behave as expected.

si connectors disable -id <id>

If you want to disable the connector and revert back to the legacy connector once the new connector is disabled, set the shouldEnableDisableLegacyConnectors key to false. (By default, it is false).

The shouldEnableDisableLegacyConnectors key is located in the configuration:

/Sisense/S1/configuration/production/connectors/shouldEnableDisableLegacyConnectors

Configuring Connectors in the Configuration Manager

In addition to the Sisense CLI, you can configure connectors directly via the Configuration Manager. The functionality is the same, but the Configuration Manager provides a GUI for making your changes.

To configure connectors via the Configuration Manager:

  1. Access the Configuration Manager through the System Management section of the Admin page.
    image.png

  2. Click Configuration.

  3. Click Manage Connectors.

  4. Enable or disable connectors by toggling the switch to Enabled or Disabled.

  5. Click Save.


Was this article helpful?