19 Jira Issue Collector

Dokumentation zu Issue Collector

Der Jira Issue Collector ermöglicht es, externe Webseiten mit einem Formular zur direkten Ticket-Erstellung in Jira auszustatten. Diese Funktion richtet sich typischerweise an Szenarien wie Supportseiten, interne Tools oder öffentliche Feedbackformulare, bei denen Benutzer ohne Jira-Zugang Tickets eröffnen können.

19.1 Funktionsweise

Ein Issue Collector ist ein in HTML eingebettetes JavaScript-Snippet, das über die Projektkonfiguration in Jira generiert wird. Wird dieses Snippet in eine Webseite eingefügt, erscheint je nach Konfiguration ein Button oder direkt ein Formular-Overlay zur Erfassung eines Jira-Issues.

Das resultierende Ticket wird im Namen eines sogenannten Proxy-Nutzers in einem vordefinierten Projekt und mit festgelegtem Issue-Typ erstellt. Die Konfiguration erlaubt es, Formularfelder wie „Zusammenfassung“ und „Beschreibung“ freizugeben, mit Default-Werten zu belegen oder ganz auszublenden.

19.2 Voraussetzungen

Das Jira-Projekt muss vom Unternehmen verwaltet sein (Company-managed project).
Der Benutzer benötigt Projektadministratorrechte, um den Issue Collector einrichten zu können.
Die Jira-Instanz muss das Feature Issue Collector systemweit aktiviert haben.
Der Issue Collector steht nicht in teamverwalteten Projekten (Team-managed projects) zur Verfügung.

19.3 Konfiguration

Die Konfiguration erfolgt innerhalb eines Jira-Projekts:

Öffnen des gewünschten Projekts
Navigation zu Projekteinstellungen → Vorgänge → Issue Collector
Klick auf Neuen Collector erstellen
Festlegen folgender Parameter:
- Name des Collectors (zur internen Unterscheidung)
- Issue-Typ (z. B. Bug, Task, Service Request)
- Felder im Formular (z. B. Zusammenfassung, Beschreibung, optional auch benutzerdefinierte Felder)
- Standardwerte für Felder (z. B. Komponente, Priorität)
- Design des Widgets (Button-Text, Stil, Platzierung)
- Verhalten bei erfolgreichem Absenden (z. B. Dankesnachricht)
Nach dem Speichern wird ein HTML/JavaScript-Snippet angezeigt

Das Snippet enthält einen <script>-Tag mit einem src-Attribut, das auf die Jira-Instanz zeigt, sowie eine Instanziierung des Collectors mit Konfigurationsparametern im JavaScript-Block.

Beispiel (gekürzt):

<script type="text/javascript" src="https://jira.example.com/s/12345/abc/_/download/resources/.../issuecollector.js"></script>
<script type="text/javascript">
  window.ATL_JQ_PAGE_PROPS = {
    triggerFunction: function(showCollectorDialog) {
      // Button-Click: Issue-Formular anzeigen
      document.getElementById("feedback-button").addEventListener("click", function(e) {
        e.preventDefault();
        showCollectorDialog();
      });
    },
    fieldValues: {
      summary: "Vordefinierter Betreff",
      description: "Vordefinierte Beschreibung"
    }
  };
</script>

19.4 Einbettung in eine Webseite

Das Snippet wird üblicherweise im <body>-Abschnitt der Zielseite eingebettet, vorzugsweise vor </body>.
Ein zugehöriger Button kann frei gestaltet werden, z. B.:

<a href="#" id="feedback-button">Feedback senden</a>

19.5 Hinweise zur Verwendung

Der Collector funktioniert vollständig clientseitig und benötigt keine Authentifizierung des Endnutzers.
Die erstellten Issues erscheinen im Namen eines festgelegten Jira-Benutzers (der sogenannte „Reporter“).
Es empfiehlt sich, das Formular bewusst schlank zu halten und auf Pflichtfelder außerhalb von „Zusammenfassung“ und „Beschreibung“ zu verzichten.
In produktiven Umgebungen sollte das Snippet nur über HTTPS ausgeliefert werden.

19.6 Sicherheit und Datenschutz

Jegliche im Formular eingegebenen Inhalte landen ungefiltert in Jira. Entsprechende Hinweise zur Dateneingabe sollten im Formular ergänzt werden.
Sensible Felder (z. B. Kundendaten, E-Mail-Adressen) sollten DSGVO-konform verarbeitet werden.
Die Verwendung des Issue Collectors sollte dokumentiert und mit der internen Datenschutzstelle abgestimmt sein.

19.7 Einsatzszenarien

Support-Portale: Endnutzer können Probleme oder Anfragen direkt melden.
Fehlerreporting in Webanwendungen: Z. B. „Fehler melden“-Button in internen Tools.
Intranet-Formulare: Rückmeldung zur IT-Infrastruktur oder Verbesserungsvorschläge.

19.8 Einschränkungen

Keine Benutzer-Authentifizierung auf Jira-Seite → keine Zuweisung an echte Benutzerkonten
Keine vollständige Formularvalidierung möglich
Nur eingeschränkte Individualisierung der Formularstruktur
Keine Unterstützung in Team-managed Projekten