+49 (30) 467086-20 service@microtool.de
Produkte » objectiF RPM » Oberfläche und Bedienung » Datenaustausch mit Fremdsystemen » Jira – Anforderungen importieren und exportieren

Jira – Anforderungen importieren und exportieren

Hinweis

Beachten Sie, dass die Anbindung an Atlassian Jira On-Premise nur bis zur Version 8.22 unterstützt wird. In Versionen, die nach V8.22 veröffentlicht wurden, sind Funktionen, die für den Import und Export benötigt werden, deaktiviert worden. Grund ist die Einstellung der Entwicklung von On-Premise seitens Atlassian Jira im Februar 2022.

objectiF RPM bietet Ihnen eine Schnittstelle zu Atlassian Jira an, über die Sie Issues in ein Projekt importieren oder Anforderungen als Issues wieder nach Jira exportieren können. Dazu legen Sie eine Konfiguration an, um sich mit einem Projekt in Jira verbinden zu können. In einer weiteren Konfiguration definieren Sie, welche Elementtypen übertragen und welche Eigenschaften beachtet werden sollen.

Zusätzlich dazu können Sie in Jira eine benutzerdefinierte Eigenschaft vom Typ Paragraph anlegen, über die beim Exportieren nach Jira ein Hyperlink zu den jeweiligen Elementen gespeichert wird. Benutzer in Jira können diesen Hyperlink verwenden, um über den objectiF RPM Web-Client auf ein Element zuzugreifen. Möchten Sie stattdessen den Link zum Jira Issue in objectiF RPM importieren, definieren Sie auf dem Stereotypen Requirement eine benutzerdefinierte Eigenschaft vom Typ Hyperlink.

Wenn in Jira zu einem Issue sogenannte Link issues oder Child issues existieren, können diese ebenfalls in ein objectiF RPM – Projekt importiert werden. Dabei werden Link issues automatisch übertragen, wenn sie in Jira vorhanden sind. Die Übertragung von Child issues muss im Synchronisationsdialog konfiguriert sein.

In objectiF RPM können Sie für den Zustandswechsel Ereignisse definieren, die nach Abschluss eines Im- bzw. Exports ausgeführt werden.

Existieren in objectiF RPM Anforderungsreferenzen im gleichen Package wie die Anforderung selbst, wird beim Import/ Export die Anforderung beachtet. Liegen die Anforderungsreferenzen in einem anderen Package, dann wird die Anforderung nicht berücksichtigt, auch wenn sie laut Konfiguration übertragen werden soll.

Darüber hinaus kann für die Themenleiste ein Kommando oder im Task Manager jeweils einen Task für den Import bzw. Export definiert werden.

Konfiguration anlegen

Für den Import und Export von Jira-Storys müssen Sie eine Konfiguration anlegen, um sich mit Jira verbinden zu können. Dazu benötigen Sie von Jira die Zugangsdaten (Webadresse, einen Benutzernamen und ein Passwort). Zusätzlich brauchen Sie einen Token, den Sie direkt in Jira generieren.

Hinweis
Beachten Sie, dass der Rechner, auf dem der objectiF RPM Server installiert ist, über eine Internetverbindung verfügt da die Kommunikation zwischen Atlassian Jira und objectiF RPM über den objectiF RPM Server hergestellt wird.
  1. Wechseln Sie innerhalb eines Projekts in das Backstage-Menü und wählen Projekt/ Schnittstellen Konfigurationen.
Aufruf des Backstage-Menüs
  1. In der Sicht Schnittstellen Konfigurationen klicken Sie auf die grüne Plus-Schaltfläche und wählen Konfiguration für Jira anlegen.
  2. Im Folgedialog geben Sie die Verbindungsdaten zum Jira-System an und bestimmen das Package, in das bei einem Import alle Jira-Storys angelegt werden. Wenn Sie exportieren, werden die Elemente, die sich im Package befinden nach Jira übertragen.
    Für den Export kann alternativ auch eine Abfrage angegeben werden. Möchten Sie zusätzlich Dokumente übertragen, die den Jira-Storys zugeordnet sind, geben Sie ein Zielverzeichnis an.
Hinweis zu On-Premise 
Sollen Anhänge bei der Synchronisation berücksichtigt werden, kontrollieren Sie in Ihrem Jira-System, dass in den systemweiten Einstellungen die Option Standardverzeichnis verwenden aktiviert ist.
  1. Klicken Sie anschließend hinter Jira Projekt auf die […]-Schaltfläche und wählen ein Projekt aus.
    objectiF RPM verbindet sich mit dem angegebenen Jira-System und zeigt im folgenden Auswahldialog die Projekte an, auf die Sie zugreifen können.
  2. Markieren Sie ein Projekt und bestätigen mit OK.
