Liefert Informationen zur Einrichtung aller Schnittstellen und Integrationen, die in TRASER DMS 365 verwendet werden.

Schnittstellen und Integrationen

Hinweis

Die Schnittstellen und Integrationen werden laufend weiterentwickelt. Die vorliegende Dokumentation beschreibt ggf. nicht die neuesten Funktionen bzw. ist ggf. unvollständig, da die Entwicklung noch nicht abgeschlossen ist. Die neuesten Informationen finden Sie in den Release Notes.

In TRASER DMS 365 funktioniert die Einrichtung von Schnittstellen weitgehend automatisch, d. h. wenn die Seite Schnittstellenliste über die Suche (ALT+Q) geöffnet wird, werden die Basiswerte Schnittstellenart, Beschreibung, Anbietercode, Gruppencode und alle möglichen Parameter automatisch initialisiert, einschließlich aller ihrer Abhängigkeiten (mit Ausnahme der händlerspezifischen Parameter). Dies gilt für alle neuen Mandanten.

Dieses Kapitel beinhaltet die folgenden Unterabschnitte:

Inforegister 'Allgemein'

Das Inforegister Allgemein enthält die grundlegenden Informationen zur Schnittstelle. Die Werte werden automatisch eingerichtet. Die schreibgeschützten Felder Anbietercode und Gruppencode werden verwendet, um einen bestimmten Hersteller oder Partner sowie einen Bereich (z. B. Trade, Service) zu definieren, um die Liste für eine bessere Übersicht filtern zu können. Die Werte im Feld Anbietercode werden der Tabelle Schnittstellenanbieter entnommen, die bei der Initialisierung der Schnittstelle automatisch befüllt wird.

Der Schieberegler Schnittstellenprotokoll kann vom Händler manuell aktiviert werden, um alle Schnittstellenaktivitäten zu protokollieren und über die Schaltfläche Protokoll in der Menüleiste auf weitere Prozess- oder Import-/Exportdatei-Informationen zuzugreifen. Entsprechende Anweisungen sind in der jeweiligen Schnittstellendokumentation beschrieben.

Tipp

Es wird empfohlen, den Wert Protokolleinträge löschen nach ebenfalls zu verwenden, wenn der Schieberegler Schnittstellenprotokoll aktiviert ist, um alte Schnittstellenaktivitäten regelmäßig zu löschen.
Verwenden Sie diese Option mit Bedacht und unter Beachtung Ihrer Aufbewahrungspflichten!

Inforegister 'Autorisierung'

Das Inforegister Autorisierung wird verwendet, um die Autorisierungsoptionen zu definieren, die von der Schnittstelle oder Integration benötigt werden, um sich gegenüber dem Dienst außerhalb von TRASER DMS 365 zu authentifizieren.

Das Inforegister Autorisierung zeigt Felder kontextabhängig an:

  • wenn Autorisierungsart = leer, werden keine weiteren Felder angezeigt
  • wenn Autorisierungsart = Basis, wird nur das Feld Autorisierungscode angezeigt
  • wenn Autorisierungsart = OAuth2, werden die Felder Autorisierungscode und Bereich angezeigt
    • Das Feld Bereich dient der Definition der schnittstellenspezifischen Zugriffsparameter. Diese werden bei der Initialisierung automatisch eingerichtet.

Inforegister 'Parameter'

Parameter werden verwendet, um bestimmte Optionen für die Verwendung der Schnittstelle einzurichten. Dazu gehören bspw. spezifische Definitionen für Import- oder Exportdateien, händlerspezifische Konten oder Ressourcen, URLs, Währungs- oder Sprachcodes, Standardwerte, usw. Das Feld Anweisungen enthält entsprechende Hinweise zum Ausfüllen des Felds Wert.

Viele Felder Wert im Inforegister Parameter unterstützen die Suchfunktion, sodass gültige Werte direkt ausgewählt werden können. Andere Felder erfordern Texteingaben oder Zahlen, die in der entsprechenden Dokumentation der Schnittstelle oder in den Anweisungen beschrieben sind.

Die Farbcodierung im Inforegister Parameter hat die folgende Bedeutung:

  • rote Schrift = notwendiger händlerspezifischer Parameter hat noch keinen Wert; Schnittstelle kann nicht voll funktionsfähig sein
  • grüne Schrift = notwendiger händlerspezifischer Parameter hat einen Wert
  • schwarze Schrift = optionaler Parameter; ggf. erforderlich für Komfortfunktionen, d. h., wenn ein Wert ausgefüllt wird, kann die unter Anweisungen beschriebene Funktion verwendet werden

