SetUp Open Project Client

Um eine reibungslose Integration von OpenProject zu ermöglichen, müssen wir ein Servicekonto einrichten. In dieser Anleitung nennen wir es amberService . Es muss über eine lokale Rolle jeweils Zugriff auf jedes einzelne Projekt haben sowie über eine globale Rolle auf einige administrative Funktionen wie die Benutzerliste oder die Projektmitgliedschaften.
In der folgenden Anleitung gehen wir die erforderlichen Schritte zum Einrichten des Servicekontos durch.

Servicekonto amberService erstellen

Als Administrator können Sie einen neuen Benutzer unter /users/new erstellen oder indem Sie oben rechts auf Ihr Profil-Symbol klicken → Administration → Benutzer und Berechtigungen → Benutzer → + Benutzer.

Füllen Sie das Formular zur Benutzererstellung wie im Screenshot gezeigt aus und klicken Sie auf Anlegen.

Globale Rolle amberServiceRole erstellen

Neue Rollen können unter /admin/roles/new erstellt werden oder indem Sie navigieren über Benutzer und Berechtigungen → Rollen und Rechte → + Rolle.

  1. Nennen Sie die globale Rolle amberServiceRole.

  2. Aktivieren Sie das Kontrollkästchen Globale Rolle und wählen Sie anschließend die folgende Berechtigung aus:

    • Benutzer bearbeiten (erforderlich, um die Benutzerlisten abrufen zu können)

Bestätigen Sie die Erstellung der globalen Rolle mit → Speichern

Lokale Rolle amberServiceLocalRole erstellen

Als Nächstes erstellen wir die lokale Rolle erneut unter /admin/roles/new (+ Rolle)
Dort benennen wir sie amberServiceLocalRole und vergeben die folgenden Berechtigungen:

  • Projekt → Mitglieder ansehen

    • erforderlich, um zu sehen, in welchen privaten Projekten der Benutzer Mitglied ist

  • Arbeitspakete und Gantt-Diagramme → Arbeitspakete anzeigen

    • erforderlich, um Arbeitspakete projektweise durchsuchen zu können

  • Wiki →Wiki ansehen

    • erforderlich, um Zugriff auf die Wiki-Metadaten zu erhalten

Bestätigen Sie die Erstellung der lokalen Rolle mit → Speichern

Rollen dem Servicekonto amberService zuweisen

Nachdem beide Rollen definiert sind, können wir sie nun zuweisen.

Globale Rolle zuweisen

Suchen Sie das Servicekonto in der Benutzerliste unter /users (Benutzer und Berechtigungen → Benutzer → amberService). Nachdem Sie darauf geklickt haben, wechseln Sie zum Tab Globale Rollen und wählen Sie die amberServiceRole aus der Liste Verfügbare globale Rollen → Hinzufügen.

Lokale Rolle zuweisen

Die lokale Rolle muss dem Benutzer für jedes Projekt in den Projekt-Mitgliedereinstellungen unter /projects (Projekte → Aktive Projekte).

Für jedes Projekt, für das Sie dem Servicekonto Indexierungsrechte geben möchten, klicken Sie auf den Projektnamen und navigieren Sie zu Mitglieder und klicken Sie auf + Mitglied.

Dort weisen wir die amberServiceLocalRole unserem amberService Konto zu.

API-Schlüssel für das Servicekonto amberService erstellen

Um auf die API zugreifen zu können, müssen wir einen sicheren Schlüssel erstellen. Melden Sie sich dafür in der OpenProject-Instanz als neuer Servicekonto-Benutzer amberSearch an und navigieren Sie oben rechts zum Symbol für die Benutzereinstellungen.

Wenn Sie in der rechten Navigation auf Kontoeinstellungen klicken, können Sie die Seite Zugriffstokens in der linken Navigation öffnen.

Klicken Sie auf der Zugriffstoken-Seite auf die Schaltfläche + API-Token, um einen neuen Token zu erstellen und ihm einen Namen zu geben.

Zugangsdaten teilen

Nachdem Sie das Servicekonto erstellt, ihm die globalen und lokalen Rollen zugewiesen und den API-Token erzeugt haben, senden Sie die folgenden Informationen sicher an unser Team:

  • Den Benutzernamen und das Passwort des Servicekontos.

  • Den API-Schlüssel, den wir in den obigen Schritten erstellt haben.

  • Den URL der OpenProject-Instanz.