Verwenden der Text-API › Text-API › Konvertierungsmethoden

Vorheriges Thema: Aktualisieren von Tickets durch Endbenutzer – Beispiel

Nächstes Thema: Die Konfigurationsdatei

Konvertierungsmethoden

Viele der in "text_api.cfg" definierten Schlüsselwörter enthalten eine zugehörige Methode, um den angegebenen Wert in einen Wert zu konvertieren, der sich für die Speicherung in der Datenbank eignet. Mit dieser Funktion können Benutzer Werte genau wie in der Web-Schnittstelle festlegen. Sie benötigen keinerlei Wissen über die Implementierung, die im Hintergrund läuft.

In der Konfigurationsdatei finden Sie verschiedene Beispiele für diese Art der Schlüsselwort-Definition (z. B. ISSUE.PRIORITY und CONTACT.CONTACT_TYPE). Möchten Sie zusätzliche Schlüsselwörter definieren, beispielsweise weil Sie Text-API-Zugriff auf benutzerdefinierte Felder in Ihrem Datenbankschema einrichten möchten, können Sie eine der folgenden vordefinierten Methoden nutzen:

Methode

Ausgabetyp

lookup_actbool

INTEGER

lookup_asset_by_name

UUID

lookup_asset_by_persid

UUID

lookup_chg_category

STRING

lookup_chg_status

STRING

lookup_cnt_by_email

UUID

lookup_cnt_by_last_first_middle

UUID

lookup_cnt_by_logonid

UUID

lookup_cnt_by_persid

UUID

lookup_cnt_meth

INTEGER

lookup_cnt_type

INTEGER

lookup_company

UUID

lookup_cr_status

STRING

lookup_cr_template

STRING

lookup_domain

INTEGER

lookup_grc

INTEGER

lookup_group

UUID

lookup_impact

INTEGER

lookup_iss_category

STRING

lookup_iss_status

STRING

lookup_loc

UUID

lookup_mfr_model

UUID

lookup_nr_family

INTEGER

lookup_org

UUID

lookup_person_contacting

INTEGER

lookup_position

INTEGER

lookup_priority

INTEGER

lookup_prob_category

STRING

lookup_product

INTEGER

lookup_resource_status

INTEGER

lookup_service_lvl

STRING

lookup_severity

INTEGER

lookup_state

INTEGER

lookup_timezone

STRING

lookup_type_of_contact

INTEGER

lookup_urgency

INTEGER

lookup_workshift

STRING

Wenn der Wert, den Sie konvertieren müssen, nicht durch eine dieser vordefinierten Methoden abgedeckt ist, müssen Sie eine benutzerdefinierte Methode erstellen. Die Methode sollte einen STRING-Wert als Eingabe verwenden und einen Wert (INTEGER, STRING oder UUID) als Ausgabe zurückgeben. Geben Sie den Wert -1 (oder „-1”) zurück, um anzugeben, dass der Wert nicht ermittelt werden kann und somit nicht eingestellt wird. Geben Sie für UUID “( uuid) NULL” zurück.

Zum Beispiel können Sie eine Methode entwerfen, um eine Benutzer-ID in einen ca_contact-Tabellenverweis zu konvertieren. Der eingehende Wert, zum Beispiel "Administrator", wird dann an die Methode übergeben, und die Methode gibt die ca_contact-Tabellen-ID für die Benutzer-ID "Administrator" zurück.

Die Art und Weise, in der Sie Schlüsselwörter in der Konfigurationsdatei definieren, bietet Ihnen den Vorteil, abhängig vom angegebenen Wert mehrere Schlüsselwortzuordnungen für das gleiche Feld zu definieren, einschließlich verschiedener Konvertierungsmethoden. Zum Beispiel kann ein Zuständiger mehrere verschiedene Schlüsselwortzuordnungen haben, die festlegen, wie sein Wert abhängig von den verschiedenen Eingabewerten eingestellt wird. Eine Eingabe könnte die Benutzer-ID, eine andere der Nachname, der Vorname und der zweite Vorname und wiederum eine andere Eingabe könnte die eigentliche ca_contact-ID sein (z. B. 793ED69B4E87A545BD8E911834D829FC). Jedes Schlüsselwort wird einer anderen Konvertierungsmethode zugeordnet, mit Ausnahme des letzten, das nicht konvertiert werden muss.