Welche Funktion bietet die Jira Schnittstelle?

Grundsätzlich gibt zwei Varianten die Schnittstelle zu nutzen - „Jira führend“ und „HQ führend“. Pro Projekt müsst ihr euch im HQ für eine der Varianten entscheiden.

HQ führend 

Die HQ führende Variante verwendet ihr, wenn ihr das Projekt in HQ planen wollt und dann Aufgaben aus der HQ Projektplanung in ein Jira Projekt exportieren möchte.

So habt ihr die Möglichkeit die Projektplanung im HQ vorzubereiten und diese Aufgaben als Vorgänge in ein Jira Projekt zu übertragen, damit bspw. die Entwickler dort anschließend arbeiten können.

Die in Jira auf diesen Vorgängen erfassten Zeiten werden ins HQ synchronisiert, so dass man diese hier zur Abrechnung nutzen kann.

Jira führend

Die Jira führende Variante verwendet ihr, wenn ihr die Projektplanung nicht im HQ machen wollt, sondern diese in Jira vornehmt oder ihr oder eure Kunden in Jira Vorgänge für Support Projekte anlegt.

Alle Vorgänge des Jira Projektes werden im verknüpften HQ Projekt anlegt und erfasste Worklogs werden übertragen, um diese in Rechnung stellen und controllen zu können. So können auch Support- und Serviceverträge optimal dargestellt werden.

 

In beiden Fällen lässt sich ein Jira Projekt mit einem HQ Projekt nachträglich verknüpfen.

Wenn du mehr darüber erfahren möchtest, so schaue dir auch gerne unsere weiteren Hilfestellungen zur Jira Schnittstelle an. Du findest diese oben verlinkt oder rechts im Bereich "Beiträge in diesem Abschnitt". 

Wie funktioniert die Jira führende Variante?

Bei Jira führenden Projekten tragt ihr im HQ Projekt unter dem Tab „Allgemein“ in das Feld „Jira-Projektkürzel“ das entsprechende Kürzel ein.

Bildschirmfoto_2020-06-11_um_14.03.14.png

Vorgänge

In dem HQ Projekt in der Projektplanung erstellt sich bei der nächsten Synchronisierung eine Phase “Jira”. Die Synchronisierung läuft alle 15 min.

Jeder Vorgang aus dem verlinkten Jira Projekt wird nun zu HQ in das verknüpfte Projekt übertragen und in der Projektplanung unter der Phase „Jira“ angelegt.

Bildschirmfoto_2020-06-11_um_14.05.22.png

Zeiten

Die erfassten Zeiten (Worklogs/ Reportings) werden entweder dauerhaft übertragen oder wenn der Vorgang abgeschlossen ist (Einstellung seitens HQ zu setzen). Teilt uns bei der Einrichtung gerne mit, welche Einstellung wir für euch hinterlegen sollen.

Welche Daten genau übertragen werden, findest du im Artikel Welche Daten werden bei Tasks und Reportings übertragen?

Hinweise:

  • Sobald der Vorgang in HQ angelegt wurde, kann dieser im HQ in der Projektplanung verschoben werden.
  • Da im HQ keine Epic-Strukturen vorhanden sind, werden diese nicht synchronisiert. 
  • Du kannst auch eine Aufgabe mit einem Vorgang direkt verknüpfen. Hierfür musst du in der HQ Aufgabe einfach das Vorgangs Kürzel in das Feld HQ-Vorgang eintragen. Dies kann in der Projektplanung gemacht werden.

Wie funktioniert die HQ führende Variante?

Bei der HQ führenden Variante tragt ihr das Jira Projektkürzel im jeweiligen HQ Projekt in der Projektplanung in die Spalte “Jira Projektkürzel” ein.

Bildschirmfoto_2020-06-11_um_14.49.27.png 

(Sollte die Spalte nicht zu sehen sein, könnt ihr euch diese über einen Klick auf einen der Pfeile des Tabellenkopfes einblenden.)

Vorgänge

Die Synchronisierung läuft alle 15 min. Sobald der Task als Vorgang in Jira angelegt wurde, spielt Jira das Vorgangskürzel zurück zum HQ und ihr könnt das Kürzel im HQ Projektplan am Task einsehen.

Tasks können zwar mit ihrem Aufgabentypen/ Vorgangstypen (Epic, Story, Task, ..) zu Jira übertragen werden, jedoch werden die Verknüpfungen zwischen den Vorgängen nicht übertragen.

Solltet ihr eine Struktur mit Unteraufgaben übertragen wollen, so gibt es die Möglichkeit, dass wir euch ein Setting setzen, welches das Übertragen von Subtasks erlaubt. Diese sind dann auch dem Task entsprechend zugeordnet.

(Das Setting kann nicht benutzt werden, wenn ihr auch die Jira führende Variante für einige eurer Projekte nutzen möchtet.)

 

