Configuring a New Connector Manually

Zoomdata is deployed with a number of connector servers 'out of the box' that enable it to connect to a variety of different data stores. In addition to the connector servers installed with Zoomdata by default, you can also configure new connector servers. This topic walks you through the process to configure a new connector server so that authorized users may connect to that particular type of data store (from the Sources page).

To learn more about connector servers as deployed in a Zoomdata environment and the default connector services available, see Managing Connectors.

Configuring A New Connector Server

Perform the following steps to configure a new connector service in the Zoomdata environment:

  1. Add a Connector Server: A new connector server may be added via HTTP or Socket protocols.

  2. Add a Connector: Sets up the connector service so that it is accessible to authorized users via the Data Source page.

Step 1. Adding a Connector Server Manually

The first step in adding a new connectivity option to your Zoomdata instance is to register a connector server. Connector servers are started and run as separate processes, and accept requests on a specific TCP/IP port.

  1. To register a connector server, log in as a supervisor and click Connectors.

  2. On the Manage Connector Services page > Connector Servers section, click Add Connector Server.

  3. On the Register New Connector Server page, specify the following:

    • Connector Server Name: specify a unique name for the new connector server.

    • Connector Server Type: select either HTTP or Socket protocol.

    • Server URL: enter the correct parameters for the server:
      - For HTTP, you will need to provide the URL (the following picture shows the HTTP options)
      - For Socket, enter the host and port details

  4. Click Register.

Once the connector server is registered, proceed to Step 2 to have this resource display on the Data Source page and be accessible to users.

Step 2. Adding a Connector

Each connector server offers support for a connector. The second step in configuring a new connectivity option is to add the connector that the connector server is supporting.

Perform the following steps:

  1. In the Connectors section, click Add Connector. The Create New Connector page appears.

  2. On the Create New Connector page, specify the following:

    • Connector Name: specify the name for the connection type. Recommend a short title due to the limited space used to display the icon and name.

    • Connector Description (optional): provide a short description of the connection type.

    • Enable this Connector: toggle this switch to enable or disable the icon on the Data Source page.

      When disabled, existing data sources created using this connection type will remain available (if there are any), but users will not be able to create new ones.

    • Connector Server: select the appropriate server from the list.

    • Storage Type: this field is automatically set by Zoomdata once you have selected the connector server.

    • Connector Image: the default image is retrieved from the connector server. If you want to change the image, click Choose File to select a custom icon for the connection type. The requirements for the icon are as follows:

      • PNG or SVG format
      • Resolution (min/max): 72 x 72 px or 160 x 160 px
      • Max file size: 50 Kb
    • The Connector Parameters section allows you to configure or customize the connection parameters, as needed. These are the fields that appear on the Connection page when a user is configuring a new connector or editing an existing one. As the supervisor, you can modify this page's default setup as detailed below. The information is generated from the selected connector server.

      The following options help you customize the parameters to meet your needs:

      • Order: use the arrows to change the order in which the parameters will be listed
      • Required: select the checkbox to make the field required for validating the connection
      • Visible: use this option to hide or show optional parameters
      • User Attribute: use this option to enable or disable User Attribute Passthrough (UAP), which lets you set up user authentication to the data source (if that source is secured)
      • Parameter: internal parameter name.
      • Parameter Type: select the type of the control and add the options, if required. You can select the following types: text, number, password, checkbox, select, user attribute.
      • Label: specify the label for the field.
      • Help Text: add the hint for the field. It will be displayed when you hover over the corresponding icon.
  3. When you have made the required changes, click Register. The new connector is displayed in the Connector section of the Manage Connector Services page. It is also visible on the Data Sources page where you maintain data source configurations for use in Zoomdata visualizations.