Zum Inhalt springen

Hilfe:Phorge/URL-Parameter

Aus Wikonia

Einstieg[Bearbeiten | Quelltext bearbeiten]

Diese Seite dokumentiert, wie Tickets in Phorge (Maniphest) über spezielle Links mit vorab befüllten Feldern angelegt werden können. Dies ermöglicht es, z. B. aus dem Wiki heraus „Problem melden“-Links bereitzustellen, die den Ticket-Typ und wesentliche Felder bereits vorbelegen. So können Prozesse zwischen MediaWiki und Phorge effizienter gestaltet werden.

Hinweis: Diese Dokumentation richtet sich an technisch versierte Nutzer, die bereits wissen, was URL-Parameter sind und wie sie funktionieren. Eine Einführung in URL-Parameter oder deren Encoding erfolgt hier nicht.

Übersicht: Wann eignet sich dieses Verfahren?[Bearbeiten | Quelltext bearbeiten]

  • Geeignet für alle Szenarien, bei denen eingeloggte Nutzer innerhalb von Phorge oder aus dem Wiki heraus Tickets erstellen sollen.
  • Nicht geeignet, wenn Nutzer kein Phorge-Konto besitzen oder nicht eingeloggt sind — hier empfiehlt sich die API-Integration (siehe unten).
  • Funktioniert mit allen Feldern, die in Phorge für das jeweilige Formular sichtbar/zugänglich sind (inkl. Custom Fields).

Grundlegende Syntax[Bearbeiten | Quelltext bearbeiten]

Ein neues Ticket kann über folgende URL befüllt werden:

https://phorge.wikonia.net/maniphest/task/edit/form/1/?title=Titel%20des%20Tickets&description=Beschreibung%20hier

Weitere Felder können durch zusätzliche Parameter ergänzt werden.

Feldtypen und ihre Parameter[Bearbeiten | Quelltext bearbeiten]

Standard-Felder
title, description, projects usw. können direkt gesetzt werden.
Custom Fields
Diese werden mit custom.[feldname] angesprochen, z. B. custom.maniphest.custom-field.docs-location=Beispiel
Checkboxen
Mit dem Wert true aktivieren, z. B. custom.maniphest.custom-field.confirmed=true
Select-Felder
Mögliche Werte müssen exakt übernommen werden (i. d. R. aus der Felddefinition oder dem Parameters-Listing). Beispiel: custom.maniphest.custom-field.type=bug

Auswahl des Ticket-Typs über die Form-ID[Bearbeiten | Quelltext bearbeiten]

Jeder Ticket-Subtyp in Phorge wird über eine eigene Formular-ID angesprochen. Die ID ist ein zwingender Bestandteil der URL und steuert, welche Felder und Einstellungen beim Erstellen angezeigt werden. Ein einfacher Parameter wie subtype=bug funktioniert nicht!

Beispiel-URL für „Bug melden“
  https://phorge.wikonia.net/maniphest/task/edit/form/3/

Eine Übersicht der Standard-Formulare:

Formular-ID Typ
1 Task
3 Bug
5 Feature/Expansion-Request
7 Decision *
9 Security
11 Legal/Compliance *
13 Abuse
15 Dokumentation
17 Design
19 Maintenance *
21 Config-Change-Request *

* Für diese Formulare gelten ggf. zusätzliche Berechtigungseinschränkungen beim Anlegen von Tickets.

Die Form-ID muss immer zur gewünschten Ticketausprägung passen. Falsche IDs führen zu Fehlermeldungen oder zur Anzeige des falschen Formulars.

Aktuelle Parameter-Liste anzeigen[Bearbeiten | Quelltext bearbeiten]

Phorge bietet eine stets aktuelle Übersicht aller für ein Ticketformular nutzbaren Parameter unter folgender URL an:

Diese Liste umfasst alle Standard- und Custom-Felder inkl. Syntax und Beispiele (englischsprachig).

Hinweise & Stolperfallen[Bearbeiten | Quelltext bearbeiten]

  • Nutzer müssen in Phorge eingeloggt sein, sonst landen sie zunächst auf der Login-Seite.
  • Bei public-only Tickets kann Phorge blockieren, wenn der Nutzer nach dem Erstellen keine Editierberechtigung mehr hätte — dann ist die API-Integration vorzuziehen.
  • Select-/Checkbox-Parameter müssen exakt dem Parameters-Listing entsprechen.
  • Bei Templates müssen Leserechte auf das Template-Ticket vorhanden sein.

Beispiel-URLs[Bearbeiten | Quelltext bearbeiten]

  • Standard-Ticket mit Titel und Beschreibung:
  https://phorge.wikonia.net/maniphest/task/edit/form/1/?title=Mein%20Ticket&description=Fehlerbeschreibung
  • Feautre-Request mit vorausgewähltem Projekt:
  https://phorge.wikonia.net/maniphest/task/edit/form/5/?title=Wiki%20Problem&projects=development
  • Nutzung eines Template-Tickets:
  https://phorge.wikonia.net/maniphest/task/edit/form/1/?template=T123&title=Neuer%20Vorgang

Template-Tickets nutzen[Bearbeiten | Quelltext bearbeiten]

Phorge unterstützt das Vorbefüllen aller Ticketfelder durch Angabe eines bestehenden Tickets als „Template“:

https://phorge.wikonia.net/maniphest/task/edit/form/1/?template=T123

Alle Felder des Template-Tickets T123 werden als Default gesetzt. Einzelne Felder lassen sich per URL-Parameter gezielt überschreiben, z. B.:

https://phorge.wikonia.net/maniphest/task/edit/form/1/?template=T123&title=Fehlermeldung&projects=ProjektA
Wichtiger Hinweis
Der aufrufende Nutzer muss Leserechte für das Template-Ticket besitzen. Andernfalls erscheint eine Fehlermeldung.

API-Integration: Ausblick[Bearbeiten | Quelltext bearbeiten]

Für alle Fälle, in denen Tickets von außen (z. B. durch Nutzer ohne Phorge-Konto) angelegt werden sollen, empfiehlt sich die Nutzung der Phorge-API. Weitere Hinweise und Beispiele folgen in einem eigenen Kapitel (Phorge-API-Integration).

Siehe auch[Bearbeiten | Quelltext bearbeiten]