Verwenden der Text-API › Text-API › Eingabeformat

Eingabeformat

Die Eingabe in die Text-API geschieht folgendermaßen:

• In der Befehlszeilenschnittstelle wird geschieht die Eingabe typischerweise in einer Textdatei, die an den Befehl "pdm_text_cmd" übergeben wird.
• In der E-Mail-Schnittstelle geschieht die Eingabe im Text der E-Mail. Sie geben einen regulären Ausdruck an, um die Zielobjektkennungen zu suchen.

Sie formatieren die Text-API-Eingabe auf die gleiche Weise unabhängig von der verwendeten Schnittstelle.

Das grundlegende Format für die Eingabe sieht wie folgt aus:

%keyword=value

oder

%PROPERTY={{property_label}}value

Das normale Verhalten von Text-API-Befehlen hat die folgenden Ausnahmen, wobei der zuletzt angezeigte von zwei oder mehreren, in Konflikt stehenden Befehlen Vorrang hat:

• Wenn eine Meldung mehrere gültige Ticket-ID-Artefakte, die mit der Filterzeichenfolge der Postfachregel übereinstimmen, oder mehrere Text-API-Ticket-ID-Befehle enthält, wird die erste Übereinstimmung verwendet. Ebenso überschreibt ein Ticket-ID-Artefakt, das unter Verwendung der Filterzeichenfolge der Postfachregel identifiziert wird, einen beliebigen Text-API-Ticket-ID-Befehl, unabhängig davon, welcher zuerst angezeigt wird.
• Wenn eine Meldung mehrere Protokollkommentar-Text-API-Befehle enthält, werden alle Kommentare bereitgestellt, obwohl die Reihenfolge, in der sie im Ticket-Aktivitätsprotokoll erscheinen, variieren kann.

Alle Ticket-ID-Artefakte, die mit dem Filter übereinstimmen - gültig oder anderweitig - und Text-API-Ticket-ID-Befehle innerhalb der Meldung - anwendbar oder anderweitig, angewandt oder anderweitig - werden auskommentiert, bevor die Meldung bereitgestellt wird. Die Ticket-ID-Artefakte, die durch die Postfachregelfilter identifiziert werden, werden als -((...))- angezeigt. Vorangestellte Prozentzeichen (%) in Text-API-Ticket-ID-Befehlen werden in zwei Klammer-auf-Symbole vor und zwei Klammer-zu-Symbole nach dem Befehl konvertiert. Wenn ein Text-API-Ticket-ID-Befehl nach einem anderen Text-API-Befehl mit einem Protokollkommentar (%LOG=…) erscheint, dann wird der auskommentierte Text-API-Ticket-ID-Befehl zu einem separaten Protokollkommentar.

Hinweis: Der Protokollkommentar ist der einzige Text-API-Befehl, der mehrmals in einer Meldung erscheinen kann und trotzdem bei jedem Vorkommen angewendet wird. Bei allen anderen Befehlen verwendet die Text-API nur den letzten vorkommenden Befehl, da mehrmals vorkommende Befehle zueinander in Konflikt stehen. Mehrere Protokollkommentarbefehle stellen separate Protokollkommentarmeldungen im Ticket bereit; dies geschieht nicht notwendigerweise in einer besonderen Reihenfolge.

Wenn ein Text-API-Ticket-ID-Befehl in der Meldung entweder am Anfang der Meldung oder zwischen zwei anderen Text-API-Befehlen erscheint, wird er zusätzlich in einen Protokollkommentar konvertiert. Wenn der vorherige Befehl ein Protokollkommentar (%LOG=…) oder eine Aktualisierungsbeschreibung (%DESCRIPTION=…) ist, wird er an diesen Befehl angehängt und wird nicht zu einem separaten Protokollkommentar.

Eingehende Meldungen, die als HTML ohne eingeschlossene Klartextversion gesendet werden, geben ihren Meldungstext ab. Wenn die Meldung mit einem beliebigen Postfachregelfilter mit einem leeren Meldungstext übereinstimmt, kann ein Ticket mit einer leeren Beschreibung oder mit dem zitierten Nachrichtenbetreff als Gesamtheit der Ticket-Beschreibung erstellt werden.