New Connectors Framework

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, or later, 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 four files:

  • config.yaml.imported - Configuration file defines common connector parameters (like connection string parameters and setters). This file is only for reference.
  • Jar file - JDBC driver of the connector.
  • 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 that 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 below in Configuring Connectors in the Configuration Manager.

To list all of the connectors currently supported by the new framework execute the following command in the Sisense CLI:

si connectors list

Allocating Memory

To allocate more memory (for builds) to the connectors running under the new connectors framework:

  • Go to the Admin tab > select System Management > click Configuration (top right-hand corner) > 5 clicks on the logo (top left-hand corner) > select Build-Connector (in the Services section).

  • Set the required MaximumMemoryLimit value.

See Troubleshooting Memory Issues for more information.

Legacy Connectors

Note:

As of version L2023.9:

For cloud customers who are not using old connectors, the old connectors pod is deleted when upgrading. There will be no option to access the old connector pod/connectors and no option to disable new connectors, (as described in this section).

For upgraded Sisense deployments that are not in the cloud, or for any customer that was using the old connectors, the old connectors will continue to be accessible.

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

si connectors disable -id <id>

To revert back to the legacy connector once the new connector is disabled, set the shouldEnableDisableLegacyConnectors key to false. (It is set to false by default.)

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.

  2. Click Configuration.

  3. Click Manage Connectors.

  4. Select a connector and update its settings.

  5. Click Save.