Jira-Schnittstelle

Voraussetzungen

Folgende Schritte sind notwendig, damit die Jira-Schnittstelle einsatzbereit ist:
  • Folgende Server-Parameter für das PLANTA project -System, das mit dem Jira-System kommunizieren soll, in der web.conf konfigurieren:
    • generic_service - muss aktiviert sein (true)
    • generic_service_interface - muss konfiguriert sein, wenn nötig
    • generic_service_port - muss konfiguriert sein
    • ssl_generic_enable - muss aktiviert sein (true), wenn Sie Jira auf HTTPS laufen lassen möchten.
    • apikey_auth_filter_generic - muss deaktiviert sein (false), weil sich Jira gegenüber den Web-Schnittstellen nicht authentifiziert.
    • Nach dem Konfigurieren der Parameter muss der Server neugestartet werden.

  • In PLANTA link
    • im Modul Jira-Parameter die notwendigen Parameter im Bereich Jira-Authentifizierung definieren und im Bereich Jira-Schnittstellen die notwendigen Schnittstellen auswählen.
      • In PLANTA-Standard sind bereits alle notwendigen Standard-Schnittstellen defaultmäßig hinterlegt.
    • im Modul Benutzersynchronisation PLANTA project- und Jira-Benutzer synchronisieren bzw. miteinander verknüpfen.

  • In PLANTA project
    • muss die Zeiterfassungsvariante = 3 voreingestellt sein, damit die in Jira erfassten Arbeitsstunden nach PLANTA project übertragen werden können.
    • Die Schnittstelle unterstützt zurzeit keine automatischen Stornobuchungen. Das bedeutet
      • entweder man verwendet die Stornoeinstellung posting_cancelation = 0, diese verhindert jedoch nicht die Änderungen auf der Jira-Seite (hierzu wären Anpassungen auf der Jira-Seite notwendig), die Änderungen werden lediglich nicht nach PLANTA project übertragen.
      • oder man arbeitet grundsätzlich ohne Stornobedingungen (kein Stichtag, keine Freigabe für an Fremdsysteme übertragenen Datensätze etc.)

Hinweis

  • Da die Schnittstelle zu Jira auf Web-Schnittstellen basiert, bitte auch Hinweise zu Web-Schnittstellen beachten.

Anwendung

Synchronisierung von PLANTA project nach Jira

Information
  • Die Synchronisierung der Daten aus PLANTA project nach Jira erfolgt manuell über einen Kontextmenübefehl im Modul Terminplan.
  • Die Synchronisation muss jedes mal manuell angestoßen werden, wenn die für Jira relevanten Daten eines bereits synchronisierten Vorgangs geändert wurden, um die Aktualisierung der entsprechenden Daten in Jira zu gewährleisten.

Folgendes muss für ein Projekt erfüllt sein, damit es mit Jira synchronisiert werden kann:

  • Das Projekt ist
    • aktiv (Status = Aktiv)
    • entsperrt (Gesperrt =Nein)
    • nicht mit einem anderen Fremdsystem synchronisiert
    • Die fachliche ID des Projekts muss den ID-Regeln von Jira entsprechen, d.h. die fachliche ID des Projekts muss mit einem Buchstaben beginnen, gefolgt von einem oder mehreren Buchstaben oder Ziffern. Erlaubt sind 10 Zeichen. Sonderzeichen sind nicht erlaubt.
    • Die Projektbezeichnung darf in Jira noch nicht vergeben sein.

Vorgehensweise zur Synchronisierung

  • Im Modul Projektsteckbrief im Feld Fremdsystem den Eintrag "Jira" auswählen. Die Auswahl bewirkt, dass im Modul Terminplan die für die Synchronisation notwendigen Steuerungselemente eingeblendet werden: die Checkbox Jira und der Eintrag Mit Jira synchronisieren im Kontextmenü.
  • Im Modul Terminplan für die Vorgänge, die nach Jira exportiert werden sollen, die Checkbox Jira aktivieren.
  • Auf den Projektbalken rechtsklicken und den Kontexmenü-Befehl Mit Jira synchronisieren auswählen.
  • Sobald die Synchronisation abgeschlossen ist, wird eine Meldung angezeigt, die darüber informiert, ob die Synchronisation erfolgreich durchgelaufen ist oder ob es Probleme gegeben hat.
    • Wenn die Synchronisation erfolgreich abgeschlossen wurde, werden
      • das PLANTA project-Projekt in Jira als Projekt angelegt.
        • Der Name des Projekts in Jira enspricht dem Namen des Projekts in PLANTA project.
        • Der Schlüssel des Projekts in Jira entspricht der fachlichen ID des Projekts aus PLANTA project.
      • der PLANTA project-Vorgang in Jira als Issue vom Typ = Epic angelegt.
        • Die fachliche Vorgangs-ID und der Name des Vorgangs aus PLANTA project werden zu dem Epic-Namen in Jira. Hat der zu synchronisierende Vorgang in PLANTA keine fachliche ID, dann wird die technische Vorgangs-ID verwendet.
      • der Projektleiter des Projekts aus PLANTA project zum Epic-Bearbeiter in Jira.
        • Da in Jira nur eine Person gleichzeitig ein Bearbeiter von einem Epic sein kann, können keine Vorgangs-Ressourcenzuordnungen aus PLANTA project mit Jira synchronisiert werden.
    • Wurden nach Abschluss der Synchronisation Fehler gemeldet, werden im Modul Offene Konfigurationen (PLANTA link) alle Transaktionen angezeigt, die nicht durchgelaufen sind. Durch Aufruf der Logdatei auf der gewünschten Transaktion kann genau nachvollzogen werden, welche Fehler aufgetreten sind.

