Sync konfigurieren

Sync konfigurieren

Um einen neuen Sync zu erstellen, klicken Sie auf New Sync im SyncConfigurator.
 
 
Ein Fenster öffnet sich, indem Sie den Typ des Syncs auswählen müssen.
 
 
Üblicherweise haben Sie hier nur Jira Rest zur Auswahl. Um einen Jira Sync zu erstellen, wählen Sie Jira Rest. Klicken Sie auf Next.
 
 
Tragen Sie die Verbindungsdaten zu Ihrem Jira Server ein. Sie haben verschiedene Optionen, welchen User Sie verwenden. In diesem Beispiel nutzen wir den User 'Jira Sync' welcher für die Synchronisierung zuständig ist.
 
Zu beachten bei Jira Cloud: es muss ein separates Passwort, auch API-Token genannt, erstellt werden, damit der Jira User sich über die REST API für den Sync anmelden kann. Dieses kann man unter der folgenden URL konfigurieren:  https://id.atlassian.com/manage-profile/security/api-tokens
Dieser API-Token muss als Passwort des User eingetragen werden.
 
 
In diesem Beispiel wird nur der Admin-User verwendet. Die Checkbox ist nicht aktiviert. Dies ist auch ein möglicher Weg den Sync zu konfigurieren. Sollten Sie einen Proxy nutzen, tragen Sie die Proxy Informationen unten ein. Klicken Sie auf Test Connection um zu prüfen, ob alles korrekt eingetragen wurde.
 
 
Wird 'Success!' angezeigt, so ist alles korrekt eingetragen und Sie können mit Klick auf Next fortfahren. Wird 'Success' nicht angezeigt, prüfen Sie die Ursachen in diesem Kapitel. 
 
 
Der SyncConfigurator erhält nun alle nötigen Informationen Ihres Jira und aqua Projekts. Klicken Sie Next.
 
 
Wählen Sie welches Projekt und welcher Elementtyp synchronisiert werden soll. Wählen Sie zunächst das Jira Projekt und den Issue Typ. Sie können auch Subtasks synchronisieren. Mehr zum synchronisieren von Subtasks finden Sie hier.

Felder verknüpfen

Sie können wählen, welche Felder aus Jira mit welchen Feldern aus aqua synchronisiert werden sollen. Sie können ebenfalls wählen, in welche Richtung die Felder synchronisiert werden sollen. Sie können nur Felder mit passenden Datentypen verknüpfen. Einige Felder sind schreibgeschützt, beispielsweise der Besitzer in aqua.
 
- JIRA Feld: Die linke Spalte zeigt all die Felder an, die im konfigurierten JIRA-Projekt gefunden wurden. In unserem Fall werden alle Felder vom Projekt "Test Synchronisation (TS)" gefunden. Benutzerdefinierte Felder haben eine benutzerdefinierte Feldnummer neben Ihrem Namen (zum Beispiel: customfield_10010).
- Richtung: Die mittlere Spalte zeigt zwei Synchronisations-Richtungen an. Die Synchronisation zwischen aqua und JIRA oder nur von aqua nach JIRA. Dies setzt die Richtung der synchronisierten Werte.
 
 
- aqua Feld: Diese Spalte zeigt JIRA's Namen für alle gefundenen Felder im konfigurierten aqua Projekt an. In unserem Fall zeigt es alle gefundenen Felder im Projekt "JIRA Sync" an. Zu jeder Zelle gehört eine Auswahlliste. Diese erlaubt es dem Benutzer, das korrekte aqua-Feld und das gewünschte JIRA-Feld anzupassen. Felder, die nicht den gleichen Typ haben (z.B. Datum und Text) werden grau angezeigt. Felder, die schon zugeordnet wurden, werden rot hervorgehoben.
- Auf jeder Seite sichtbar: In dieser Spalte gibt es eine Option, die sicherstellt, dass ein Feld auf JIRA-Seiten immer angezeigt wird (separate Fenster, welche in JIRA auftauchen, z.B. wenn man Issues erstellt oder bearbeitet).
 
 
Die Legende auf der rechten Seite informiert den Benutzer darüber, welche Felder automatisch von JIRA gesetzt werden. Dies passiert, wenn es spezielle Feldtypen gibt (z.B. Felder mit numerischen Werten). Wenn das gleiche aqua-Feld in einem anderen JIRA-Feld benutzt wird, werden beide Zellen rot markiert und eine Fehlermeldung wird angezeigt: "Es gibt mehrere Zuordnungen zum gleichen aqua-Feld".
 
 
Nicht alle Felder müssen verknüpft werden. Manche Felder sind vielleicht nur in einem der beiden Systeme relevant. Die folgenden Felder sind automatisch verknüpft:
  • Beschreibung
  • Kommentare
  • Anhänge
  • Status
 