Zeiten

Nachdem die Vorgänge zu Jira übertragen wurden und dort darauf gearbeitet wird, werden die Worklogs ins HQ synchronisiert. Die Zeiten der Vorgänge können entweder alle 15 min. übertragen werden oder immer erst nachdem der Vorgang abgeschlossen wurde. Teilt uns mit, für welche Variante ihr euch entscheidet, dann hinterlegen wir die Einstellung für euch.

Im HQ gibt es die Einstellung, dass Reportings immer “angenommen” sind, sprich dem Kunden in Rechnung gestellt werden dürfen. Dies gilt auch für die synchronisierten Jira Zeiten. Sollte man diese Einstellung nutzen, kann es hilfreich sein die Zeiten erst zu übertragen, wenn der Jira Vorgang vollständig abgeschlossen ist und auch tatsächlich abgerechnet werden darf.

Welche Daten genau übertragen werden, findest du im Artikel Welche Daten werden bei Tasks und Reportings übertragen?

 

Hinweise:

  • HQ überträgt den Status des Tasks/ Vorgangs nur initial
  • Bei HQ führenden Projekten dürft ihr im Reiter “Allgemein” kein Jira-Projektkürzel hinterlegt haben.
  • Subtasks können nur übertragen werden, wenn wir euch einstellen, dass Jira-führende Projekte nicht über die Schnittstelle synchronisiert werden.
  • Die Verknüpfungen/Hierarchie zwischen Story, Epic, Task .. werden nicht übertragen. Der Typ als solches hingegen schon.
  • Du kannst auch direkt eine Aufgabe mit einem Vorgang verknüpfen. Hierfür musst du in der HQ Aufgabe einfach das Vorgangskürzel in das Feld HQ-Vorgang eintragen. Dies kann in der Projektplanung gemacht werden.

Welche Daten werden synchronisiert? (für Aufgaben & Reportings)

Übertragen werden für Aufgaben folgende Werte:

Vorgänge/ Tickets <-> Aufgaben

Fälligkeitsdatum <-> Deadline

Ursprüngliche Schätzung <-> Soll

Zusammenfassung <-> Beschreibung der Aufgaben

Bearbeiter <-> Verantwortlicher

Status <-> Fortschritt (offen = 0% ; in Arbeit = 50% ; abgeschlossen = 100%)

Vorgangsstatus -> Aufgabenstatus (nur von JIRA zum HQ)
(vom HQ zu Jira wird immer der erste Aufgabenstatus übertragen)

 

Übertragen werden bei Reportings (von Jira ins HQ) folgende Werte:

Reporter -> Benutzer

Arbeitsprotokolle -> Reportings

Projektname -> Projekt

Vorgangsname -> Aufgabenname

Benötigte Zeit -> Dauer

Arbeitsbeschreibung -> Beschreibung des Reportings

Startdatum -> Startzeit

Issue Type -> Aufgabentyp

 

Hinweis: 

Benutzer und Aufgabentyp können für die Abrechnung mit Hilfe der Verrechnungssätze im HQ relevant sein. Sprecht uns gerne an, wenn ihr Unterstützung bei der Einrichtung benötigt!

Wie richte ich die Jira Schnittstelle ein? (Checkliste zur Einrichtung)

Folgende Schritte sind für die Einrichtung notwendig. Um die Einrichtung gemeinsam mit uns vornehmen zu können, benötigt ihr Onboarding Budget.