Restriktionen

  • Es können nur Projekte mit Jira synchronisiert werden, keine Ideen, keine Vorhaben und keine Programme.
  • Der Parameter Fremdsystem kann nicht mehr leergesetzt oder auf ein anderes Fremdsystem geändert werden, sobald mindestens ein Vorgang mit Jira synchronisiert wurde. Der Anwender wird über eine entsprechende Meldung informiert.
  • (Master)Meilensteine und Sammelvorgänge können nicht mit Jira synchronisiert werden. Versucht der Anwender für einen (Master)Meilenstein oder einen Sammelvorgang das Feld Jira-relevant zu aktivieren oder versucht er einen mit Jira synchronisierten Vorgang in einen (Master)Meilenstein oder einen Sammelvorgang umzuwandeln, kommt eine entsprechende Meldung.
  • Für den Vorgang, der nach Jira exportiert wurde, kann die Checkbox Jira nicht mehr deaktiviert werden. Der Anwender wird über eine entsprechende Meldung informiert.
  • Projekte/Vorgänge, die mit Jira synchronisiert sind (und in Jira existieren) können in PLANTA project nicht gelöscht werden. Der Anwender wird über eine entsprechende Meldung informiert.
    • Die aus Jira rücksynchronisierten Ressourcenzuordnungen, also diejenigen, die selbst aus Jira kommen oder bereits Belastungen aus Jira bekommen haben, können ebenfalls nicht gelöscht werden, ebenso wie die rücksynchronisierten Belastungsdatensätze.

Rücksynchronisierung von Jira nach PLANTA project

Information
  • Die Rücksynchronisierung von Jira nach PLANTA project erfolgt automatisch, sobald die Daten in Jira gespeichert wurden, über die sogenannten Webhooks.

Achtung

  • Daten, die in Jira erfasst wurden und mit PLANTA project bereits rücksynchronisiert wurden, dürfen nicht gelöscht werden, da die Informationen über die in Jira gelöschten Daten nicht nach PLANTA project übermittelt werden.

Welche Daten werden rücksynchronisiert?

  • Wenn in Jira der Bearbeiter eines Epics geändert wird, wird die entsprechende Person als neue Ressourcenzuordnung dem entsprechenden Vorgang in PLANTA zugeordnet.
  • Wenn in Jira Stunden auf dem Epic erfasst werden von einer Person, die in PLANTA project dem entsprechenden Vorgang als Ressource zugeordnet ist, werden in PLANTA project für diese Ressource Belastungen angelegt.
  • Wenn in Jira Stunden auf dem Epic erfasst werden von einer Person, die in PLANTA project noch nicht dem entsprechenden Vorgang als Ressource zugeordnet ist, wird in PLANTA project auf dem Vorgang
    • zunächst eine Ressourcenzuordnung erzeugt und
    • dieser werden dann die in Jira erfassten Belastungen zugewiesen.

Details

  • In Jira besteht die Möglichkeit, die Arbeitsstundenerfassung nicht nur auf den Epics zu machen, die direkt den Vorgängen in PLANTA project entsprechen, sondern auch auf den den Epics direkt untergeordneten Elementen, Stories. Die Stunden von den Stories werden bei der Rücksynchronisierung dem entsprechenden Vorgang in PLANTA project korrekt zugeordnet.
  • Enthält ein in Jira erfasster Stundendatensatz einen Kommentar, wird dieser ebenfalls nach PLANTA project übertragen.
    • Das Kommentar-Feld ist in PLANTA 80 Zeichen lang. Wird in Jira ein längerer Kommentar erfasst, wird dieser beim Übertrag auf die Länge in PLANTA project gekürzt.
  • Um die aus Jira übertragenen Stunden zu sehen, im Terminplan die Modulvariante Mit Belastungen öffnen. Ist diese Modulvariante bereits geöffnet, muss die Anzeige nach dem Übertrag aktualisiert werden.
    • Damit die aus Jira übertragenen Belastungen in Aufwandsdaten auf den Ressourcenzuordnungen und Vorgängen berücksichtigt werden, muss der Terminplan neu berechnet werden.

Hinweise

  • Bei der Rücksynchronisierung werden die Daten aus Jira zunächst in Pool-Tabellen geladen. In den Pool-Tabellen wird Folgendes geprüft:
    • die Zugehörigkeit der Daten, also die Stunden von welchem Epic oder welcher Story gehören zu welchem Vorgang
    • die Zulässigkeit der Datenerfassung in PLANTA project, wie z.B. Stichtag, Rückmeldung in Zukunft etc.
      • Nur die Daten, bei denen die Prüfung positiv ist, werden in die PLANTA project-Tabellen geladen und erscheinen dann auch in entsprechenden Modulen. Kommen bestimmte aus Jira erwartete Daten nicht in PLANTA project an, können die fehlenden Daten in den Pool-Tabellen überprüft werden oder die Informationen zu den entsprechenden Transaktionen im Modul Logging abgerufen werden.

web-bg-small 39.5 Venus Current DE

         PLANTA project









 
  • Suche in Topic-Namen

  • Suche in Topic-Inhalten