Inforegister 'Zuordnungseinrichtung'

Die Zuordnungseinrichtung zeigt verschiedene Objekte, die zunächst mit Werten gefüllt werden müssen, damit die Schnittstelle überhaupt Daten verarbeiten kann. Normalerweise gilt dies nur für händlerspezifische Objekte wie Ressourcen, Artikel usw. Für Werte im Inforegister Parameter ist in den meisten Fällen eine vollständige Zuordnungseinrichtung erforderlich, um die Suchfunktion über die drei Punkte nutzen zu können.

Um ein Objekt mit den erforderlichen Daten zu befüllen, gehen Sie bitte wie folgt vor:

  • Klicken Sie auf den Objektnamen in der Spalte Name , um die entsprechende Tabelle zu öffnen.
  • Fügen Sie neue Zeilen für alle erforderlichen Werte hinzu und befüllen Sie diese.

Warnung

Je nach Umfang der hinzuzufügenden Daten kann dieser Vorgang einige Zeit in Anspruch nehmen!

  • Schließen Sie die Tabelle und bestätigen Sie das Dialogfeld Möchten Sie die Einrichtung der Schnittstelle für [...] abschließen?, indem Sie auf Ja klicken.
    • Wenn Sie auf Ja klicken, wird das Kontrollkästchen Abgeschlossen automatisch aktiviert, und der Wert Name wechselt von roter in grüne Schrift.
    • Wenn Sie auf Nein klicken, bleibt der Wert Name in roter Schrift, und das Kontrollkästchen Abgeschlossen bleibt deaktiviert. Sie können die Einrichtung später erneut starten, aber die Schnittstelle kann erst aktiviert werden, wenn die Zuordnungs- und Parametereinrichtungen abgeschlossen sind.
  • Wiederholen Sie diese Schritte für alle Objekte, bei denen das Kontrollkästchen Notwendig aktiviert ist. Andernfalls kann die Schnittstelle oder Integration nicht aktiviert werden! Objekte, bei denen das Kontrollkästchen Notwendig deaktiviert ist, sind optional.

Hinweis

Das Inforegister Zuordnungseinrichtung ist nur bei Schnittstellen oder Integrationen verfügbar, wenn es benötigt wird.

Schnittstellen aktivieren

Wenn alle Anforderungen erfüllt sind (nur grüne und/oder schwarze Werte im Inforegister Parameter und/oder nur grüne Werte im Inforegister Zuordnungseinrichtung), klicken Sie in der Menüleiste auf die Schaltfläche Schnittstelle aktivieren. Der Schieberegler Allgemein > Aktiv ist aktiviert.

Hinweis

Wenn eine Schnittstelle oder Integration auf einer Aufgabenwarteschlange basiert, wird diese nach erfolgreicher Aktivierung automatisch zur Seite Aufgabenwarteschlangenposten hinzugefügt und wie in der entsprechenden Schnittstellendokumentation beschrieben eingerichtet. In diesem Fall wird ein entsprechender Schnellhinweis unter der Menüleiste angezeigt.

Wenn eine Voraussetzung fehlt, zeigt TRASER DMS 365 ein Dialogfeld mit einer Übersicht über alle notwendigen Parameter oder Zuordnungseinrichtungen an, die noch keinen Wert haben.

Wenn Sie die erforderlichen Werte hinzufügen und durch Klicken auf die Schaltfläche OK bestätigen, ist die Schnittstelle aktiviert und funktionsfähig. Wenn Sie die erforderlichen Werte nicht hinzufügen und dies durch Klicken auf die Schaltfläche OK bestätigen, kann die Schnittstelle nicht aktiviert werden.

Tipp

Falls eine Schnittstelle oder Integration nicht mehr wie vorgesehen funktioniert oder es ein Problem mit einem bestimmten Parameter gibt, können Benutzer die Schaltfläche Wiederherstellen > Autorisierung wiederherstellen / Parameter wiederherstellen / Einrichtung wiederherstellen im entsprechenden Inforegister verwenden. Damit werden alle Werte auf die bei der Initialisierung der Schnittstelle eingegebenen Standardwerte zurückgesetzt.

Nachfolgend finden Sie eine Übersicht aller Schnittstellen und Integrationen, die derzeit von TRASER DMS 365 unterstützt werden:

Hinweis

Derzeit werden noch keine Schnittstellen genutzt.