Link Object Connector | OTRS Academy

Inhaltsverzeichnis

OTRS can accept requests from external systems to interact with the link object. The functionality needs to be configured in the Web-Services module of the administrator interface. There are example configurations for both SOAP and REST methods.

So importieren Sie die Konfiguration des Web-Service:

Gehen Sie im Administrator-Interface auf die Ansicht Webservice Verwaltung.
Klicken Sie in der linken Seitenleiste auf die Schaltfläche Web-Service hinzufügen.
Klicken Sie in der linken Seitenleiste auf die Schaltfläche Web-Service importieren.
Select the file development/webservices/GenericLinkConnectorSOAP.yml or development/webservices/GenericLinkConnectorREST.yml within the OTRS home folder.
Klicken Sie auf die Schaltfläche Importieren.

These files contain the complete information to setup the web service. The web service can be customized after the import process, if needed. The result of this process will be the same as the manual procedure explained below, but with some useful comments are added to the operations. The imported web services are ready and able to handle all operations.

Es ist möglich, die Konfiguration manuell einzurichten, wenn Sie nicht die eingebauten Konfigurationsbeispiele verwenden möchten.

Bemerkung

Die folgenden Schritte sind nur erforderlich, wenn die Web-Services nicht wie oben erläutert importiert wurden.

Die folgenden Schritte sind erforderlich, um eine voll funktionsfähige Konfiguration bereitzustellen:

Gehen Sie im Administrator-Interface auf die Ansicht Webservice Verwaltung.
Klicken Sie in der linken Seitenleiste auf die Schaltfläche Web-Service hinzufügen.
Füllen Sie das Formular mit den folgenden Daten aus:
- Name: LinkObjectConnector
- Debug-Schwelle: Debug
- Netzwerk-Transport: HTTP::SOAP
Klicken Sie auf die Schaltfläche Speichern, um die Auswahl Operation hinzufügen und die Schaltfläche Konfigurieren für den Netzwerktransport zu aktivieren.
Klicken Sie auf die Schaltfläche Konfigurieren, um die Transportoptionen anzuzeigen.
Verwenden Sie die folgenden Parameter:
- Namensraum: https://otrs.org/LinkObjectConnector/
- Maximale Nachrichtenlänge: 100000
Klicken Sie auf die Schaltfläche Speichern. Warten Sie, bis die Seite aktualisiert wird, und klicken Sie dann auf die Schaltfläche Zurück zum Web-Service, um fortzufahren.

The Add Operation selection provides seven operations for link:

Link::LinkAdd
Link::LinkDelete
Link::LinkDeleteAll
Link::LinkList
Link::PossibleLinkList
Link::PossibleObjectsLst
Link::PossibleTypesList

Fügen Sie die Operation Link::LinkAdd hinzu und setzen Sie den Namen LinkAdd in der nächsten Ansicht. Es ist keine weitere Konfiguration erforderlich.
Klicken Sie auf die Schaltfläche Speichern. Warten Sie, bis die Seite aktualisiert wird, und klicken Sie dann auf die Schaltfläche Zurück zum Web-Service, um fortzufahren.
Wiederholen Sie Schritt 9 und Schritt 10 für die anderen sechs Link::– Operationen.
Klicken Sie in der Ansicht Web Service bearbeiten auf die Schaltfläche Speichern und Fertigstellen wenn sie alle Operationen hinzugefügt haben.

Now you are on the Web Service Management overview screen and the new web service is ready and able to handle all operations.

Bemerkung

Wenn der neue Web-Service vollständig getestet ist, könnte der Debug-Schwellenwert in Bemerkung geändert werden. Dadurch wird die Datenmenge, die in der Datenbank gehalten wird, reduziert und es werden nur Benachrichtigungen und Fehlermeldungen protokolliert.

Verwendung

Die Funktion „Objekt verknüpfen“ bietet die Möglichkeit, Elemente (z.B. Tickets, ITSM Changes) von Objekten (z.B. Ticket, ITSMChangeManagement) zu verknüpfen, um eine logische Verbindung herzustellen.

Um diese Anfragen leichter lesbar und verständlich zu machen, finden Sie hier einige SOAP-Anfragevorlagen mit den Parametern für jede Operation.

Anfragevorlage `Link::LinkAdd`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
    <SourceObject>?</SourceObject>
    <SourceKey>?</SourceKey>
    <TargetObject>?</TargetObject>
    <TargetKey>?</TargetKey>
    <Type>?</Type>
    <State>?</State>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SourceObject: Objekt, von dem die Verknüpfung ausgeht.
SourceKey: ID des Ursprungsobjekts.
TargetObject: Objekt, auf das die Verknüpfung zeigt.
TargetKey: ID des Zielobjekts.
Type: Art der Verknüpfung.
State: Status der Verknüpfung, normalerweise Valid.

Anfragevorlage `Link::LinkDelete`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
    <Object1>?</Object1>
    <Key1>?</Key1>
    <Object2>?</Object2>
    <Key2>?</Key2>
    <Type>?</Type>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
Object1: Objekt, von dem die Verknüpfung ausgeht.
Key1: ID des Ursprungsobjekts.
Object2: Objekt, auf das die Verknüpfung zeigt.
Key2: ID des Zielobjekts.
Type: Art der Verknüpfung.

Anfragevorlage `Link::LinkDeleteAll`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
    <Object>?</Object>
    <Key>?</Key>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
Object: Objekt, von dem die Verknüpfungen ausgehen.
Key: ID des Ursprungsobjekts.

Anfragevorlage `Link::LinkList`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
    <Object>?</Object>
    <Key>?</Key>
    <Object2>?</Object2>
    <State>?</State>
    <Type>?</Type>
    <Direction>?</Direction>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
Object: Objekt, von dem die Verknüpfungen ausgehen.
Key: ID des Ursprungsobjekts.
Object2: Optionale Einschränkung des Objekts, auf das die Verknüpfungen zeigen.
State: Status der Links, normalerweise Gültig.
Type: Optionale Einschränkung des Verknüpfungstyps.
Direction: Optionale Einschränkung der Verknüpfungsrichtung (Source oder Target).

Anfrageformular `Link::PossibleLinkList`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.

Anfrageformular `Link::PossibleObjectsList`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
    <Object>?</Object>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
Object: Objekt, von dem die Verknüpfungen ausgehen.

Anfrageformular `Link::PossibleTypesList`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
    <Object1>?</Object1>
    <Object2>?</Object2>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
Object1: Objekt, von dem die Verknüpfung ausgeht.
Object2: Objekt, auf das die Verknüpfung zeigt.

Beispiele

Die folgenden Beispiele verwenden alle Objekte und Typen, die in OTRS mit der Standardkonfiguration verfügbar sind. Wenn Sie die Standardkonfigurationen der Verknüpfungen geändert haben, müssen die Beispiele möglicherweise angepasst werden.

Neue Verknüpfung erstellen

In diesem Beispiel wird gezeigt, wie eine Verknüpfung unter Verwendung der Operation Link::LinkAdd des generischen Interface erstellt wird.

Senden Sie die folgende SOAP-Anfrage an das OTRS-System.

<RootElement>
    <UserLogin>johnsmith</UserLogin>
    <Password>Secret123</Password>
    <SourceObject>Ticket</SourceObject>
    <SourceKey>1</SourceKey>
    <TargetObject>Ticket</TargetObject>
    <TargetKey>2</TargetKey>
    <Type>Normal</Type>
    <State>Valid</State>
</RootElement>