Ellie x Collibra Integration Guide

Overview

The Ellie x Collibra connector allows you to:

• Map Folders in Ellie to Domains in Collibra.

• Synchronize Glossary Elements between Ellie and Collibra.

• Sync Conceptual Models from Ellie to Collibra.

• Automate or Manually trigger sync operations.

This guide explains how to configure and use the connector effectively.

Open

Key Features

1. Folder Mapping
   Map one or more Ellie folders to corresponding Collibra domains to maintain a consistent structure.
   
   

Open

2. Glossary Elements Sync

   • Bi-directional sync of glossary items (terms).

   • Map metadata fields (e.g., descriptions, statuses, custom fields) between Ellie and Collibra.

   • Choose a master system (Ellie or Collibra) to resolve conflicts.

Open

3. Conceptual Model Sync

   • One-way sync from Ellie to Collibra.

   • Define which Collibra asset type represents Ellie’s conceptual model.

   • Relate entities to models in Collibra using a relationship type (e.g., “Used In Model,” “Contains Entity,” etc.).

   • Each model in Collibra includes a direct link back to Ellie.

Open

4. Sync Options

   • Manual Sync: Trigger on-demand sync through the connector UI in Ellie.

   • Automated Sync: Schedule recurring syncs using cron-style scheduling (e.g., every hour or once per day).

Open

Prerequisites

1. Collibra Connector Access
   Ensure you have Ellie admin privileges to set up a connector.

2. Collibra Admin Permissions
   You’ll need valid Collibra credentials (username/password) with the appropriate organization URL and API access rights to connect.

3. Metadata Fields

   • In Ellie, add the custom metadata fields “External Term ID” and “External Glossary ID” to your conceptual entity (in the Admin Settings -> Metadata).

   • Note: This step is required for the sync to function properly.

4. Entity & Model Relationship (needed for Conceptual Model Sync)
   In Collibra, have a relationship type defined to link an asset representing an Ellie “conceptual entity” with an asset representing an Ellie “conceptual model.”

Setup & Configuration

1. Create a Collibra Connector

   • In Ellie, go to Admin Tools > Connectors.

   • Click New Collibra Connection.

   • Provide:

     • Name (e.g., “Collibra Connector”),

     • Collibra Organization (the URL or tenant link),

     • Authentication (Collibra username & password).

2. Select Folders to Sync

   • Pick the Ellie folder(s) containing glossary items or models that you want to sync.

   • Map these folders to the correct domains in Collibra.

3. Configure Glossary Sync

   • Choose which Collibra asset types represent glossary “entities” or “terms.”

   • Map relevant metadata fields (e.g., names, definitions, etc.).

4. Configure Conceptual Model Sync

   • Select the Collibra asset type that represents an Ellie conceptual model (e.g., “Conceptual Model” in Collibra).

   • Select the relationship between the assets.

     • Note: Ensure a relationship definition exists in Collibra (e.g., “contains entity” or “used in model”) that links:

       1. Entity asset type ↔ Conceptual Model asset type.

   • Map any necessary metadata fields (description, Ellie model link, etc.).

5. Define Automated or Manual Sync

   • Manual Sync: Click Sync Now whenever you want to push/pull changes with a specific tool acting as Master.

   • Decide which tool acts as the master (Ellie or Collibra).

   • Automated Sync: Enable scheduling with a cron expression (e.g., 0 17 * * * for daily at 5 PM).

Multiple Connectors

• Ellie supports multiple Collibra connectors.

• Recommended Practice:

  • Use one connector where Ellie is the master for glossaries/models.

  • Use another connector where Collibra is the master.

  • This ensures clearer oversight (separate logs and configurations) for each direction of sync.

Synchronization Process

1. Manual Sync

   • In the Connector list, click Sync Now to start the process.

   • Monitor progress via the Logs section.

2. Automated Sync

   • If you’ve scheduled syncs, they’ll run at the defined times without manual intervention.

   • Review logs for any errors or conflicts.

3. Post-Sync Verification

   • In Collibra: Check that glossary items and conceptual models appear in the chosen domains with correct metadata.

   • In Ellie: Ensure that any changes made in Collibra are reflected in your Ellie folder (when Collibra is master).

Logs & Troubleshooting

• Logs:

  • Navigate to the Connector’s detailed view to see logs of all sync activities.

  • Errors or warnings (e.g., missing relationships, unmapped fields) are highlighted here.

• Common Issues:

  • Missing Metadata Fields: Ensure “External Term ID” and “External Glossary ID” are added in Collibra.

  • Relationship Mismatch: Confirm that each Collibra asset type is linked to the correct relationship definition.

FAQ

1. Can models be synced from Collibra back to Ellie?

   • No. Conceptual model sync is strictly Ellie → Collibra. Glossary item sync, however, is bidirectional.

2. What happens if the sync fails?

   • Check the error logs in the connector’s detail view. Most issues arise from missing metadata fields or relationship definitions. Fix these and re-run the sync.

3. Can I revise asset-type mappings after setup?

   • Yes. You can update mappings anytime, but remember to re-run or re-schedule the sync if changes are made.

4. Is it okay to sync the same folder with multiple connectors?

   • Generally not recommended. If you do, carefully manage mappings to avoid conflicts and duplication.