Schnittstellen und Integrationen

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'
  • Schnittstellenprotokoll
  • Ausführungsmodi
• Inforegister 'Autorisierung'
• Inforegister 'Parameter'
• Inforegister 'Zuordnungseinrichtung'/'Einrichtung'
• Schnittstellen aktivieren

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.

Schnittstellenprotokoll

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.

Ausführungsmodi

Über die Schaltfläche Ausführungsmodus wechseln werden die Schnittstelle und alle ihre Einstellungen zwischen den verschiedenen Test- und Produktivumgebungen, falls verfügbar, umgeschaltet. Nach dem Klicken auf diese Schaltfläche, können Benutzer auswählen, welcher Modus angewendet werden soll. Nach dem Auswählen eines anderen Modus werden die Standardparameter dieses Modus übernommen. Standardmäßig werden die Schnittstellen als Produktiv initialisiert.

Folgende Modi stehen zur Verfügung:

• leer: wird nur angezeigt, wenn keine Modusauswahl verfügbar ist.
• Test: richtet die Testumgebung mit Standardparametern ein, sofern verfügbar.
• Produktiv: richtet die Produktivumgebung mit Standardparametern ein.
• Individuell: wird nur angezeigt, wenn kein gültiger Test- oder Produktivmodus definiert ist.

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.

Das Kontrollkästchen Gesicherter Wert dient zum Einrichten von Parametern, deren tatsächlicher Wert für Benutzer nicht lesbar sein darf. Wenn das Kontrollkästchen aktiviert ist, wird der eingegebene Wert durch Asteriske (*) ersetzt, sodass er nicht eingesehen oder zurückentwickelt werden kann.

Die Farbcodierung im Inforegister Parameter hat die folgende Bedeutung:

• rote Schrift = händlerspezifischer Pflichtparameter hat noch keinen Wert; Schnittstelle ist nicht voll funktionsfähig
• grüne Schrift = händlerspezifischer Pflichtparameter 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'/'Einrichtung'

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 das Auswahlfeld 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.

• 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.

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.

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.

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