(Bitte teile uns alle rot markierten Daten mit und stelle sicher, dass alle erwähnten Schritte geprüft wurden.)

  1. Bitte sorgt dafür, dass vor der Einrichtung alle Arbeitsabläufe mit ihren Status angelegt sind. Bedeutet: jeder Vorgangstyp muss im HQ im Bereich Admin / Standardwerte / Aufgabentypen angelegt werden.

    Unter jedem Vorgangstyp bzw. Aufgabentyp müssen die Status der Vorgänge angelegt werden. Sollten es bei euch sehr viele Werte sein, so dass ihr die Aufgabe lieber an uns abgeben möchtet, sprecht uns gerne darauf an.

  2. Bei neuen Jira Systemen läuft die Synchronisierung der “Reporter” über die E-Mail-Adressen der Benutzer. Stellt bitte sicher, dass in Jira und im HQ bei den Benutzern die gleichen E-Mail Adressen hinterlegt sind. Im HQ muss diese am Benutzer als "E-Mail Adresse Arbeit" hinterlegt sein. Ihr benötigt für alle Reporter Lizenzen, wenn ihr die Zeiten im HQ abrechnen oder controllen wollt.
    Bei alten/ lokalen Jira Installationen läuft die Zuordnung der “Reporter” über den Benutzernamen. Teilt uns in diesem Falle bitte eure Jira Benutzernamen mit, damit wir diese für euch in der Datenbank hinterlegen. Die klassischen Benutzernamen “Vorname.Nachname”, welche automatisch vergeben werden, können dann nicht mehr benutzt werden.

  3. Klicke in den Jira Einstellungen unter “Vorgänge” nun in der linken Leiste auf "Bildschirmmasken". Danach gehst du rechts bei "Default Screen" auf "konfigurieren". Dort musst du dann die folgenden Felder aktivieren:

    • Summary
    • Description
    • Assignee
    • Time Tracking
    • Due Date
    • Reporter

  4. Kontrolliere, dass das Setting "Sichtbarkeit der Benutzer-E-Mail" in JIRA aktiviert ist und nicht auf "ausgeblendet" steht. (Unter "Jira-Einstellungen" / "Allgemeine Konfiguration")

  5. Bitte teilt uns in jedem Fall alle Status noch einmal mit. Wir müssen diese bei uns an einer weiteren Stelle für die Synchronisierung hinterlegen. Bitte gebt an, welche Status sich in welchem Fortschritt befinden. Es gibt die drei Fortschritte 0%, 50% und 100%. Schickt uns gerne eine Excel Datei mit einer Spalte für die Status und einer Spalte für den Fortschritt (0,50 oder 100).

  6. Wisst ihr schon, ob ihr die Jira führend, HQ führende oder beide Varianten testen/ integrieren möchtet?

  7. Sollen Subtasks übertragen werden? Ja/ nein (siehe Hilfeartikel “HQ führend”)
    (nur möglich, wenn ausschließlich HQ führend)


  8. Sollen die Jira Assignments/ Bearbeiter übertragen werden? Ja/ nein

  9. Sollen Worklogs/ Reportings dauerhaft (alle 15 min.) oder erst bei Abschluss des Vorgangs übertragen werden?

  10. Welches Berechtigungsmodell möchtet ihr nutzen, BasicAuth oder OAuth?
    Wir empfehlen die Einrichtung von BasicAuth, um besseren Support leisten zu können.
    Bei OAuth muss jeder Nutzer sein Konto selbst verknüpfen. Es kann zu Problemen kommen, wenn Nutzer dies nicht tun. Aufgrund der Problematik empfehlen wir BasicAuth zu nutzen.

    Für Basic Auth - Teilt uns bitte weitere Daten mit.
    (Solltet ihr OAuth einrichten wollen, schaue bitte hier.)

    10.1  URL eurer Jira Installation mit.

    10.2 Token (generierst du hier: Zum Token (funktioniert nur wenn du in dein Jira eingeloggt bist).)

    10.3 E-Mail Adresse eines JIRA-Benutzers mit Lese- und Schreibrechten (bspw. HQ@) für alle Projekte, die synchronisiert werden sollen sowie das Passwort. Wir nutzen dieses Konto für die Synchronisierung sowie zur Einrichtung und um euch dauerhaft Support bieten zu können.

 

Bitte teile uns alle rot markierten Daten mit und stelle sicher, dass alle oben erwähnten Schritte geprüft wurden.

Wie richte ich die Jira Schnittstelle ein? (OAuth)

 

Wenn du als Authentifizierungsmethode in deinem JIRA OAuth nutzen möchtest, müssen zusätzlich zu den Schritten 1. bis 9. aus dem Artikel "Wie richte ich die Jira Schnittstelle ein?" außerdem die folgenden Steps durchgeführt werden. Danach kann jeder Nutzer in deinem HQ seinen eigenen JIRA-Account nutzen, um Tickets etc. zu synchronisieren.

 

Application Link hinzufügen

Zunächst müsst du in deinem JIRA einen Application Link hinzufügen. Dazu gehst du in den Adminbereich in JIRA und gehst dann links auf den Reiter "Application Links" unter Integrations.

Hostname hinterlegen

Anschließend musst du den Hostnamen des Systems eingeben, also die URL deines HQs, bestehend aus: deineFirma.hqlabs.de, und dann auf "Create new link" klicken. Im nächsten Fenster bitte die Warnung ignorieren und auf "Continue" klicken.

Im nächsten Fenster gibst du unter "Application Name" "HQSB" ein und klickst auf "Continue". Danach musst du dann im neuen Fenster unter "Incoming Authentication" einen beliebigen "Consumer Key", z.B. hqsb, festlegen und uns diesen mitteilen.

Zudem musst du noch die Felder "Consumer Name" und "Description" ausfüllen. Den Public Key schicken wir dir dann zu, sobald wir von dir den Consumer Key bekommen haben.

Alle User müssen sich ihre Accounts anschließend verknüpfen (nachdem HQ euch alle eingerichtet hat) - Hilfeartikel verlinken