Konfigurationsdialog für die Verbindung zu einem Jira-System
  1. Klicken Sie nun auf die Schaltfläche Synchronisation konfigurieren. Sie können auch die Konfiguration speichern und die Einstellungen für die Synchronisation zu einem späteren Zeitpunkt durchführen.

Synchronisation konfigurieren

Damit beim Import/ Export klar ist, was übertragen werden soll, müssen Sie ein Mapping der Elementtypen und Eigenschaften durchführen. Zusätzlich kann hier angegeben werden, ob die Konfiguration für den Import, den Export oder bei beides gilt. Das Mapping können Sie für verschiedene Typen durchführen.

  1. Klicken Sie im Dialog auf die Schaltfläche Synchronisation durchführen. Es öffnet sich ein Dialog, über den Sie einstellen, welche Elementtypen und Eigenschaften beim Export/ Import beachtet werden sollen.
  2. Wählen Sie über das Dropdown-Menü hinter Typ den Jira-Typen aus, den Sie importieren bzw. exportieren möchten.
  3. Darunter geben Sie hinter Stereotyp den Typen an, der verwendet werden soll, wenn neue Elemente nach objectiF RPM importiert und angelegt werden. Bei einem Export werden dann Elemente des angegebenen Stereotyps nach Jira exportiert und erhalten den ausgewählten Jira-Typen.
Hinweis zur Jira-Synchronisation
Beachten Sie, dass beim Übertragen von Texten keine Formatierungen, Tabellen und Bilder berücksichtigt werden. Damit Bilder, Formatierungen oder Tabellen nicht verlorengehen, wird bei einem Export nach Jira die Beschreibung einer objectiF RPM Anforderung zusätzlich als PDF dem Jira Issue angehängt. Wenn die Beschreibung (Description) eines Jira Issues ebenfalls Bilder, Tabellen oder Formatierungen enthält, können diese nur übertragen werden, wenn Sie die Beschreibung in ein PDF exportieren und der Jira-Beschreibung als Anlage hinterlegen.
Typzuweisung im Mappingdialog

Sobald die Zuordnung erfolgt, wird die Auflistung der Eigenschaften aktiviert. Es sind Eigenschaften, die zum ausgewählten Jira-Typen gefunden wurden.

Grüne Zeilen sind bereits gemappt. Das Mapping wurde automatisch für die Eigenschaften Name, Beschreibung, Zustand und Priorität durchgeführt. 

Eigenschaften, die automatisch einander zugeordnet werden, sind grün hinterlegt

Sind Eigenschaften nicht gemappt sind, haben den Wert <Nicht synchronisieren>. Diese Eigenschaften werden später beim Import/ Export nicht berücksichtigt.

  1. Geben Sie die Eigenschaften an, die Sie übertragen möchten. Wenn Sie Eigenschaften vom Datentyp Aufzählung ausgewählt haben, vergessen Sie nicht unter Aufzählungswerte die Werte zuzuordnen. Auch hier gilt: Grüne Zeilen sind bereits gemappt. Das Mapping wird automatisch durchgeführt, wenn in Jira und objectiF RPM die Eigenschaftswerte namentlich identisch sind. 
ausgewähltes Mapping der Werte für die Eigenschaft Priorität
  1. Geben Sie als letztes über die Spalte Synchronisation für die jeweilige Eigenschaft an, ob die Übertragung der Eigenschaften beim Import, Export oder immer beachtet werden soll. Standardmäßig ist Beidseitig eingestellt.
    Möchten Sie weitere Elementtypen übertragen, gehen Sie zum nächsten Abschnitt, bevor Sie den Dialog speichern.
  2. Haben Sie die Konfiguration nur für einen Elementtypen durchgeführt, speichern Sie die Einstellungen über OK.
in Klammern steht der zugeordnete Typ
  1. Wählen Sie unter Typ einen Jira-Typen aus, der noch nicht verwendet wurde.
  2. Gehen Sie auch hier so vor, wie es im vorangegangenen Abschnitt beschrieben ist.
  3. Speichern Sie am Ende Ihre Konfiguration über OK.

Child issues importieren und exportieren

Neben Link issues kann ein Issue auch Child issues haben. Wenn ein solches Issue importiert wird, werden seine Child issues standardmäßig nicht importiert. Sie können aber im Synchronisationsdialog ein Mapping auf Sub-Task durchführen. (Abhängig von der eingestellten Sprache in Jira kann die Schreibweise variieren.)

