Zoomdata Version

Managing Connector Services

Overview

The Connector Services configuration area enables you to easily manage connectivity to various data sources. Starting with version 2.3,  Zoomdata's architecture has been enhanced to enable the deployment of new connectors as standalone components running  in their own process space. These connector servers can be used to extend the built-in set of connectivity options and can be deployed either on the same server as the Zoomdata application or on separate servers for reasons of performance and manageability.

The Connector Services configuration area exposes two core concepts (see Figure 1 ):

  • Connector Servers —a Zoomdata component that runs as a separate process and is responsible for handling connectivity to a data store (for example, a relational database, a NoSQL data store, or a big data store). Each Connector Server typically handles connectivity to a specific type of data store, which it exposes as a Connection Type. A Connector Server is manually registered with Zoomdata by providing its URL and optional authentication information.
    A future release will introduce the ability to automatically discover and register new connector servers.
  • Connection Types —represents the ability to connect to a specific type of data store (Data Store Type) for example, Microsoft SQL Server, MongoDB, or ElasticSearch. These Connection Types, made available on the Zoomdata Datasource configuration area, empower you to create new Connections and new Data Sources to those types of data stores. A Connection Type entry defines the set of parameters end users will need to provide when they create new connections of that type.

Figure 1

Connectors that are provided with your Zoomdata installation are mapped on the Internal Connector Server and cannot be edited or deleted. However, you can add and manage your custom Connector servers and types.

CONFIGURE A NEW CONNECTOR

You configure new Connectors in two steps (see Figure 2 ):

1. Add (register) a connector server

2. Add the connection type


Figure 2

STEP 1—Adding a Connector Server

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.

To register a Connector Server, log in as a supervisor and click Connectors . On the Manage Connector Services page, click Add Connector Server in the Connector Servers section.

To illustrate these steps, let's consider the following example. We need to add (register) the Elasticsearch connector server that is available through the following URL: http://localhost:8090/connector/

On the Create New Connector Server page, specify the following:

  • Connector server name: specify the name of the server.  In our case, type Elastic.
  • Connector server type: HTTP or Socket. For our example, select HTTP.
  • Server URL (if you selected the HTTP type) or host and port (if you selected the Socket type). For our example, specify the URL (see Figure 3 ).


Figure 3

  • Click Save .

STEP 2—Adding a Connection Type

Each Connector Server offers support for a Connection Type.  The second step in configuring a new connectivity option is to add the connection type that the Connector Server is supporting.
Perform the following steps:

  1. In the Connection Types section, click Add Connection Type .
  2. On the Create New Connection Type page (see Figure 4 ), specify the following:
    • Connection type name—specify the name for the connection type. Keep in mind that this name will be available for admins later. For our example, type Elastic .
    • Connection server—select the connection server from the list. For our example, select the Elasticsearch server that you added before.
    • Datastore type—type of the data store to which you can connect using the connector server. For our example, specify ELASTIC_SEARCH.
    • Enabled—select this checkbox to enable the connection type for the admins to use. If disabled, all the existing data sources created using this connection type will remain available (if there are any), though you won't be able to create the new ones.
    • Image—click Upload to select a custom icon for the connection type. The requirements for the icon are as follows:
      • PNG format
      • resolution (min/max)—72 x 72 px /160 x 160 px
      • max file size—50 Kb


Figure 4

  • In the Connection Type Parameters section, configure the set of parameters that an admin must specify to connect to the data source. These parameters will be available for the admins on the Connection page (see Figure 5 ).

Figure 5

  • Parameter—internal parameter name.
  • Label—specify the label for the field.
  • 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.
  • Help Text—add the hint for the field. It will be displayed when you hover over the corresponding icon.
  • Required—select the checkbox to make the field required for validating the connection.
  • Click Delete if you want to remove the field.
  1. When you have added all the required parameters, click Save . The new connection type will be displayed in the Connection Types section of the Manage Connector Services page.

Upon completing the above steps, the new Connection Type  will be made available on the Add new data source page for account admins to use (see Figure 6 ).

Figure 6

Manage EXISTING CONNECTORS

The Manage Connector Services page consists of two tables (see Figure 7 ):

  1. Connector Servers —table of registered connector servers
  2. Connection Types —table of registered connection types

Figure 7

The Connector Servers table contains details about all registered connector servers, including:

  • Connector Server name
  • Type—HTTP, Socket, and Core. The Core type is assigned to all the connectors that have not been migrated to Connection services yet.
  • URL/Host
  • Delete—you can delete a connection server, if required. Keep in mind that you cannot delete a connection server if there are any connection types available for it.

The Connection Types table contains information about all registered connection types, including:

  • Connection Type name
  • Connector Server name—the name of the server on which the connector is installed. All the built-in connectors are named Internal .
  • Enabled—select the checkbox in this column if you want to enable this connector type for admins to use.
  • Delete—you can delete only the connection types that you have added. You cannot delete the built-in connectors. If there are any connections created using the connection type that you want to delete, you will have to delete all the connections first and then delete the connection type itself.