Create a Data Connector

This page explains the step-by-step process to create a Data Connector under the BDB Platform.

Create a Data Connector (using Create +)

  • Navigate to the Data Center module.

  • Click the My Connectors option.

  • Click Create +.

  • Select the Data Connector option from the context menu.

  • A page opens with all the available data connector types.

  • Select a connector type (data source) option.

  • The Connector-specific page opens. Configure the required details for the selected connector (for example: Name, Host/URL, Port, Database/Schema, Authentication, and any Advanced options).

  • (Recommended) Click Test Connection (if available).

  • Click Save.

  • A notification message appears to confirm that the connection has been successfully updated.

  • Another success message confirms the data connector has been created.

Note: After setting up a Data Connector, a user can then create a Data Set, Data Store, Feature Store, Function, Data Quality rule, or Data Form. Selecting any of these options brings up the corresponding creation form.

Fields for an API Connector

Create an API Connector (using Create +)

  1. Go to Data Center → My Connectors → Data Connectors.

  2. Click the API Connector tile.

  3. Click Create +.

  4. The API Connector page opens. Provide the following information:

    • API Name: Name for the API connector.

    • Description: Short description of the connector.

    • Base URL: The API endpoint base URL to fetch data from.

    • Select Open ID: Choose an entry (if the API requires authentication).

  5. Click Save.

Note: If the API requires authentication, configure it first via OpenID Settings, then map it in the API Connector using the Select OpenID field.

Filter Data Source by Category

  1. Click the Filter by Category icon on the Data Connectors page.

  2. Select a category from the menu (e.g., Database, API, Others).

  3. Click Apply.

  • Example: Selecting Database shows all database connectors.

Search across the Data Connector Options

  1. Use the Search bar on the Create Data Connector page.

  2. Start typing the connector name.

    • As you type, the displayed connector tiles filter in real time.

    • Example: Typing the letter “M” shows all connector types containing M.

Tips:

  • Naming: Use clear, environment-aware names (e.g., Salesforce_Prod, Postgres_UAT).

  • Credentials: Store secrets in the platform’s secure fields—do not embed credentials in connection strings.

  • Network: Ensure required hosts/ports are reachable (VPN/allow-lists, firewall rules).

  • Reusability: Create one connector per distinct source/environment; reuse across Datasets, DS Lab, and Dashboards.

Troubleshooting

  • Save/Test fails: Verify host/port, database/schema, and credentials; check TLS/SSL settings if required.

  • Connector not listed after Save: Refresh the Data Connector list or check role permissions.

  • Driver/adapter errors: Confirm the selected connector type matches your source and that the required drivers are supported.

  • Auth errors (OAuth/API keys): Re-authenticate or validate token scopes and key validity.

Last updated