Technical Documentation : Connectors : Adding a Generic Dataset Connection (Deprecated)
Was this helpful?
Adding a Generic Dataset Connection (Deprecated)
Deprecated
This connector is deprecated. You can use the new ZDF Dataset connector instead.

Disclaimer: This connector should only be used in very specific cases where a conventional connector is unable to connect to the platform managing the data sets. The indirection offered by this connector will enable you to create and then document datasets from a description. By contract, Zeenea defines a Dataset as a data container that physically exists on a platform. If you decide to use this connector, you must respect this contract in order to provide your end-users with a consistent experience. For more information, contact your customer success manager.
Prerequisites
A user with sufficient permissions is required to gather the metadata from the JSON description files.
Configuration templates can be downloaded here:
Supported Versions
This connector is compatible with Zeenea description files as illustrated by the templates listed above.
Installing the Plugin
This connector is presented as a plugin and can be downloaded here: Zeenea Connector Downloads
For more information on how to install a plugin, please refer to the following article: Installing and Configuring Connectors as a Plugin.
Declaring the Connection
Creating and configuring connectors is done through a dedicated configuration file located in the /connections folder of the relevant scanner. The scanner frequently checks for any change and resynchronises automatically.
For this specific connector, fill out the following parameters in the dedicated file:
Parameter
Expected value
name
The name that will be displayed to catalog users for this connection.
code
The unique identifier of the connection on the Zeenea platform. Once registered on the platform, this code must not be modified or the connection will be considered as new and the old one removed from the scanner.
connector_id
The connector type to use for the connection. Here, the value must be generic-dataset and this value must not be modified.
connection.path
Path to the folder containing the descriptor files
User Permissions
In order to collect metadata, the running user's permissions must allow the scanner to access and read the description files.
Data Extraction
To extract information, the connector will read the content of the description files.
Collected Metadata
Inventory
Will collect the list of tables and views described in the JSON files.
Dataset
A dataset can be a table or a view. This is a first level object in the JSON structure.
  • Name
  • Source Description
  • Technical Data:
    • Type
    • Label
    • Format
    • Number Of Rows
    • DiskUsage
    • Location
    • Project
    • Catalog
    • Schema
    • Database
    • ReplicationFactor
    • Tags
    • SourceSystem
    • Origin
    • Creation Date
    • Update Date
    • Created By
    • Updated By
    • Comments
Field
Dataset field.
  • Name
  • Source Description
  • Type
  • Can be null
  • Multivalued: Not supported. Default value FALSE.
  • Primary Key: Depends on "Primary key" property
  • Technical Data:
    • Format
    • Length
    • Encoding
Object Identification Keys
An identification key is associated with each object in the catalog. In the case of the object being created by a connector, the connector builds it.
More information about unique identification keys in this documentation: Identification Keys.
Object
Identification Key
Description
Dataset
code/path/dataset name
- code: Unique identifier of the connection noted in the configuration file
- path: Path of the item
- dataset name: Name of the dataset
Field
code/path/dataset name/field name
- code: Unique identifier of the connection noted in the configuration file
- path: Path of the item
- dataset name: Name of the dataset
- field name: Name of the field
Last modified date: 11/28/2025