Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 2.91 KB

README.md

File metadata and controls

63 lines (44 loc) · 2.91 KB
Raw

Import API Java Client

The repository contains plugins for generating API Clients for the Import and Core APIs. It also helps to generate POJO classes for Template schemas, used by the Import API to import CSV and Excel files.

Table of contents

  1. Project structure
  2. Project Configuration
  3. Test
  4. Collibra developer terms
  5. Additional resources

Project structure

This project uses Gradle as a dependency management tool (Kotlin DSL). The project also uses plugins for generating:

  • An Importer API client based on dgc-importer-rest.json using the openApiGenerate gradle task
  • A Core API client based on dgc-rest.json using the buildCoreRestClient gradle task
  • POJO classes describing template parameters used to import CSV files based on schema.json using the generateJsonSchema2Pojo Gradle task.

The dependency openapi-generator-gradle-plugin was used to generate the Open API client. Additionally, the generated code was marked as a source set to make the generated classes detectable within the data-quality project.

The dependency jsonschema2pojo-gradle-plugin was used to generate the POJO classes describing the template parameter used to import CSV and Excel files.

See build.gradle.kts for more information.

Project Configuration

The configuration properties are located in the config.properties file. All variables are required to access the Collibra Platform and run the DataQuality tests and DataImporterTest.

Environment Variables to set up your Collibra environment

Parameter Description Example
DGC_URL The base URL of your Collibra environment. DGC_URL=https://collibra-example.com
DGC_USERNAME The user name to be used by the API clients. DGC_USERNAME=john.doe
DGC_PASSWORD The password to be used by the API clients. DGC_PASSWORD=password

Tests

  • To run the health check for the project configuration, execute the ImportHealthCheckTest test.
  • To test the configuration and import function, invoke gradle test.

Collibra developer terms

This repository is part of the Collibra Developer Toolkit. By using or accessing the Developer Toolkit, you agree to the Collibra Developer Terms.

Additional resources