> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/tutorials/getting-started-with-collibra-connect.md).

# Getting started with Collibra Connect

## Getting started with Collibra Connect

{% hint style="warning" %}
Collibra Connect is End of Life and therefore no longer supported. This documentation is no longer maintained and is likely out of date, but it remains available for reference purposes.
{% endhint %}

## Getting started with Collibra Connect

In this tutorial you learn about the Collibra Connect prerequisites and install MuleSoft Anypoint Studio and the Collibra Connector. Anypoint Studio is an Integrated Development Environment (IDE) for designing and testing Mule applications.

Collibra Connect is based on the Mule platform. Mule is a lightweight, Java-based enterprise service bus (ESB) and integration framework provided by MuleSoft.

Mule eliminates the need for point-to-point connectivity. It uses out-of-the-box templates to connect Collibra Data Governance Center to a variety of third-party applications through the Collibra DGC REST API.

### Prerequisites

* You have the latest version of the [Java SE Development Kit 8](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) installed.

{% hint style="success" %}
To check if you have a JDK already installed, type `java -version` in your command line. For more information, see the JDK requirements corresponding to your Anypoint Studio version in the [MuleSoft documentation](https://docs.mulesoft.com/studio/latest/faq-jdk-requirement).
{% endhint %}

### Hardware Requirements

* 4 GB RAM
* 2 GHz CPU
* 10 GB free hard disk space

### MuleSoft Anypoint Studio

Anypoint Studio provides both a visual and an XML editor to design and craft your applications. It also allows you to edit API definition files and create domains that define shared resources.

#### Installation

{% stepper %}
{% step %}
Go to the Collibra Community [Mule Anypoint Studio](https://community.collibra.com/downloads/mule-anypoint-studio) page.
{% endstep %}

{% step %}
Download the latest version of MuleSoft Anypoint Studio corresponding with your operating system.
{% endstep %}

{% step %}
Install Anypoint Studio:

| OS               | Procedure                                                                                                                                        |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Windows          | Extract the archive in the **C:\\** root folder.                                                                                                 |
| macOS            | <ol><li>Extract the archive.</li><li>Save the <strong>AnypointStudio</strong> application in the <strong>Applications</strong> folder.</li></ol> |
| Linux            | Extract the archive.                                                                                                                             |
| {% endstep %}    |                                                                                                                                                  |
| {% endstepper %} |                                                                                                                                                  |

{% hint style="info" %}
If you get Java related warnings, make sure you have the correct versions of the Java Development Kit and Java Runtime Environment installed and configured. For more details, see the [Anypoint Studio JDK Requirement](https://docs.mulesoft.com/studio/latest/faq-jdk-requirement).
{% endhint %}

#### Initial setup

The first time you start Anypoint Studio, you need to select a workspace, a folder where your projects are stored.

{% stepper %}
{% step %}
Open Anypoint Studio.
{% endstep %}

{% step %}
Click **Launch** to accept the default workspace when prompted or set a custom folder.

<img src="/files/CTtzL76VkfYjzIfiuTbP" alt="" width="50%">

<i class="fa-chevrons-right">:chevrons-right:</i> A welcome message is displayed the first time Anypoint Studio starts or whenever the workspace folder is deleted.

{% hint style="info" %}
Use the absolute path for macOS and Linux when setting a custom workspace folder.
{% endhint %}
{% endstep %}

{% step %}
Click **OK** to close the welcome message.
{% endstep %}

{% step %}
Accept or reject the anonymous statistics collection message.
{% endstep %}

{% step %}
Click **Go to Workspace** to start using Anypoint Studio.

<img src="/files/Ne7sncU4VYnateFcIQGa" alt="" width="50%">
{% endstep %}
{% endstepper %}

#### Interface

The Anypoint Studio default interface is divided into several views containing one or more tabs:

<img src="/files/tChvinS6vl4eq67WjrFN" alt="" width="50%">

| Element | Name                | Description                                                                                                                         |
| ------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| 1       | Package Explorer    | A tree list display of files and folders associated with the current project.                                                       |
| 2       | Canvas              | A space containing either a visual or XML representation of the project and the global elements, which are reusable configurations. |
| 3       | Palette             | A list of drag-and-drop building blocks for your application.                                                                       |
| 4       | Connection Explorer | A list of global connector configurations contained by your application.                                                            |
| 5       | Console             | A list of application events and errors (if any).                                                                                   |

### CollibraDGC connector

{% hint style="info" %}
The Collibra DGC connector has several versions designed to be compatible with specific Collibra DGC, Mule or Collibra API versions. For more details, see [Collibra Connect Compatibility](https://developer.collibra.com/connect/connect-documentation/Content/Intro/ref_compatibility.htm).
{% endhint %}

#### Dependencies

* The installation of the latest CollibraDGC connector depends on Apache Maven 3.x or higher. For installation instructions, see [Installing Apache Maven](https://maven.apache.org/install.html).
* You have downloaded the **pom.xml** file from the Collibra DGC Connector section of the Collibra Community [downloads page](https://productresources.collibra.com/downloads/#connect) to a dedicated location.

#### Installation

{% stepper %}
{% step %}
Open a shell session or command prompt.
{% endstep %}

{% step %}
Go to the directory with the connector JAR file.
{% endstep %}

{% step %}
Install the connector with the following case-sensitive command:
{% endstep %}

{% step %}
Start Anypoint Studio.
{% endstep %}

{% step %}
Open a project with a Collibra DGC integration template or create a new project.
{% endstep %}

{% step %}
In the project, locate **pom.xml** and double-click the file to open its details.

<img src="/files/ZnqijkPO9ta2MSXFfiTy" alt="" width="25%">
{% endstep %}

{% step %}
On the canvas, right-click **dependencies**.
{% endstep %}

{% step %}
From the context-menu, select **Add Child** and click **dependency**.\ <i class="fa-chevrons-right">:chevrons-right:</i> A new dependency is added.
{% endstep %}

{% step %}
Right-click the newly created dependency, select **Add Child** and click **artifactId**.
{% endstep %}

{% step %}
Repeat the previous step to add the following children:

* **groupId**
* **version**
* **classifier**
  {% endstep %}

{% step %}
Click in the **Content** column of the added children and enter the following information:

| Dependency    | Content (examples for Collibra Connect 2.0.9) |
| ------------- | --------------------------------------------- |
| artifactId    | dgc.connector                                 |
| classifier    | mule-plugin                                   |
| groupId       | com.collibra.connect                          |
| version       | 2.0.9                                         |
| {% endstep %} |                                               |

{% step %}
Save the **pom.xml** file.
{% endstep %}

{% step %}
Reopen your project.\ <i class="fa-chevrons-right">:chevrons-right:</i> The CollibraDGC connector appears in the Mule Palette.
{% endstep %}
{% endstepper %}

```
mvn install:install-file -Dfile=dgc.connector-<version_number>-mule-plugin.jar \
-DgroupId=com.collibra.connect -DartifactId=dgc.connector \
-Dversion=<version_number> -Dclassifier=mule-plugin -Dpackaging=jar \
-DpomFile=<path_to_downloaded_pom.xml_file>
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.collibra.com/tutorials/getting-started-with-collibra-connect.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
