Skip to main content

Collibra Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a sync or streaming data flow that sends data to a Collibra location.
collibra_api.png

Collibra

Create a Collibra Destination​

  1. Click the + icon on the Nexset that will be sent to the Collibra destination, and select the Send to Destination option from the menu.

  2. Select the Collibra connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Collibra organization, and click Next; or, create a new Collibra credential for use in this flow.

  3. In Nexla, Collibra destinations can be created using pre-built endpoint templates, which expedite destination setup for common Collibra endpoints. Each template is designed specifically for the corresponding Collibra endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Collibra destinations can also be configured manually, allowing you to send data to Collibra endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Collibra endpoints. Each template is designed specifically for the corresponding Collibra endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create Catalog Database Resources

    This endpoint creates resources in the catalog database. Use this endpoint when you need to create database metadata, schema configurations, or database resources in your Collibra catalog.

    • Enter the resource type you want to create in the Resource Type field. This should be the type of catalog database resource you want to create (e.g., databases, schemas, tables). The resource type determines which catalog database resource will be created.

    • The endpoint uses POST requests to https://{environment_url}/rest/catalogDatabase/v1/{resource_type} where {environment_url} is your Collibra environment URL from the credential configuration and {resource_type} is the resource type you provide. The endpoint URL is automatically constructed based on your credential's environment URL configuration and the provided resource type.
    • The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the catalog database resource data to create. The request body should follow the Collibra API specification for creating catalog database resources, including required fields and field names.
    • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a catalog database resource. If you need to create multiple resources, you can send multiple records, but each will be processed as a separate request.

    Resource types should match the Collibra catalog database API specification. Common resource types include databases, schemas, tables, and columns. The request body must be properly formatted JSON that matches the Collibra API specification for creating catalog database resources. The endpoint requires Basic Authentication, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating catalog database resources, including required fields, field names, and request formats, see the Collibra API documentation.

    Create Resources for Catalog Integration

    This endpoint allows you to create your own integrations with Collibra Data Governance Center. Use this endpoint when you need to create custom resources, assets, or data governance objects in your Collibra account from your data sources.

    • Enter the resource type you want to create in the Resource Type field. This should be the type of resource you want to create in Collibra (e.g., assets, domains, communities). The resource type determines which Collibra resource will be created.

    • Select the API version number from the Version Number dropdown menu. Available options are:

      • 2.0: Collibra API v2.0 (default, recommended)
      • 1.0: Collibra API v1.0 (legacy)

      You can also add custom version numbers if needed. The default value is 2.0 if not specified.

    • The endpoint uses POST requests to https://{environment_url}/rest/{version_number}/{resource_type} where {environment_url} is your Collibra environment URL, {version_number} is the selected API version, and {resource_type} is the resource type you provide. The endpoint URL is automatically constructed based on your credential's environment URL configuration and the provided parameters.
    • The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the resource data to create. The request body should follow the Collibra API specification for creating resources, including required fields and field names.
    • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a resource. If you need to create multiple resources, you can send multiple records, but each will be processed as a separate request.

    Resource types should match the Collibra Core REST API specification. Common resource types include assets, domains, communities, attributes, and relations. The request body must be properly formatted JSON that matches the Collibra API specification for creating resources. The endpoint requires Basic Authentication, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating resources for catalog integration, including required fields, field names, and request formats, see the Collibra API documentation.

Configure Manually​

Collibra destinations can be manually configured to send data to any valid Collibra API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Collibra API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Collibra API from the Method pulldown menu. The Collibra API primarily uses POST requests for data writing operations. The most common methods are:

    • POST: For creating new resources (e.g., creating catalog database resources, creating resources for catalog integration)
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

Data Format​

  1. Select the format in which the Nexset data will be sent to the Collibra API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Collibra API typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the Collibra API endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Collibra API endpoints typically follow the pattern https://{environment_url}/rest/{version}/{endpoint_path} where {environment_url} is your Collibra environment URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires Basic Authentication, which is handled automatically by your credential configuration. For detailed information about Collibra API endpoints and available APIs, see the Collibra API documentation.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization (Basic Auth), Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration. The Collibra API requires Basic Authentication, which is handled automatically by your credential configuration. The Content-Type: application/json header is typically set automatically for JSON request bodies.

Request Body​

Optional

  • If the API endpoint requires a specific request body format, configure how Nexla should format the request body from your Nexset data. The request body can be sent as JSON, XML, or form data, depending on the API endpoint requirements.

    • For JSON format, select JSON from the Request Body Format dropdown, and the Nexset data will be sent as a JSON object in the request body. Collibra API endpoints typically use JSON format for request bodies.

    • For XML format, select XML from the Request Body Format dropdown, and the Nexset data will be converted to XML format in the request body.

    • For Form data format, select Form Data from the Request Body Format dropdown, and the Nexset data will be sent as form-encoded data in the request body.

Save the Destination​

  1. Once all configuration steps have been completed, click the Save button to save your destination configuration.

  2. The destination will now be available in your data flow and will begin sending data to the Collibra endpoint according to the configured settings.