Zum Hauptinhalt springen
Version: 2024.3.0

Connector Topix

Generelle Informationen

DocBee bietet einen Connector für Topix an. Dieser Connector wird bei Ihnen installiert und greift auf die Topix Datenbank zu und synchronisiert die Daten mit Ihrem DocBee.

Wichtig: Falls Sie den Topix Connector benötigen, wenden Sie sich bitte an Ihren DocBee Support.

Umfang

Der Topix Connector hat folgenden Umfang:

  • Undirektionale Synchronisation von Stammdaten ( Kunden, Standorte, Kontakte ) aus Topix

Installation

Der DocBee Topix Connector ist eine Java Anwendung, die als normale Anwendung wie auch als Windows-Dienst oder UNIX-Daemon laufen kann. Um den Connector zu installieren und um ihn auszuführen, wird eine Java Runtime auf dem System benötigt.

Hinweis: Zum Ausführen der Installations-Routine und zum späteren Ausführen des Connectors wird aktuell Java 1.8 empfohlen.

GUI

Der DocBee Topix Connector kann über einen Installer installiert werden. Dafür klicken Sie doppelt auf die docbee-topix-connector-installer.jar.

Dies startet eine Installations-Routine und installiert die benötigten Daten.

Hinweis: Es kann je nach Betriebssystem nötig sein, dass die Installation als Administrator ausgeführt werden muss.

Hinweis: Falls Ihre Datei einen anderen Namen haben sollte, ersetzen Sie bitte docbee-topix-connector-installer.jar durch Ihren Dateinamen.

Windows

Einige Windows Version unterstützen beim Ausführen von Java Anwendungen kein "Ausführen als Administrator". Um die Installation trotzdem als Administrator auszuführen, können Sie eine .bat-Datei erzeugen mit folgendem Inhalt:

start %~dp0docbee-topix-connector-installer.jar

Hinweis: Falls Ihre Datei einen anderen Namen haben sollte, ersetzen Sie bitte docbee-topix-connector-installer.jar durch Ihren Dateinamen.

Diese .bat-Datei können Sie dann als Administrator ausführen.

Command Line

Sie können den DocBee Topix Connector auch über die Kommandozeile installieren. Dafür führen Sie bitte folgenden Befehl aus:

java -jar docbee-topix-connector-installer.jar -console

Dies startet eine Installations-Routine und installiert die benötigten Daten.

Hinweis: Es kann je nach Betriebssystem nötig sein, dass die Installation als Administrator ausgeführt werden muss.

Hinweis: Falls Ihre Datei einen anderen Namen haben sollt, ersetzen Sie bitte docbee-topix-connector-installer.jar durch Ihren Dateinamen.

Konfiguration

Bevor Sie den Connector starten, müssen Sie noch Ihre Konfiguration einstellen.

Dafür gehen Sie ins Installationsverzeichnis und öffnen die settings.xml in einem Texteditor Ihrer Wahl.

Einstellungen

Generell

drone\task\repeatInterval

Definiert den Intervall in Minuten, wie häufig der Connector die Daten synchronisieren soll.

Wichtig: Ein Intervall kleiner als 5 Minuten ist aktuell nicht erlaubt.

drone\config\path

Definiert den Pfad zur SQLite Datenbank des Connectors. Falls die SQLite Datenbank Datei nicht existiert, wird diese angelegt.

DocBee

drone\docbee\resturl

Die URL zur REST API Ihres DocBees ( z.B. https://my.docbee.com/restApi/ )

drone\docbee\username

Username des DocBee Benutzers inklusive Kurzbezeichnung ( z.B. BEISPIEL/username )

Wichtig: Der verwendete Benutzer muss mindestens die Rechte haben, Stammdaten anzulegen.

drone\docbee\password

Passwort des DocBee Benutzers.

drone\docbee\baseurl Die Basis URL zu Ihrem DOcBee ( z.B. https://my.docbee.com/ )

Topix

drone\topix\version

Die Topix Version z.B. 94 für Version 9.4

drone\topix\wsdl

Die SOAP WSDL Adresse des Topix Server. Normalweise ist es die Adresse vom Topix-Server in folgendem Format http://<IP_ADRESSE>:8081/4DWSDL/DOC.

drone\topix\soap

Die SOAP Adresse des Topix Server. Normalweise ist es die Adresse vom Topix-Server in folgendem Format http://<IP_ADRESSE>:8081/4DSOAP/DOC.

drone\topix\username

Der Benutzer, der auf die SOAP Schnittstelle zugreifen darf. In der Regel ist es +Administrator+

drone\topix\password

Das Passwort des SOAP Benutzers.

drone\topix\mandant

Die verwendete Mandant-ID aus Topix.

drone\topix\customer

Eine Liste von Kunden-Status, die in Topix im Freitext6 Feld gepflegt werden. Diese Kunden-Status müssen auch in DocBee existieren und Groß-/Kleinschreibung wird beachtet.

Beispiel:

<customer>
<status>Aktiv</status>
<status>Inaktiv</status>
</customertypes>

Wichtig: Es werden nur Firmen aus Topix importiert, die im Freitext6 einen Status-Wert definiert haben.

Unix-Daemon (optional)

Falls Sie den Connector auf Unix System als Daemon installieren wollen, führen Sie bitte folgende Schritte aus:

  1. Gehen Sie ins Installationsverzeichnis
  2. Führen Sie yasjsw/bin/installDaemon.sh aus

Windows Dienst (optional)

Falls Sie den Connector auf Windows System als Dienst installieren wollen, führen Sie bitte folgende Schritte aus:

  1. Öffnen Sie eine Eingabeaufforderung und führen diese als Administrator aus
  2. Gehen Sie ins Installationsverzeichnis ( z.B. cd C:\DocBee\TopixConnector\)
  3. Führen Sie den Befehl installService.bat aus

DocBee Einstellungen

Damit der Connector ordnungsgemäß funktioniert, müssen in DocBee folgende Einstellungen vorgenommen werden:

  1. Unter Administration -> Anbindung -> Custom ERP hinterlegen Sie bitte die topix_config.json und aktivieren Sie Custom ERP (Falls dies bei Ihne nicht zur Verfügung steht wenden Sie sich bitte an Ihren DocBee Support)
  2. Hinterlegen der zusätzlichen Kunden-Status, die ebenfalls aus Topix übernomen werden sollen.

Ausführen

Nachdem Sie den DocBee Topix Connector installiert und konfiguriert haben können Sie Ihn nun starten.

Sie können Ihnen entweder manuell starten, indem Sie im Installationsverzeichnis auf die docbee-connector.jar klicken oder ihn per Kommandozeilen-Befehl starten ( java -jar docbee-connector.jar)

Hinweis: Es kann je nach Betriebssystem nötig sein, dass der Connector als Administrator gestartet wird.

Windows Dienst (optional)

Um den Connector als Windows Dienst zu starten, können Sie im Installationsverzeichnis die startService.bat ausführen oder ihn unter Dienste in Windows aktivieren.

Unix-Daemon (optional)

Um den Connnector als Daemon zu starten, führen Sie im Installationsverzeichnis den Befehl yajsw\bin\startDaemon.sh aus oder verwenden Sie service docbee-topix-connector start