Configure the Collibra Connector

A Collibra integration can be configured, in order to sync Collibra assets with DataGalaxy Portfolio instances.

It is possible to do so via Admin settings > Integration.

Set Up DataGalaxy Portfolio

1. In Admin settings > Integration, create a new Integration and give it a name, for example “Collibra integration”.

2. Generate an API Token and copy the value. Unless there is a very specific need, the Collibra connector token must be chosen preferentially with no expiration date.
   ⚠️

   The token will never be accessible again, so copy the value in a secure place.

3. Give DataGalaxy Portfolio the API token and the link to the configured connector.

4. DataGalaxy Portfolio needs to re-deploy your app with this information and add a feature-flag.

5. Create or have these concepts on DataGalaxy Portfolio:
   1. (mandatory) A concept representing the Collibra instance you want to map, which must have an External key field.

Understand Synchronization Behavior

Create Instances

Collibra → DataGalaxy Portfolio

Trigger: Every X minutes (see polling).

Actions: Creates the DataGalaxy Portfolio instance based on mapping and populates the fields mapped in the connector configuration.

DataGalaxy Portfolio → Collibra

Creation is not supported.

Update Instances

Collibra → DataGalaxy Portfolio

Trigger: Every X minutes (see polling).

Actions: Updates the DataGalaxy Portfolio instance based on mapping and populates the fields mapped in the connector configuration.

DataGalaxy Portfolio → Collibra

Update is not supported.

Delete Instances

Collibra → DataGalaxy Portfolio

Behavior

Nothing happens; the instance will no longer be synchronized.

DataGalaxy Portfolio → Collibra

Nothing happens; the instance will no longer be synchronized.

Review Connector Restarts

The connector restarts when the DataGalaxy Portfolio app restarts or the JSON configuration is changed.

On connector restart, we re-fetch all Collibra instances that are in mapped projects.

Configure the Connector

Create the JSON Configuration

You need to create a JSON as below; more information on the JSON structure is available below:

{
  "url": "https://{instance}.collibra.com",
  "auth": { see Authentication },
  "polling": {
     "cron": "0 23 * * *", // Synchronization done every day at 23:00 
     "timezone": "Europe/Paris"  
  },
  "autoCreateUsers": true | false,
  "assetTypes": [ see Asset type ]
}

Choose an Authentication Method

DataGalaxy Portfolio supports two kinds of authentication:

• Basic authentication: Collibra REST API authentication

"auth": {
  "type": "Basic",
  "user": "user",
  "token": "password"
}

• OAuth authentication: Collibra REST API OAuth

"auth": {
  "type": "OAuth",
  "user": "user",
  "token": "token"
}

Configure Polling

The polling configuration takes two options:

• cron: A cron-like string that defines when polling is done.
  • Use a website like crontab.guru to help create the configuration.

• timezone (optional):
  • If not specified, UTC will be used by default.

  • Valid timezones are:

Create Users Automatically

By default, users are not auto-created in the platform.

Set the autoCreateUsers option to true to import all users from Collibra upon startup.

Configure Asset Types

Asset types define a list of the Collibra asset types you want to sync with DataGalaxy Portfolio.

Each entry will be used to provide a mapping in the connector configuration interface.

An entry of the asset types array is as follows:

 {
   "id": "collibraAssetTypeId",
   "includeInherited": true | false,
   "syncMode": "automatic|manual",
   "roleIds": ["roleId1", "roleId2"] | undefined,
 }

Configure Inherited Asset Types

includeInherited defines whether the connector should also include asset types that extend (inherit from) the specified type.

For example, suppose you have an asset type called Asset in Collibra, with subtypes such as Asset: Domain Asset and Asset: Data Product, which inherit from Asset.

If you set id to the ID of Asset and:

• includeInherited to false, the connector will only map and synchronize instances of the Asset type itself.

• includeInherited to true, the connector will map and synchronize instances of the Asset and all its subtypes, in this example, Asset, Asset: Domain Asset, and Asset: Data Product.

Choose a Synchronization Mode

syncMode defines whether the connector should automatically pull all instances from Collibra or rely on manual mapping using the external key.

• If set to automatic, all instances of the specified type will be retrieved and synchronized from Collibra.

• If set to manual, no instances will be retrieved automatically. Instead, instances must first be created in DataGalaxy Portfolio and have their external field populated with the corresponding Collibra key in order to be synchronized.

Synchronize Roles

roleIds is an array defining which roles the connector should synchronize for each asset type. For each id in it, it will create an Association field mapping with the role name, and use it to synchronize users for the related role.

Map Collibra Assets

Map Fields

Fields that can be mapped for Collibra instances are all available in this section. Those types of fields are available for mapping:

• Text

• Number

• Boolean

• Workflow

• Association many to one (n-1) (relation):
  • Only association fields whose target AssetTypes are declared in the connector are shown for mapping. For example, if an association links AssetType A and AssetType B, but only AssetType A is declared in the connector, the association field will not be available for mapping.

  • Association in Collibra can target a parent AssetType that can have subtypes. A field per AssetType and explicitly declared subtypes of the association will be shown for mapping.

• Enumeration (string value list):
  • Values should be mapped; they are named Enumeration: [Name of the field] on the connector

• External key

Mandatory fields are:

• External key. It is thanks to this key that the connector knows which DataGalaxy Portfolio instance is mapped to which Collibra issue.

Map Status

An integration object Status is automatically added to the mapping section. Instances that are mapped provide the value for the workflow field Status in Collibra, which can then be linked to a corresponding field in DataGalaxy Portfolio.

Map Synchronization Status

An integration object Sync status is also automatically added to the mapping section. It does not correspond to a Collibra object but can be mapped to represent the synchronization status of the instance:

• Synced: The last synchronization of the instance was successful.

• Failed: The last synchronization of the instance failed.

If needed, for each mapped concept, a field Sync workflow is available to represent this synchronization status.

Read more

• Review Available Connectors

• Configure the DataGalaxy Catalog Connector

• Configure the Jira Connector