Mapping des Stereotypen Bug auf Sub-Task

In objectiF RPM werden dann Issue und Child issue als eigenständige Elemente importiert. Sie haben keine Verbindung zueinander und können dementsprechend unabhängig voneinander im- und exportiert werden.

Jira-Storys aus einer Konfiguration importieren/ exportieren

Möchten Sie nun die Jira-Storys importieren bzw. exportieren, wechseln Sie im Projekt ins Backstage-Menü und wählen den Befehl Projekt/ Jira-Projekte synchronisieren. Im Dialog, der sich öffnet, markieren Sie eine Konfiguration und klicken auf Importieren bzw. Exportieren.

Alternativ kann der Import auch über die Sicht Schnittstellen Konfigurationen angestoßen werden. Markieren Sie in der Sicht eine Konfiguration und klicken im Kontextmenü den Befehl Importieren bzw. Exportieren an.

Synchronisationsdialog nach durchgeführter Synchronisation mit Abschlussmeldung

Der Import/ Export schließt immer mit einer Meldung ab.
Über die Schaltfläche Protokoll können Sie einsehen, welche Elemente übertragen wurden und welche nicht.

Jira-Storys aus mehreren Konfigurationen importieren/ exportieren

Möchten Sie den Import für alle Konfigurationen gleichzeitig anstoßen, wechseln Sie im Projekt ins Backstage-Menü und wählen den Befehl Projekt/ Jira-Projekte synchronisieren. Im Dialog, der sich öffnet, markieren Sie alle Konfigurationen an und klicken auf Importieren oder Exportieren.

Projekteinstellungen in Jira öffnen und Klick auf Issue Types
  1. Klicken Sie links auf Issue types (Vorgangstypen) und wählen einen Typen aus, z.B. Epic.
  2. Auf der rechten Seite klicken Sie unter Fields (Felder) auf Paragraph (Absatz).
Klick auf Epic, um eine Eigenschaft vom Typ Paragraph anzulegen
Projekt (Company-managed)
  1. Verbinden Sie sich mit Ihrem Jira-System und öffnen Sie rechts oben die Einstellungen.
Mausklick auf  Einstellungen in Jira
  1. Klicken Sie in den Einstellungen auf Issues (Vorgänge).
Mausklick unter Settings auf Issues
  1. Auf der linken Seite scrollen Sie nach unten bis zum Eintrag Custom fields (Benutzerdefinierte Felder).
  2. Erstellen Sie eine neue Eigenschaft, indem Sie links oben auf Create custom fields (Benutzerdefiniertes Feld erstellen) klicken.
linkes Bild: Mausklick auf Custom fields und rechts Mausklick auf Schaltfläche Create costum field
  1. Wählen Sie im Folgedialog Paragraph (supports rich text) | Absatz (unterstützt Rich Text) aus, indem Sie zuerst auf das Feld und dann auf Next (Weiter) klicken.
Mausklick auf Paragraph
  1. Benennen Sie die Eigenschaft und speichern Sie über Create (Erstellen).
  2. Nach dem Anlegen wechseln Sie auf der linken Seite zu Field configurations (Feldkonfigurationen) und klicken in der Mitte des Bildschirms auf Default Field Configuration.
Mausklick auf Field configurations, um in der Mitte durch einen Klick eine Default field configuration zu erstellen

Die Seite, die sich öffnet, zeigt alle angelegten Eigenschaften an.

  1. Geben Sie über die Suchmaske, die eben erstellte Eigenschaft ein.
  2. Selektieren Sie sie und klicken rechts auf Renderers (Renderer).
Mausklick auf Renderers
  1. Wechseln Sie den eingestellten Typen auf Wiki Style Renderer (Wiki-artiger Renderer) und bestätigen Sie, indem Sie auf Update (Aktualisieren) klicken.
Eigenschaft auf Wiki Renderers umstellen

Sie befinden sich wieder auf der Seite Issues.

  1. Selektieren Sie wieder die Eigenschaft und klicken nun rechts auf Screens (Bildschirmmasken).
Mausklick auf Screens, um zur Eigenschaft objectiF RPM Link einen Screen anzulegen
  1. Geben Sie auf der Folgeseite das Jira-Projekt in die Suchmaske ein.
  2. Markieren Sie es und klicken Update (Aktualisieren).
    Wenn die Eigenschaft angelegt ist, können Sie sie im Synchronisationsdialog mappen.