Wenn Sie Felder vermissen, deaktivieren Sie die Box 'Visible On Any Screen'.
 
 
Bitte beachten Sie, dass individuelle Jira Felder auf dem 'Create Issue Screen' sichtbar sein müssen, damit Sie im Konfigurator angezeigt werden.

Feldwerte verknüpfen

Nachdem die Felder verknüpft sind müssen die Feldwerte aus Auswahlfeldern, wie Status, Priorität und Resolution, verknüpft werden.
 
 
Stellen Sie sicher, dass beide Systeme für jeden bestehenden Wert eine Entsprechung enthalten haben.
 
Normalerweise müssen Sie keine NULL Werte aus aqua verknüpfen. Bitte stellen Sie sicher, dass für alle Auswahlfelder ein Standardwert definiert ist. Außerdem ist es wichtig, Jira NULL Werte mit einem passenden aqua Wert zu verknüpfen. Werte mit ähnlichen Namen werden während der Syncerstellung automatisch verknüpft. Dennoch sollte die Zuordnung immer überprüft werden.
 
Das Feld Resolution wird von Jira gesetzt. Sie benötigen eine Zuordnung für alle Werte aus Jira. Zusätzlich benötigen Sie einen Wert für 'Unresolved'. Wir empfehlen, in aqua einen entsprechenden Wert anzulegen, z.B.: 'Unresolved'. In Jira werden Elemente mit einem NULL Wert in der Resolution ebenfalls als 'Unresolved' angezeigt.
 
Wenn Sie das Sprintfeld synchronisieren, müssen Sie mit der Benennung von Sprints vorsichtig sein. Jira erlaubt doppelte Sprintnamen, aqua nicht. Stellen Sie sicher, dass Sie eindeutige Namen für Sprints in Jira vergeben, da doppelte Namen zu Fehlern führen können.
 
Über die Auswahlbox Automatically map new values during runtime werden neue Auswahlwerte, die in beiden Systemen hinzugefügt wurden, automatisch verknüpft. Bitte nutzen Sie dies mit Vorsicht, da die Namen sehr genau übereinstimmen müssen.
 
Über die Auswahlbox Automatically create new values from Jira in aqua werden neu hinzugefügte Auswahlwerte in Jira während der Laufzeit automatisch auch in aqua erstellt, sofern diese in einem zu syncenden Element ausgewählt wurden. Dies ist insbesondere sinnvoll bei Auswahllisten, die sich häufig ändern, wie z.B. Release, damit Sie diese dann nicht in zwei Systemen pflegen müssen.
 


Der erste Sync

In diesem Kapitel wird beispielhaft ein Sync erstellt und schrittweise beschrieben.
 

Vorbereitung

Erstellen Sie die Projekte und User.
Zunächst erstellen wir das Projekt in aqua, und nennen es 'Our first Jira Sync'.
 
 
Jetzt wechseln wir in die Benutzerverwaltung und erstellen den Nutzer 'Jira Sync'. Bitte nutzen Sie eine spezifische Email Adresse für diesen User, da alle SyncErrors an diese Adresse versendet werden. Wir weisen den User dem Projekt zu mit der Rolle 'Project Administrator' und vergeben die Lizenz 'Jira-Sync (Named)'. Wir deaktivieren alle Benachrichtigungen für diesen User. 
 
 
Nun erstellen wir einen User für den Sync in Jira. Dazu welchseln wir zum User Management und klicken auf 'Create user'. Wählen Sie einen Usernamen und tragen Sie alle benötigten Daten ein. Bitte stellen Sie sicher, dass Sie die gleiche Email Adresse verwenden, wie für den aqua User. Sobald Sie fertig sind, klicken Sie auf die drei Punkte neben dem User um ihn der Gruppe 'jira-administrators' hinzuzufügen.
 
 
Bitte stellen Sie sicher, dass automatic watching, Benachrichtigungen und Captchas für diesen User deaktiviert sind. Um automatic watching zu deaktivieren, loggen Sie sich mit dem User ein und klicken Sie auf sein Foto.Wählen Sie 'Profile'. Hier finden Sie die Einstellungen für autowatch unter preferences. Benachrichtigungen werden auf Projektebene vergeben. Wählen Sie Projekteinstellungen --> Benachrichtigungen. Nutzen Sie ein anderes Schema und wählen Sie "None". Captchas werden in der allgemeinen Konfiguration deaktiviert. Klicken Sie 'Edit Settings' und wählen 'OFF' für 'CAPTCHA on signup'.
 
