How to Import a DataHub Connector

Purpose

This document explains how to import an existing DataHub Connector into the system, activate it using DataHub Connector Keys, and prepare it for execution.

Prerequisites

Before importing a connector, ensure the following requirements are met:

  • You have an exported DataHub Connector file.
  • The connector export file must be in .kdl format.
  • You have a proper license to activate the connector.
  • You have permission to access:
    • DataHub module
    • Configuration - Access Manager - DataHub Connector Keys (will be used to activate the connector)

Importing a DataHub Connector

Step 1: Open the DataHub Module

1. Navigate to the DataHub module.

image.png

2. It will open the connector list page.

image.png

3. Click on the three-dot menu.

image.png

4. Click Import.

image.png

The Import Connector dialog will open.

image.png

Step 2: Upload the Connector File

The import dialog allows the connector file to be uploaded by:

  • Clicking the upload area and selecting a file manually
  • Dragging and dropping the file into the upload area

Select the exported .kdl file.

After the file is loaded:

  • ID is automatically populated from the imported connector
  • Name is automatically populated
  • Import Kind is automatically set to Create
image.png

Step 3: Select Import Type

The Import Kind field determines how the connector will be imported.

Available options are:

Create

Creates a new connector using the imported configuration.

This is selected automatically when importing a connector that does not already exist.

Update

If the connector already exists, importing the same connector changes Import Kind automatically to Update. The ID and Name field will be disabled.

This updates the existing connector configuration.

Create As New

Use this option when a new connector should be created from an existing export.

When using Create As New:

  • Provide a new connector ID
  • Provide a new connector Name
  • The ID must be unique and should not exists.

Step 4: Complete the Import

Click on Import button to finish the import process to create the connector.

After import, open the connector edit page.

The following warning message may be displayed:

"This connector is unlicensed and cannot be used for importing, validation is the only available operation."

This means:

  • The connector has been imported successfully
  • The connector is currently inactive
  • Import operations cannot run until licensing is applied
  • However, as mentioned in the message Validation can be performed on data without activating the license.
image.png

Activating the Connector

To activate the connector:

Navigate to: Configuration → Access Manager → DataHub Connector Keys

image.png

Assign a license to the connector.

Activation consumes DataHub tokens. Token usage depends on the module associated with the connector.

Examples: Token Cost for the WorkOrder will be 7, for Asset it will be 9 tokens and for Part it will be 4 tokens.

Token requirements vary depending on connector type and module configuration.

So look for your connector that needs activation on the In-Active DataHub Connectors section.

Click on Activate

image.png

Assign the license.

select a license and hit the green tick buttom at the top left to assign the license and activate the connector:

image.png

A Save/Cancel option will appear to Save or cancel the license activation change. Click on Save

image.png

Verify Connector Activation

After licensing:

  1. Return to the DataHub module.
  2. Open the connector.

The connector status should now display as:

Active, can be used for data processing.

image.png

Running the Connector

After activation, the connector can be executed manually.

Manual execution steps are documented separately in:

DataHub Connector – How to Run it to execute importing data

(A link will be Added document reference link when available.)

Automate execution can be done by setting up Event&Action, steps are documented separately in:

How to create an E&A for a DataHub connector to run it

(A link will be Added document reference link when available.)

Additional Notes

  • Only .kdl files are supported for connector import.
  • Validation can be performed before activation.
  • Import execution is disabled until licensing is applied.
  • Connector activation consumes DataHub tokens.