Connector Standard

Generelle Informationen

DocBee bietet einen Standard Connector an. Dieser Connector wird bei Ihnen installiert und greift auf eine Datenbank zu und synchronisiert periodisch die Daten mit Ihrem DocBee.

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

Umfang

Der Standard Connector hat aktuell folgenden Umfang:

• Unidirektionale Synchronisation ( Datenbank -> DocBee ) von Stammdaten ( Kunden, Standorte, Kontakten und Materialien )
• Erstellen von Leistungen in DocBee
• Exportieren von Abrechnungsdaten aus DocBee

Datenbank-Struktur

Damit der Standard Connector funktioniert, müssen in Ihrer Datenbank folgende Tabellen bzw. Views angelegt werden.

Alle Daten in diesen Views bzw. Tabellen werden in DocBee als jeweiliger Datensatz angelegt bzw. aktualisiert.

Falls ein Datensatz in der Datenbank nicht mehr vorhanden sein sollte, wird dieser in DocBee gelöscht bzw. deaktiviert.

Kunden

Name	Tabelle	View	Optional
docbee_customer	Ja	Ja	Nein

Spalten

Name	Datentyp	NULL erlaubt	Beschreibung
id	Zeichenkette	Nein	Eindeutige ID für einen Kunden-Datensatz. Diese ID kann von Ihnen frei definiert werden und dient dem Connector zum Verknüpfen Ihres Datensatz mit dem späteren DocBee Datensatz. Wir empfehlen für diese Spalte die Verwendung Ihrer Datenbank-ID für Kunden-Datensätze.
name	Zeichenkette	Nein	Der Name des Kunden
customerId	Zeichenkette	Nein	Eindeutige Kundennummer des Kunden-Datensatz
shortName	Zeichenkette	Ja	Kurzbezeichnung des Kunden
wildcardAddress	Zeichenkette	Ja	Wildcard E-Mail-Domain z.B. docbee.com
inhouse	Boolean	Nein	Handelt es sich um einen Inhouse Kunden oder nicht?

Standorte

Name	Tabelle	View	Optional
docbee_location	Ja	Ja	Nein

Spalten

Name	Datentyp	NULL erlaubt	Beschreibung
id	Zeichenkette	Nein	Eindeutige ID für einen Standort-Datensatz. Diese ID kann von Ihnen frei definiert werden und dient dem Connector zum Verknüpfen Ihres Datensatzes mit dem späteren DocBee Datensatz. Wir empfehlen für diese Spalte die Verwendung Ihrer Datenbank-ID für Standort-Datensätze.
customer	Zeichenkette	Nein	Die Kunden-ID aus docbee_customer
name	Zeichenkette	Nein	Der Name des Standorts (Muss innerhalb des Kunden eindeutig sein)
city	Zeichenkette	Nein	Ort des Standorts
street	Zeichenkette	Nein	Straße und Hausnummer des Standorts
zipcode	Zeichenkette	Nein	Postleitzahl des Standorts
isDefault	Boolean	Nein	Ist dies der Hauptstandort des Kunden?

Kontakte

Name	Tabelle	View	Optional
docbee_contact	Ja	Ja	Nein

Spalten

Name	Datentyp	NULL erlaubt	Beschreibung
id	Zeichenkette	Nein	Eindeutige ID für einen Kontakt-Datensatz. Diese ID kann von Ihnen frei definiert werden und dient dem Connector zum Verknüpfen Ihres Datensatz mit dem späteren DocBee Datensatz. Wir empfehlen für diese Spalte die Verwendung Ihrer Datenbank-ID für Kontakt-Datensätze.
customer	Zeichenkette	Nein	Die Kunden-ID aus docbee_customer
customerLocation	Zeichenkette	Ja	Die Standort-ID aus docbee_location . Falls diese gesetzt ist, wird der Kontakt ein Standort-Kontakt, sonst ein Kunden-Kontakt
name	Zeichenkette	Nein	Name des Kontakts
labeling	Zeichenkette	Ja	Bezeichnung z.B. Geschäftsführer
gender	Zeichenkette	Ja	female => Frau male=> Herr NULL => Nicht definiert
email	Zeichenkette	Ja*	E-Mail Adresse des Kontakts
mobile	Zeichenkette	Ja	Mobilnummer des Kontakts
telefax	Zeichenkette	Ja*	Faxnummer des Kontakts
telephone	Zeichenkette	Ja	Telefonnummer des Kontakts
sendEmail	Boolean	Nein	Soll der Leistungsnachweis bei Abschluss automatisch per E-Mail an diesen Kontakt geschickt werden? ( Gilt für alle Leistungen des Kunden )
sendFax	Boolean	Nein	Soll der Leistungsnachweis bei Abschluss automatisch per Fax an diesen Kontakt geschickt werden? ( Gilt für alle Leistungen des Kunden )
sendEmailIfSelected	Boolean	Nein	Soll der Leistungsnachweis bei Abschluss automatisch per E-Mail an diesen Kontakt geschickt werden, falls dieser Kontakt der Kontakt der Leistung ist?
sendFaxIfSelected	Boolean	Nein	Soll der Leistungsnachweis bei Abschluss automatisch per Fax an diesen Kontakt geschickt werden, falls dieser Kontakt der Kontakt der Leistung ist?
isDocumentContact	Boolean	Nein	Handelt es sich um den Standard Dokumenten Kontakt?