Wir erstellen ein Projekt in Jira, dessen Elemente zum aqua Projek 'Our first Jira Sync' synchronisiert werden. Wir wählen 'Basic software development'.
 
 
Das nutzt den folgenden workflow.
 
 
Prüfen Sie danach bitte, ob der User dem Projekt zugewiesen ist.
 

Felder & Workflows

Nun erstellen wir einen zu Jira passenden Workflow in  aqua. Dazu wechseln wir zurück nach aqua und öffnen die Projektkonfiguration. Hier löschen wir unnötige Statuswerte für Fehler, sodass die Werte zu Jira passen.
 
 
Zusätzlich fügen wir die Felder 'Jira Link' und 'Jira ID' als Textfelder hinzu. Klicken Sie auf den roten Kreis um die Felder der Vorlage hinzuzufügen. Hier fügen wir auch das Feld 'Resolution' mit den selben Werten wie in Jira hinzu, plus dem Wert 'Unresolved'. Dieses Feld fügen wir nicht zur Vorlage hinzu, da wir hier keine Werte manuell eintragen und das Feld in aqua nicht sehen müssen.
 
 
Wir speichern die Änderungen und wechseln zur Workflow-Konfiguration. Wir wechseln in den Reiter "Fehler" und Klicken auf "Workflow benutzen". Nun zeichnen wir die Pfiele zwischen den möglichen Status, genau wie in Jira.
 
 
Durch den "Hinzufügen" Butten fügen wir Einschränkungen hinzu. Dadurch werden die Felder 'Jira Id' und 'Jira Link' schreibgeschützt.
 
 

Konfiguration

Alle nötigen Schritte wurden vorgenommen, also kann der Sync nun konfiguriert werden. Dafür Loggen wir uns mit unserem persönlichen User im SyncConfigurator ein. Mittels Klick auf 'New Sync' starten wir die Konfiguration. Im ersten Fenster wählen wir 'Jira Rest'. Im zweiten Fenster tragen wir die nötigen Informationen unseres Jira Systems ein.
 
 
Der Sync erhält nun alle nötigen Informationen bezüglich unserer Jira Konfiguration und der verfügbaren aqua Projekte. Wir wählen, welches Projekt und welcher IssueType synchronisiert werden soll.
 
 
Der Sync erkennt die Felder für Jira Id und Jira Link automatisch. Wir können diese noch ändern, tun dies aber nicht, weil der Vorschlag passt.
 
 
Jetzt müssen wir die Felder verknüpfen. Einige Felder werden automatisch erkannt, andere automatisch synchronisiert, aber einige müssen manuell verknüpft werden. Dies kann nun vorgenommen werden.
 
 
Wenn alle Felder so wie gewünscht verknüpft sind, verknüpfen wir die Feldwerte aller Auswahlfelder. Alle Werte in Jira sollten gegen einen Wert in aqua verknüpft. Die werte müssen nicht die gleichen Namen haben.
 
 
Im letzten Fenster definieren wir, in welche Richtung der Sync laufen soll (Jira zu aqua, aqua zu Jira oder beides), und den Sync Intervall.
 
 
Wir haben somit erfolgreich unseren ersten basis Jira Sync erstellt!

    • Related Articles

    • Konfigurieren der Agile-Komponente (Rich Client)

      Um die Agile-Komponente zu konfigurieren, öffnen Sie die Projektkonfiguration. Hier finden Sie das Feld Status für Fehler, Anforderungen, Testfälle, Testszenarien und Skripe, welche Elemente eines Sprints sein können. Es gibt vier Spalten: Werte, ...

    • Checkliste vor Start

      Bitte stellen Sie sicher, dass alle Themen der Checkliste bearbeitet wurden, bevor Sie mit der Synchronisierung beginnen. Administrativer Zugriff auf aqua und Jira wird für das initiale Setup benötigt. Lizenzen Sie erhalten eine spezielle Jira Sync ...

    • Widget bearbeiten

      Fahren Sie mit der Maus über ein Widget. Ein Mouse Over Menü erscheint, mit dessen Hilfe Sie das Diagramm löschen, konfigurieren (bearbeiten), duplizieren, kopieren oder maximieren können.   

    • Integrationen

      Sie können verschiedene Integrationen in aqua für aqua konfigurieren. Damit können Sie zusätzliche Werkzeuge und Funktionalitäten verbinden. Um eine neue Integration zu erstellen, klicken Sie oben links in der aqua Kopfzeile auf das ...

    • Basis Synchronisierung

      Download des SyncConfigurators Sie können den SyncConfigurator von Ihrer Server Landingpage herunterladen. Starten Sie den Download, indem Sie auf den entsprechenden Link auf der Seite klicken. Speichern Sie den Download und führen Sie die .msi Datei ...