DQC Logo
|

Verbindung zu einem Alation-Datenkatalog

Um die DQC Platform mit Alation zu verbinden, wird ein dedizierter API-Nutzer samt Zugriffstoken benötigt. So können Datenqualitätsmetriken direkt an die passenden Katalogeinträge übermittelt werden – und Nutzer erkennen auf einen Blick die Qualität ihrer Datenobjekte.

Zur Alation API

Die Alation API ist eine REST-Schnittstelle, die Standardmethoden wie GET, POST, PUT, DELETE sowie JSON-Nachrichten unterstützt. Die Authentifizierung erfolgt per OAuth2. Über die API lassen sich:

  • Datenobjekte suchen

  • Metadaten lesen oder aktualisieren

  • Qualitätsdaten der DQC Platform an Katalogeinträge anhängen

Die offizielle Dokumentation ist unter folgendem Link verfügbar: Alation APIs.

API-Nutzer in Alation erstellen

Cloud-Umgebungen

  1. In Alation öffnen: Admin Settings > Manage Users

  2. Neuen Nutzer für API-Zugriffe anlegen (siehe auch https://docs.alation.com/en/latest/admins/AdminSettings/ManageUsers.html )

  3. Im Profil des Nutzers zum Reiter Authentication wechseln

  4. Dort ein neues Access Token generieren

Das Token dient als Schlüssel zur Authentifizierung in der DQC Platform

On-Premises mit Single Sign-On (SSO)

Bei Installationen mit SSO muss der API-Nutzer direkt auf dem Server erstellt werden. Folgende Schritte als Admin durchführen:

sudo service alation shell
alation_django_shell

u = User.objects.create(username='dq_api', email='dq@example.com')
u.confirm_email(u.confirmation_key)
u.set_password("StrongPassword123!")
u.save()

from core.models import UserProfile
UserProfile.objects.create(user=u)
u.profile.assign_role(0)
u.profile.save()

undefined Hinweis: Tokens und interne Nutzernamen sollten nicht in gemeinsam genutzter Dokumentation auftauchen.

DQC Platform mit Alation verbinden

Sobald der API User erstellt wurde:

Feld in DQC Platform

Wert aus Alation

Client ID

Alation-Benutzername (API-Nutzer)

Client Secret

Das generierte Access Token

Alation Base URL

z.B. https://yourcompany.alationcloud.com

Project Name

Name des DQC-Projekts, zu dem die Daten gehören

Statische IP-Adresse der DQC Platform freigeben

Für eine stabile Verbindung sicherstellen, dass Zugriffe von folgender IP erlaubt sind:

3.123.94.228

undefined Hinweise