*Falls `sendEmail`, `sendEmailIfSelected` bzw. `sendFax`, `sendFaxIfSelected` aktiviert sind, müssen bei `email` bzw. `telefax` Werte hinterlegt werden.

Materialien

Name	Tabelle	View	Optional
docbee_material_item	Ja	Ja	Ja (Siehe Hinweis)

Spalten

Name	Datentyp	NULL erlaubt	Beschreibung
id	Zeichenkette	Nein	Eindeutige ID für einen Materialien-Datensatz. Diese ID kann von Ihnen frei definiert werden und dient dem Connector zum Verknüpfen Ihres Datensatz mit dem späteren DocBee Datensatz. Wir empfehlen für diese Spalte die Verwendung Ihrer Datenbank-ID für Material-Datensätze.
name	Zeichenkette	Nein	Name des Materials
number	Zeichenkette	Ja	Nummer des Materials
deactivated	Boolean	Nein	Ist das Material deaktiviert? Falls ja, kann dies nicht mehr bei neuen Leistungen als Material ausgewählt werden

_**Hinweis:**_ Der Materialien-Import kann über die Einstellung [``drone\task\withMaterials``](#drone_task_withMaterials) deaktiviert werden. Falls dieser deaktiviert ist, muss die View nicht bereitgestellt werden.

Leistungs-Import

Der Leistungs-Import legt in DocBee eine Leistung mit einer Tätigkeit an.

Name	Tabelle	View	Optional
docbee_document	Ja	Nein	Ja (Siehe Hinweis)

_**Hinweis:**_ Der Leistungs-Import kann über die Einstellung [``drone\task\importDocuments``](#drone_task_importDocuments) deaktiviert werden. Falls dieser deaktiviert ist, muss die Tabelle nicht bereitgestellt werden.

Spalten

Name	Datentyp	NULL erlaubt	Beschreibung
documentId	Zeichenkette	Nein	Eindeutige ID für diesen Leistungs-Datensatz. Diese ID kann von Ihnen frei definiert werden und dient dem Connector zum Verknüpfen Ihres Datensatz mit dem späteren DocBee Datensatz und wird bei Abrechnungs-Export zurückgeliefert. Diese ID ist in DocBee nicht sichtbar.
referenceNumber	Zeichenkette	Ja	Eine Referenznummer für diesen Leistungs-Datensatz. Diese Nummer wird auch innerhalb von DocBee als Referenznummer angezeigt. Wird nur übermittelt, falls Referenznummer in DocBee aktiviert ist.
customer	Zeichenkette	Nein	Die Kunden-ID aus docbee_customer
customerLocation	Zeichenkette	Ja	Die Standort-ID aus docbee_location
customerContact	Zeichenkette	Ja	Die Kontakt-ID aus docbee_contact
personInChargeErpNumber	Zeichenkette	Ja	Die in DocBee hinterlegte ERP Nummer eines Benutzers.
serviceType	Zeichenkette	Nein	Eine DocBee Leistungsart-Nummer. Sie können unter Administration -> Leistungen -> Leistungsarten die Nummer hinterlegen.
taskTitle	Zeichenkette	Nein	Titel der Tätigkeit
taskDescription	Zeichenkette	Ja	Beschreibung der Tätigkeit
planningStartDate	Datum mit Uhrzeit	Ja	Das Startdatum für eine Planungszeit. Dies ermöglicht Ihnen die direkte Anlage einer Planungszeit.
planningEndDate	Datum mit Uhrzeit	Ja	Das Enddatum für eine Planungszeit. Dies ermöglicht Ihnen die direkte Anlage einer Planungszeit.
dueDate	Datum mit Uhrzeit	Ja	Die Fälligkeit der Tätigkeit
estimatedTime	Gleitkommazahl	Ja	Die geschätzte Arbeitszeit im eingestellten Arbeitszeit-Format .
infoFilePaths	Zeichenkette	Ja	Eine mit ; separierte Liste von Datei- oder Ordner-Pfaden die als Info-Datei der Leistung angehangen werden sollen. Beispiel:/var/tmp/image.jpg;/var/tmp/info.pdf;/var/tmp/folder/ WICHTIG: Der Connector benötigt Zugriff auf die angegeben Datei- bzw. Ordner-Pfade
docBeeLink	Zeichenkette	Ja	Diese Spalte wird vom Connector befüllt, nachdem die Leistung in DocBee angelegt wurde und enthält den Link zur erzeugten Leistung
docBeeImportDate	Datum mit Uhrzeit	Ja	Diese Spalte wird vom Connector befüllt, nachdem die Leistung in DocBee angelegt wurde und enthält das Import-Datum

Abrechnungs-Export

Der Abrechnungs-Export exportiert alle zur Abrechnung freigegebenen Leistungen in die folgende Tabelle.

Hinweis: Es werden mehrere Datensätze für eine Leistung produziert. Abhängig von Leistungserfassungen, Materialien und Reisezeiten.

Name	Tabelle	View	Optional
docbee_invoice	Ja	Nein	Ja (Siehe Hinweis)

_**Hinweis:**_ Der Abrechnungs-Export kann über die Einstellung [``drone\task\exportInvoices``](#drone_task_exportInvoices) deaktiviert werden. Falls dieser deaktiviert ist, muss die Tabelle nicht bereitgestellt werden.

Spalten

Name	Datentyp	NULL erlaubt	Beschreibung
id	Ganzzahl	Nein	Eine ID, die vom jeweiligen angebunden System automatisch generiert werden muss, wenn ein INSERT Befehl ausgeführt wird. Der Wert der Spalte wird nicht vom Connector erzeugt.
documentId	Zeichenkette	Ja	Die documentId falls diese Leistung über den Leistungs-Import angelegt worden ist, sonst NULL.
referenceNumber	Zeichenkette	Ja	Die Referenznummer, die in der Leistung hinterlegt ist. Wird nur übermittelt, falls Referenznummern in DocBee aktiviert sind.
customer	Zeichenkette	Ja	Eine Kunden-ID aus docbee_customer oder NULL, falls dieser Kunde nicht über den Connector importiert worden ist.
customerLocation	Zeichenkette	Ja	Eine Standort-ID aus docbee_location oder NULL, falls dieser Kunde nicht über den Connector importiert worden ist.
customerContact	Zeichenkette	Ja	Eine Kontakt-ID aus docbee_contact oder NULL, falls dieser Kunde nicht über den Connector importiert worden ist.
finishedDate	Datum mit Uhrzeit	Nein	Das Leistungsabschluss-Datum
successfullyFinishedDate	Datum mit Uhrzeit	Ja	Das Leistungsabschluss-Datum, was nur gesetzt wird, falls Erfolgreich abgeschlossen in der DocBee Leistung gesetzt wurde
docBeeDocumentId	Ganzzahl	Nein	Die interne DocBee ID für diese Leistung. Diese ID kann verwendet werden, um Datensätze zu gruppieren.
docBeeLink	Zeichenkette	Nein	Der Link zur DocBee-Leistung
docBeeFileLink	Zeichenkette	Nein	Der Link zum DocBee-Leistungnachweis
docBeeFilePath	Zeichenkette	Ja	Datei-Pfad zur Leistungsnachweis-PDF. Wird nur gesetzt, falls in den Einstellungen ein Download-Pfad gesetzt wurde.
type	Zeichenkette	Nein	Einer der folgenden Werte WORK => Arbeitszeit TRAVEL=> Reisezeit MATERIAL => Material
amount	Gleitkommazahl	Nein	Bei WORK und TRAVEL wird die Zeit im eingestellten Arbeitszeit-Format zurückgegeben. Bei MATERIAL die ausgewählte Menge.
docBeeTaskId	Ganzzahl	Ja	Die interne DocBee ID für eine Tätigkeit. Diese ID kann verwendet werden, um Datensätze zu gruppieren. Wird nur bei WORK und MATERIAL gesetzt, sonst NULL.
taskTitle	Zeichenkette	Ja	Der Titel der Tätigkeit. Wird nur bei WORK und MATERIAL gesetzt, sonst NULL.
taskDescription	Zeichenkette	Ja	Die Beschreibung der Tätigkeit Wird nur bei WORK und MATERIAL gesetzt, sonst NULL.
taskImageLinks	Zeichenkette	Ja	Links zu Tätigkeits-Bildern. Bei mehreren Bilder werden die einzelnen Links mit ; separiert. Wird nur bei WORK und MATERIAL gesetzt, sonst NULL.
taskImagePaths	Zeichenkette	Ja	Datei-Pfade zu Tätigkeits-Bildern, wird nur gesetzt, falls in den Einstellungen ein Download-Pfad gesetzt wurde. Bei mehreren Bilder werden die einzelnen Links mit ";" separiert. Wird nur bei WORK und MATERIAL gesetzt, sonst NULL.
serviceType	Zeichenkette	Ja	Die Leistungsart-Nummer oder NULL, falls keine Nummer in DocBee hinterlegt ist. Wird nur bei WORK gesetzt, sonst NULL.
travelType	Zeichenkette	Ja	Die Reiseart-Nummer oder NULL, falls keine Nummer in DocBee hinterlegt ist oder falls keine Reiseart ausgefällt worden ist. Wird nur bei TRAVEL gesetzt, sonst NULL.
travelDistance	Gleitkommazahl	Ja	Die Reise-Distanz in Kilometern oder NULL, falls die Reise-Distanz in DocBee definiert ist. Wird nur bei TRAVEL gesetzt, sonst NULL.
materialName	Zeichenkette	Ja	Der Name des Materials. Wird nur bei MATERIAL gesetzt, sonst NULL.
materialNumber	Zeichenkette	Ja	Die Nummer des Materials. Wird nur bei MATERIAL gesetzt, sonst NULL.
workerErpNumber	Zeichenkette	Ja	Die ERP-Nummer, die beim Benutzer in DocBee hinterlegt ist oder NULL, falls keine hinterlegt ist. Wird nur bei WORK und TRAVEL gesetzt, sonst NULL.
startDate	Datum mit Uhrzeit	Ja	Das Startdatum der Leistungserfassung oder Reisezeiterfassung. Wird nur bei WORK und TRAVEL gesetzt, sonst NULL.
endDate	Datum mit Uhrzeit	Ja	Das Enddatum der Leistungserfassung oder Reisezeiterfassung. Wird nur bei WORK und TRAVEL gesetzt, sonst NULL.
remainingEstimate	Gleitkommazahl	Ja	Die verbleibende Arbeitszeit auf der Tätigkeit im eingestellten Arbeitszeit-Format. Wird nur bei WORK gesetzt, sonst NULL.

Installation

Der DocBee Standard Connector kann als Docker Container (empfohlen) oder als Anwendung ausgeführt werden.

Als Docker Container

Nachdem Sie das Docker Image (docbee_default_connector_image.tar) zur Verfügung gestellt bekommen haben. Könnten Sie es wie folgt installieren:

docker load --input docbee_default_connector_image.tar
docker run -d --restart unless-stopped --log-driver json-file --log-opt max-file=1 --log-opt max-size=100m -v <PFAD>:/docbee-connector --name docbee_default_connector docbee/docbee_default_connector:latest`
docker stop docbee_default_connector

<PFAD> muss durch einen leeren Datei-Pfad auf ihrem System zeigen. In diesem Pfad wird die Konfiguration und benötigte SQLite Datenbank abgelegt.

Die Einstellung für --restart, --log-driver, --log-opt max-file und --log-opt max-size=100m sind optional, werden aber von uns empfohlen

Wir stoppen den Container hier gleich wieder um die Konfiguration-Datei (settings.xml) zu bekommen und diese zu ändern.

Env variables

Optional können noch folgende Umgebungsvariablen beim Anlegen des Docker Containers hinzugefügt werden.

Name	Standardwert	Beschreibung
CONNECTOR_MEMORY_USAGE	1g	Wie viel Speicher darf der Connector verwenden WICHTIG: Dieser Wert bedeutet nicht den absoluten Speicherbedarf dieser kann höher liegen
CONNECTOR_LOG_LEVEL	WARNING	Das Log Level des Connectors kann z.B. auf DEBUG gestellt werden falls weitere Informationen benötigt werden

Beispiel

Verwenden Sie z.B. folgenden Befehl um den Docker Container mit 2 GB zu starten und das Log Level auf DEBUG zustellen.

docker run -d --restart unless-stopped --log-driver json-file --log-opt max-file=1 --log-opt max-size=100m -v <PFAD>:/docbee-connector --env CONNECTOR_MEMORY_USAGE=2g --env CONNECTOR_LOG_LEVEL=DEBUG --name docbee_default_connector docbee/docbee_default_connector:latest`

Als Anwendung

Der DocBee Standard 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 ausfü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 Standard Connector kann über einen Installer installiert werden. Dafür klicken Sie doppelt auf die docbee-default-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-default-connector-installer.jar durch Ihren Dateinamen.

Windows

Einige Windows Versionen unterstützen beim Ausführen von Java Anwendung 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-default-connector-installer.jar

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

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

Command Line

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

java -jar docbee-default-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 sollte, ersetzen Sie bitte docbee-default-connector-installer.jar durch Ihren Dateinamen.

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 einem Windowssystem 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\DefaultConnector\)
3. Führen Sie den Befehl installService.bat aus

Konfiguration

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

Dafür gehen Sie ins Daten-Pfad (Docker) oder in das Installationsverzeichnis(Anwendung) 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 ausgeführt werden soll.

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

drone\task\dataSyncInterval

Definiert den Intervall in Minuten, wie häufig der Connector die Stammdaten synchronizieren soll.

Wichtig: Kleinere Werte als im repeatInterval werden ignoriert.

**``drone\task\withMaterials``**

Definiert, ob Materialien zu DocBee synchronisiert werden sollen oder nicht.

Werte	Beschreibung
false	Deaktiviert (Standard-Einstellung)
true	Aktiviert

**``drone\task\importDocuments``**

Definiert, ob in DocBee Leistungen aus der Tabelle docbee_document erzeugt werden sollen oder nicht.

Werte	Beschreibung
false	Deaktiviert (Standard-Einstellung)
true	Aktiviert

**``drone\task\exportInvoices``**

Definiert, ob DocBee Abrechnungsdaten in die Tabelle docbee_invoice exportiert werden sollen oder nicht.

Werte	Beschreibung
false	Deaktiviert (Standard-Einstellung)
true	Aktiviert

Hinweis: Alle Leistungen, die nicht auf "nicht abrechnen" stehen bzw. keine Abrechnungsnummer haben werden exportiert.

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/ )

System-Einstellungen

drone\system\databasetype

Der Typ der Datenbank ( mssql, mariadb oder mysql )

drone\system\host

Die IP oder URL zur Datenbank.

drone\system\port

Der Port der Datenbank.

drone\system\username

Datenbank Benutzer, der Zugriff auf die Datenbank hat.

drone\system\password

Das Passwort des Datenbank Benutzers.

drone\system\databasename

Der Datenbank-Name der Datenbank

drone\system\instanceName

Der Instanz-Name der Datenbank

Wichtig: Der Instanz-Name wird nur bei MS SQL Datenbank verwendet.

Empfehlung: Aus Geschwindigkeitsgründen sollte besser anstelle des Instanz-Namen der zugehörige Port gesetzt werden und der Instanz-Name leer bleiben.

**``drone\system\workingTimeFormat``**

Definiert, in welchem Arbeitszeit-Format estimatedTime beim Importieren bzw. amount beim Exportieren verwendet wird.

Werte	Beschreibung
HOURS	Stunden
MINUTES	Minuten
SECONDS	Sekunden
MILLISECONDS	Millisekunden

**``drone\system\documentDownloadPath``**

Definiert den Pfad, in dem die Leistungsnachweis-PDFs abgelegt werden sollen. Falls der Pfad nicht gesetzt wurde, werden keine Leistungsnachweis-PDFs aus DocBee geladen.

Die Leistungsnachweis-PDFs werden mit folgendem Datei-Namen im Datei-Pfad erzeugt:

<docBeeDocumentId>.pdf

Wichtig: Der Connector braucht Schreibzugriff auf den eingestellten Pfad.

**``drone\system\taskImageDownloadPath``**

Definiert den Pfad, in dem die Tätigkeits-Bilder abgelegt werden sollen. Falls der Pfad nicht gesetzt wurde, werden keine Tätigkeits-Bilder aus DocBee geladen.

Die Tätigkeits-Bilder werden mit folgendem Datei-Name im Datei-Pfad erzeugt:

<fileId>.pdf

Hinweis: Die Pfade zu den Tätigkeits-Bilder finden Sie in der Spalte taskImagePaths

Wichtig: Der Connector braucht Schreibzugriff auf den eingestellten Pfad.

drone\system\infoFileDirectoryRegEx

Ein optionaler Regulärer Ausdruck der zutreffen muss, damit die Dateien in diesem Ordner als Info-Dateien importiert werden.

Beispiel

<infoFileDirectoryRegEx>^import$</infoFileDirectoryRegEx>

Es würden nur Dateien aus Ordnern importiert werden, die den Namen import haben.

Hinweis: Unterordner werden trotzdem durchsucht.

drone\system\infoFileFileRegEx

Ein optionaler Regulärer Ausdruck der Zutreffen muss, damit die Datei als Info-Datei importiert werden.

Beispiel

<infoFileFileRegEx>^.*\.png$</infoFileFileRegEx>

Es werden nur Dateien mit der Endung png importiert.

drone\system\infoFileMaxDepth

Eine optionale maximale Tiefe, die durchsucht wird. Eine Tiefe von 0 würde bedeuten, dass nur Datei im direkten Ordner gelesen werden und keine Unterordner durchsucht werden.

Hinweis: Der Standard-Wert ist 0

Ausführen

Als Docker Container

Nachdem Sie den DocBee Standard Connector als Docker Container installiert und konfiguriert haben können Sie Ihn nun starten in dem Sie folgenden Befehl ausführen:

docker start docbee_default_connector

Als Anwendung

Nachdem Sie den DocBee Standard 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-default-connector start

Update

Als Docker Container

Um den Container zu aktualisieren, führen Sie folgende Befehle aus, nachdem Sie die neue Image-Datei(docbee_default_connector_image.tar) erhalten haben.

docker stop docbee_default_connector
docker rm docbee_default_connector
docker load --input docbee_default_connector_image.tar
docker run -d --restart unless-stopped --log-driver json-file --log-opt max-file=1 --log-opt max-size=100m -v <PFAD>:/docbee-connector --name docbee_default_connector docbee_default_connector:latest`

<PFAD> muss durch den bei der Installation verwendeten Datei-Pfad ersetzt werden.

Sie müssen beim Update immer alle Parameter wieder übergeben, weil ein Docker Container komplett entfernt und dann komplett neu angelegt wird

Als Anwendung

Beim Aktualisieren als Anwendung können Sie einfach die Installation erneut ausführen und es in den gleichen Ordner installieren.

Sie sollten die Anwendung bzw. den Dienst/Daemon vorher stoppen

FAQ

Warum startet der Dienst unter Windows nicht oder beendet sich sofort wieder?

Die auszuführende Java-Datei kann nicht gefunden werden.

Um dieses Problem zu beheben, gehen Sie bitte in das Installations-Verzeichnis des Connectors und dort in den Ordner yajsw\conf und öffnen Sie die Datei wrapper.conf mit einem Texteditor.

Ganz am Ende der Datei finden Sie wrapper.java.command = java. Diese java ersetzen Sie durch den vollständigen Pfad zur java.exe auf Ihrem System, ohne Dateiendung, z.B. wrapper.java.command = C:\\Java\\bin\\java.

Wichtig: Sie müssen bei Pfad \ durch \\ ersetzen, damit der Pfad richtig gefunden werden kann. z.B. muss der Pfad C:\pfad1\pfad2\ so hinterlegt werden C:\\pfad1\\pfad2\\.

Hinweis: Falls Sie die Java von Oracle installiert haben, finden Sie die java.exe aktuell unter C:\Program Files (x86)\Common Files\Oracle\Java\javapath ( wrapper.java.command = C:\\Program Files (x86)\\Common Files\\Oracle\\Java\\javapath\\java )

Wie migriere ich den Connector von Anwendung auf Docker Container?

1. settings.xml und store.sqlite.db des Connectors sichern
2. Die Anwendung deinstallieren über oder
3. Docker Engine installieren, falls noch nicht erfolgt
4. Docker Version des Connector installieren
5. Ausführung des Containers stoppen über docker stop docbee_default_connector
6. settings.xml und store.sqlite.db in den Mount Pfad kopieren und die Dateien ersetzen
7. docker start docbee_default_connector