Häufige Fehler bei der Jira Synchronisation

Bei der Synchronisation kann es dazu kommen, dass ab und an etwas nicht ganz rund läuft, da ein Wert falsch eingerichtet wurde. Für die häufigsten Fehler zeigen wir die entsprechende Meldung in den Systembenachrichtigungen an. Diese findest du unter dem “Briefumschlag” Symbol im Header deines HQs. Für diese Fälle und einige Fälle ohne Meldung findest du hier die bekanntesten Fehlermeldungen, ihre Ursachen und Lösungen.

Es gibt eine Fehlermeldung:

1.) Dem Standardbearbeiter, dem dieser Vorgang zugewiesen wurde, kann dieser Vorgang NICHT ZUGEWIESEN werden ODER nicht zugewiesene Vorgänge sind abgeschaltet.

Der Bearbeiter des Vorgangs ist standardmäßig auf "Automatisch" gesetzt. Dies funktioniert allerdings mit der Schnittstelle nicht. Außerdem ist der Autor beim Erstellen eines Vorgangs nicht bearbeitbar und deshalb kommt es auch zu dieser Fehlermeldung. In einem Projekt kann ein Standardbearbeiter besetzt werden z.B auf den Projektleiter.

 

2.) {"errorMessages":[],"errors":{"timetracking":"Nach der Arbeitsbeginn wird die Einstellung der Ursprünglichen Schätzung im Vorgängermodus nicht unterstützt."}}

Das Problem das die Tickets nicht korrekt synchronisiert werden liegt wahrscheinlich daran, dass du im Jira den Legacy-Modus für die Zeiterfassung aktiviert hast: https://community.atlassian.com/t5/Jira-questions/How-can-I-update-Original-Estimate-after-work-has-been-logged/qaq-p/120560 

Um diesen zu deaktivieren musst du in die Einstellungen -> Vorgänge -> Zeitverfolgung gehen, Globale Einstellungen bearbeiten und den Modus deaktivieren. Danach sollte der Sync funktionieren.

 

3.) Das Jira-Kürzel verschwindet direkt nach dem Eintragen für eine Aufgabe wieder aus dem Projektplan im HQ und es wird kein Ticket in Jira erstellt.

Es existiert entweder kein Projekt in Jira oder der Sync-Nutzer hat keine ausreichenden Berechtigungen für dieses. Beides sollte geprüft und folglich angepasst werden, damit der Sync funktioniert.

 

4.) {"errorMessages":["Der Wert '' existiert nicht für das Feld 'project'.

Es existiert entweder kein Projekt in Jira oder der Sync-Nutzer hat keine ausreichenden Berechtigungen für dieses. Beides sollte geprüft und folglich angepasst werden, damit der Sync funktioniert.

 

5.) Das JIRA-Kürzel ist im HQ-Projekt hinterlegt und der User richtig angegeben, trotzdem werden Tickets nicht aus Jira gezogen.

Tickets werden erst als Task gezogen, wenn sie nach dem Verlinken des Jira-Projektes über das Kürzel einmal aktualisiert wurden (bearbeitet). Man kann alle Tickets eines Projektes in Jira über eine Mehrfachänderung aktualisieren. Dafür lässt man sich alle Vorgänge anzeigen und wählt dann über Tools die zu bearbeitenden aus.

 

6.) {"description":"Field 'description' cannot be set. It is not on the appropriate screen, or unknown."}}

Der Account des HQ Users ist nicht im Projekt eingetragen oder nicht berechtigt. Du kannst ihn bei den Personen hinzufügen und seine Projektrolle über die Berechtigungen ermächtigen, Projekte zu durchsuchen und zu verwalten.

 

7.) Index was out of range. Must be non-negative and less than the size of the collection.

Projekt-Metadaten können nicht übertragen werden, zum Beispiel weil der Sync-User zwar Zugriff auf das Ticket, aber nicht auf das Projekt in JIRA hat.
Oder im Projektplan sind falsche JIRA Vorgangsnummern hinterlegt.

Der Sync funktioniert nicht, es gibt KEINE Fehlermeldungen:

Bitte prüfe folgende Stellen:

1.) (Im HQ Menü) Benutzer / Übersicht / Benutzer auswählen

Sobald der Benutzer erkannt und gesynct wurde, erstellt das HQ ein Datenfeld "JIRA Account Id" am Benutzer. Findet ihr dort keine Id, hat der Sync für den Nutzer noch nicht funktioniert. Teilt uns dies bitte mit. Bitte prüft vorher noch einmal, ob ihr alles aus diesem Artikel beachtet habt. (Wie richte ich die Jira Schnittstelle ein? (Checkliste zur Einrichtung))
 

Falls dir eine Fehlermeldung angezeigt wird, die hier nicht aufgeführt ist, melde dich gerne bei unserem Support.