Dokumentation -> Richtige Schreibform?

[josch1985]

Hallo Leute,

leider kann mir keiner in meinem Betrieb bei meiner Doku helfen, darum frage ich jetzt euch.

Ist die Form in der ich die Doku schreibe richtig?

3.3.4. Ticket-Liste

Frontend

Aufgrund der Übersichtlichkeit, wurden die „Suche“, „Filterung“ und „Allgemeinen Optionen“ im oberen Bereich der „Ticket-Liste“ integriert. Zu den Optionen gehört das Anlegen eines neuen Tickets, das Gruppieren und Löschen von Tickets. Unterhalb der Optionen ist die „Ticketliste“. Die Liste enthält die wichtigsten Informationen der Supportanfrage wie z.B. den Absender, Bearbeiter, Status usw. In der Ticketliste können zudem noch die Notiz und die Priorität jedes einzelnen Tickets bearbeitet werden. Über die Pfeilicons, die sich in den Überschriften der Felder „Ticket-Nr“, „Datum“, „Absender“, „Bearbeiter“ und „Status“ befinden, kann die Ticketliste sortiert werden.

Backend

Da in den meisten Fällen nur nach dem Absender oder Betreff gesucht wird, durchsucht die Standardsuche die Felder „Ticket-Nr“, „Absender“ und „Betreff“ eines Tickets. Falls ein EMail-Text durchsucht werden muss, kann zusätzlich die Option „Auch eMail-Text durchsuchen“ per Auswahl hinzugefügt werden. Damit ein bestehendes Suchergebnis auch nach Absenden einer „Post-Anfrage“ z.B. das Löschen eines Tickets, vorhanden ist, wird die „GET-Methode“ zum Versenden der Suchanfrage verwendet. Um die Suchanfrage auf einen bestimmten Bearbeiter oder einen Zeitraum einzugrenzen, ist es möglich, die Suche mit den Filteroptionen „Ticketansicht“ und „Tage“ zu kombinieren. Die Filtereinstellungen werden meist noch benötigt. Darum wird beim Löschen des Suchergebnisses über den „X“ Button in der Suche nur der Suchbegriff entfernt. Das Suchergebnis ist nach Verlassen der Ticketliste uninteressant, die Speicherung der Suchanfrage in der „SESSION“ erfolgt deshalb nicht.

Zur besseren Übersicht kann die Ticketliste über die Pfeilicons, die sich in den Spaltenüberschriften der „Ticket-Nr“, „Datum“, „Absender“, „Bearbeiter“ und „Status“ befinden, sortiert werden. Eine Kombination aus mehreren Feldsortierungen ist nicht nötig, da für die Bearbeitung meist nur nach einem Feld sortiert wird. Die Feldsortierung ist eine wichtige Funktion für das Bearbeiten der Tickets. Deshalb wird die jeweilige Sortierung in der „SESSION“ gespeichert. Somit ist auch nach kurzeitigen Verlassen der Ticketliste die Sortierung vorhanden.

Für interne Tickets kann die Funktion „Neues Ticket“ verwendet werden, durch Anklicken des Buttons „Neues Ticket“, öffnet sich ein Formular in der Mitte der Ticketliste. Um das Verwenden einer Funktion, die sich außerhalb des Formulars befindet, zu verhindern, wird ein halbtransparenter „DIV-Layer“ über die Ticketoptionen und der Ticketliste eingeblendet. Das Formular zum anlegen des Tickets befindet sich nun im Vordergrund. Im Formular können die Werte „Bearbeiter“, „Status“, „Priorität“, „Absender“, „Betreff“ und „Nachricht“ eingefügt werden. Die Felder „Absender“ und „Betreff“ sind Pflichtfelder, da diese wichtig für die Bearbeitung und Übersicht sind. Sobald das Ticket angelegt oder der Vorgang abgebrochen wurde, werden das Formular und der „DIV-Layer“ ausgeblendet.

Es kann vorkommen, dass ein Kunde dem bereits eine Ticket-Nr zugeordnet wurde, eine neue Email verfasst bei der der Betreff keine Ticket-Nr enthält. Die fehlende Ticket-Nr im Betreff hat zur Folge, dass das „TicketSystem“ ein neues Ticket für die Anfrage erstellt. Über die Gruppierungsfunktion können die Tickets zusammengefasst werden. Die ausgewählten Tickets werden in der Gruppierungsfunktion nach Alter sortiert. Das älteste Ticket wird das Hauptticket. Die untergeordneten Tickets erhalten den Status „Gruppiert(5)“. Diese werden in der Ticketliste nicht mehr angezeigt. Um eine Fehlgruppierung rückgängig zu machen, wird in der Datenbank eine Referenz zur Gruppierung gespeichert.

Tickets, die nicht mehr benötigt werden, können über die Löschfunktion entfernt werden. Manche Tickets sind gruppiert. Deshalb wird beim Löschen zunächst kontrolliert, ob eine Ticketreferenz besteht. Sollte eine Referenz existieren, so werden alle Referenztickets mit in den Löschvorgang einbezogen.

Die Notiz- und Prioritätsfunktion innerhalb der Ticketliste ist dazu gedacht dass ein Bearbeiter kein Ticket öffnen muss um eine Notiz zuschreiben oder eine Priorität zusetzen. Durch Anklicken des NotizIcon in der jeweiligen Ticketzeilen wird ein „DIV-Layer“ mit dem entsprechenden Notizformular geöffnet. In diesem Formular kann die Notiz bearbeitet bzw. gelöscht werden. Die Notiz gilt als gelöscht, wenn ein leeres Formular gespeichert wird. Damit beim Speichern die Ticketliste nicht neu geladen werden muss, wird die Speicherung der Notiz mittels Ajax/PHP durchgeführt. Dadurch ist es auch möglich schnell nacheinander die Notizen verschiedener Tickets einzusehen.

Durch Anklicken der ersten Spalte (links), öffnet sich ein „DIV-Layer“ mit der Prioritätsauswahl. Hier hat der Bearbeiter die Möglichkeit, ohne das Ticket zu öffnen, die Priorität zu setzen. Die Priorität kann über das Auswahlfeld gesetzt werden. Nach Anklicken des „OK-Button“, wird die Prioritäts-ID mittels Ajax / PHP gespeichert. Die erste Spalte (links) erhält die Farbe der Priorität. Der folgende Abschnitt zeigt u.a. die Übergabe der Prioritäts-ID an die PHP Datei.

function setPriority(priority){

// Get the current ticket-id

var ticket_id = document.getElementById('ticketId').value;

// Open the setPriority.ajax.inc.php with ticket id and priority

XMLHTTP.open("GET", "./inc/setPriority.ajax.inc.php?ticket_id=" + ticket_id + "&priority=" + priority);

XMLHTTP.onreadystatechange = function(){

if (XMLHTTP.readyState == 4) {

if(XMLHTTP.responseText){

// Close the priority selection

closePriority();

// Set the priority-color for the selected line

document.getElementById(ticket_id).style.backgroundColor = XMLHTTP.responseText;

}else{

alert("Priorität konnte nicht gesetzt werden!");

}

}

}

XMLHTTP.send(null);

}

Danke!

Viele Grüße

Josch