JIRA: Pix Email Handler
1. Übersicht
JIRA kann so eingerichtet werden, dass neue Vorgänge durch Emails erzeugt werden, die an ein festgelegtes Email-Konto auf einem POP3 Server verschickt werden.
Die Emails holt JIRA von dem POP3 Emailserver in regelmäßigen Abständen ab und prüft, ob sie dem spezifizierten Format entsprechen. Ist das der Fall, übernimmt JIRA aus der Email die Einträge für einen neuen Vorgang und erzeugt ihn bei ausreichenden Nutzerrechten. Zusätzlich zu den JIRA Systemfeldern können kundenspezifische Felder (custom fields, einfache Datentypen) gesetzt werden.
2. Installation
Installieren Sie die JIRA Version mit dem Modul "Vorgänge aus Email erzeugen" gemäß der Anleitung für Aktualisierungen / Erstinstallationen von JIRA.
3. Konfiguration
Nach der Installation melden Sie sich als Administrator an. Gehen Sie auf die Seite
Administration-Global Settings- Mail Server.
Konfigurieren Sie einen bestehenden, oder erstellen Sie einen neuen Eintrag für POP Mail Server. Geben Sie dazu den Nutzernamen eines Kontos auf dem POP3 Server und das Kennwort ein. Wenn ein Service mit diesem Postfach verbunden wird, schaut JIRA dort nach neuer Post und wertet diese aus.
Wechseln Sie auf die Seite
System- Services
Fügen Sie einen Dienst hinzu oder ändern Sie den bestehenden "POP Dienst".
Falls Sie einen hinzufügen, wählen Sie den Klassennamen
com.atlassian.jira.service.services.pop.PopService
Geben Sie im Feld "delay" an, nach wie vielen Minuten der Dienst erneut ausgeführt werden soll. Wählen Sie beispielsweise '1'.
Auf der folgenden Seite tragen Sie als Handler den Pix Handler ein. Die Parameter sind:
issuetype=6,stripquotes=yes
Als Server wählen Sie den im vorherigen Schritt konfigurierten POP Server, der die Post von dem für die Vorgangserstellung vorgesehenen Konto abholt.
4. Schnelleinstieg
4.1 Voraussetzungen
• Email-Konto für den Empfang von Emails zur Erzeugung von Vorgängen auf einem POP3-Server eingerichtet.
• JIRA konfiguriert:
• Modul Pix Handler "Vorgänge aus Email erstellen" ist vorhanden und als Service eingetragen.
• JIRA kann vom Konto Post abholen: Kontodaten + Kennwort stimmen, Server ist erreichbar.
4.2 Vorgehen
Sie senden Emails von einer Emailadresse aus, zu der in JIRA ein Benutzer existiert. Der Benutzername wird ermittelt, indem die gesamte Emailadresse des Absenders mit den Emailadressen der JIRA Benutzer verglichen wird.
Senden Sie eine Email beliebigen Inhalts an das in JIRA hierfür festgelegte Email-Konto. Sie erhalten in der Antwort eine Anleitung, wie eine Email aufgebaut sein muß, um damit auf dem Server einen Vorgang zu erzeugen.
Senden Sie eine korrekt ausgefüllte Email an das Email-Konto. JIRA legt nun einen neuen Vorgang an. Falls Sie nicht genügend Rechte besitzen (zum Absender muß in JIRA ein Benutzer existieren und die "Vorgang erzeugen" Rechte haben), so erhalten Sie eine Antwort von JIRA mit dem Hinweis, dass Sie nicht über ausreichende Rechte verfügen.
5. Format der Email
Leerzeilen am Anfang der Email werden ignoriert.
Zeilen, die mit '>' beginnen, werden ignoriert.
Mit '@' beginnende Zeilen kennzeichnen JIRA-Felder, die in den Vorgang eingetragen werden sollen. Die Zeichen direkt nach dem '@' bis zum nächsten Leerzeichen geben den Feldnamen an. Die Zeichen vom Leerzeichen hinter dem Gleichheitszeichen ('=') aus bis zum Ende der Zeile (im Beispiel: ) geben den Inhalt des Feldes an, der in den Vorgang übernommen werden soll. Der Feldwert wird vom Feldnamen also durch die Zeichenfolge Leerzeichen Gleichheitszeichen Leerzeichen getrennt.
Beispiele:
@Feldname = Feldinhalt
@Projekt = WS
@Version = V2.0
Beginnt eine Zeile nicht mit einem '@', so wird diese und alle folgenden Zeilen in die Beschreibung des Vorgangs und / oder in den Kommentar übernommen.
Der Betreff der Email (Betreff:) wird in die Kurzbeschreibung des Vorgangs übertragen.
Der Absender (Von:) wird als Ersteller des Vorgangs eingetragen.
Dateianhänge werden als JIRA Anhänge übernommen.
Kundenspezifische Felder (custom fields, einfache Datentypen) können ebenfalls gesetzt werden, z.B.
@customField_123 = xyz
6. Fehlende Felder, falsche Werte
Fehlende Felder werden, wenn möglich, mit Vorgabewerten besetzt.
Kann ein Vorgang aufgrund fehlender oder unzulässiger Werte nicht erstellt werden, so erhält der Absender der Email eine Fehlermeldung.
Falls ein Vorgang erzeugt werden kann, aber aufgrund der Werte Probleme entstehen, wird der Absender der Email mit einer Warnmeldung benachrichtigt. Diese Meldung kann als Vorlage zur Eingabe der korrekten Werte verwendet werden.
Antwortet der Absender der Email auf eine solche Nachricht (Nachmeldung zu einem Vorgang), dann wird der Vorgang mit den durch den Benutzer eingetragenen Werten aktualisiert und der Rest der Nachricht wird als Kommentar hinzugefügt. Dabei darf die Betreffzeile nicht manipuliert werden, da hierüber der Vorgang identifiziert wird, zu dem ein Kommentar erstellt werden soll.
7. Erforderliche und optionale Felder
Erforderliche und optionale Felder
Voraussetzung für die Erzeugung eines Vorgangs ist neben der Benutzerberechtigung das Ausfüllen der erforderlichen Felder (Pflichtfelder) mit Werten, die im Projekt existieren.
Folgende Felder müssen belegt werden, um einen Vorgang zu erzeugen:
@Projekt = WS
@Vorgangsart = Anfrage
@Prio = Prio 4
Der Betreff muß ebenfalls einen nicht leeren Wert aufweisen. Weitere Felder können zusätzlich belegt werden, z.B.
@Komponente = BOI
@Version = V2.0
Groß/Kleinschreibung ist zu berücksichtigen. Der Projektname ist das Kürzel, nicht die ausführliche Schreibweise.
Feldnamen dürfen nur ASCII Zeichen (z.B. keine Umlaute) enthalten.
|
Produkte 
