Nachrichten
Generelle Informationen
Was sind Nachrichten?
Im Bereich Nachrichten wird der Versand und der Empfang von Nachrichten definiert.
Wann sollten Sie Nachrichten verwenden?
Falls einer oder mehrere der folgenden Punkte zutreffen, empfehlen wir den Einsatz von Nachrichten.
- Sie wollen E-Mails, SMS oder Faxe aus DocBee verschicken
- Sie wollen Vorgänge aus E-Mails erzeugen (Mail zu Vorgang)
Nachrichten
Einstellungen
Die Einstellungen zum Nachrichtenversand finden Sie unter Administration > Nachrichten > Einstellungen.
Fax
DocBee bietet die Möglichkeit, Faxe zu verschicken. DocBee verwendet dafür den Dienst Interfax. Falls Sie diese Funktion nutzen wollen, benötigen Sie einen InterFax-Zugang.
Hinweis: Durch Interfax entstehen weitere Kosten.
Feldbeschreibungen
| Name | Beschreibung |
|---|---|
| Aktiviert | Aktiviert die Möglichkeit, Faxe zu verschicken |
| Benutzername | Interfax Benutzername |
| Passwort | Interfax Passwort |
Mail-Server
DocBee bietet aktuell die Möglichkeit, E-Mails zu verschicken. Der E-Mail Versand läuft über Ihren eigenen Mail-Server und muss hier konfiguriert werden.
Feldbeschreibungen
Generelle
| Name | Beschreibung |
|---|---|
| Aktiviert | Aktiviert den E-Mail Versand. Ist die Option deaktiviert, verschickt DocBee keine E-Mails mehr – zum Beispiel, um den Versand vorübergehend anzuhalten. Standardmäßig ist der Versand aktiviert. |
| Typ |
|
| Sender E-Mail Adresse | Die Sender Email Adresse, mit der DocBee standardmässig versucht, E-Mails als Versender zu verschicken. Sollte entweder direkt eine E-Mail-Adresse sein, z.B. support@ihre-domain.de oder im Format 'Name' <support@ihre-domain.de> angegeben werden. |
Normal / TLS / SSL
| Name | Beschreibung |
|---|---|
| Serveradresse | Die URL oder IP Adresse des Mail-Servers. WICHTIG: Ohne Angabe eines Protokolls |
| Port | Der Port des Mail-Servers |
| Authentikation | Wird eine Authentifizierung über Benutzername/Passwort benötigt? |
| Benutzername | Benutzername Wichtig:Der Benutzer muss die Berechtigung haben, für die oben eingetragene Sender E-Mail Adresse E-Mails zu versenden. |
| Passwort | Passwort des Benutzers |
Exchange
| Name | Beschreibung |
|---|---|
| Exchange Version | Ihre eingesetzte Exchange Version |
| Serveradresse | Die URL oder IP Adresse der Exchange EWS Schnittstelle. Hinweis: Hier wird das Protokoll ( https://) benötigt. Normalerweise hat die Adresse folgenden Aufbau https://www.ihredomain.de/ews/Exchange.asmx |
| Alle Zertifikate erlauben | Falls dies aktiviert wird, wird die Zertifikatsprüfung deaktiviert um auch Selfsigned Zertifikate zu erlauben. Hinweis: Wir empfehlen nicht die Deaktivierung der Zertifikatsprüfung |
| Authentikation | Wird eine Authentifizierung über Benutzername/Passwort benötigt? |
| Benutzername | Benutzername Wichtig:Der Benutzer muss die Berechtigung haben, für die oben eigetragene Sender E-Mail Adresse E-Mails zu versenden. |
| Passwort | Passwort des Benutzers |
Office 365 (MS Graph)
| Name | Beschreibung |
|---|---|
| Anwendungs-ID (Client) | Die Anwendungs-ID (Client) Microsoft Azure -> App-Registrierungen -> Anwendung -> Übersicht |
| Geheimer Clientschlüssel | Der Geheime Clientschlüssel aus Microsoft Azure -> App-Registrierungen -> Anwendung -> Zertifikate & Geheimnisse |
| Verzeichnis-ID (Mandant) | Die Verzeichnis-ID (Mandant) aus Microsoft Azure -> App-Registrierungen -> Anwendung -> Übersicht |
Hinweis: Die Anwendung benötigt zum Versenden von E-Mails die Berechtigung
Mail.Send.
Hinweis: Weitere Informationen zur Anbindung über MS Graph finden Sie unter Microsoft Graph Schnittstelle
Deaktivierter E-Mail Versand
Ist die Option Aktiviert deaktiviert, wird eine E-Mail nie verschickt. Sie wird stattdessen als nicht
versendet abgelegt und mit einem entsprechenden Kommentar versehen. Im Fehlerprotokoll
entsteht dabei kein Eintrag – der abgeschaltete Versand ist kein Fehler.
Gehört die E-Mail zu einer Vorgangs- oder Leistungs-Nachricht, erhält diese Nachricht den Status
Fehlgeschlagen (siehe Nachrichten-Status), damit sie nicht dauerhaft als
noch ausstehend angezeigt wird.
Hinweis: Die Option betrifft ausschließlich den E-Mail Versand. Fax und SMS haben jeweils ihre eigene Option
Aktiviert.
SMS
DocBee bietet die Möglichkeit, SMS zu verschicken. DocBee verwendet dafür den Dienst MessageBird. Falls Sie diese Funktion nutzen wollen, benötigen Sie einen MessageBird Access-Key.
Hinweis: Durch MessageBird entstehen weitere Kosten.
Wichtig: Die Mobilnummern müssen mit Länderkennung hinterlegt sein, damit die verschickt werden können.
Feldbeschreibungen
| Name | Beschreibung |
|---|---|
| Aktiviert | Aktiviert die Möglichkeit, SMS zu verschicken |
| Access Key | Message Bird Access-Key |
| Urheber | Wer soll als Urheber der SMS angezeigt werden z.B. DocBee? |
MessageBird
Zur Anbindung von MessageBird in DocBee muss in MessageBird ein API Key erzeugt werden. Die folgenden Schritte dienen als Hilfe zum Anlegen eines API-Keys.
- Melden Sie sich unter https://www.messagebird.com an.
- Öffnen Sie den Menüpunkt
Entwickler. - Wählen Sie dort
API-Zugangaus. - Danach klicken Sie auf
Zugangsschlüssel hinzufügen - Im Dialog geben Sie einen Namen (Beschreibung) für den API Key an z.B. DocBee und wählen den Typ
Live. - Danach können Sie in der Liste über
Schlüssel anzeigendenKeykopieren (Dieser muss alsAccess Keyin DocBee eingetragen werden). - Fertig.
Hinweis: MessageBird gibt die Möglichkeit, kostenlose Test SMS zu verschicken. Dies funktioniert aber nur an die Telefonnummer, die im Konto hinterlegt ist.
Nachrichtenausgang
Im Nachrichtenausgang sehen Sie, welche Nachrichten DocBee verschickt hat und was genau in ihnen stand – über alle Nachrichten-Typen hinweg, also E-Mails, SMS und Faxe. Das hilft bei der Frage „Ist die Mail beim Kunden wirklich rausgegangen, und mit welchem Inhalt?", ohne dass Sie im Postfach suchen müssen.
Die Liste zeigt Typ, Status, Empfänger und CC-Empfänger, Betreff, Absender, Kommentar, Erstellungs- und
Sendedatum. Ist der Versand einer Nachricht fehlgeschlagen, verschicken Sie sie über die Gruppenaktion
Erneut senden noch einmal.
Hinweis: Der Nachrichtenausgang steht ausschließlich Administratoren zur Verfügung.
Wichtig: Der Nachrichtenausgang zeigt nur die Nachrichten der letzten 30 Tage. Ältere Nachrichten werden nicht mehr aufgeführt.
Hinweis: Aufgeführt werden nur Nachrichten, die zum Versand freigegeben wurden. Ein Entwurf oder eine Nachricht, die den Versand nie erreicht hat, erscheint hier nicht.
Den Status einer einzelnen Nachricht sehen Sie außerdem direkt am Vorgang bzw. an der Leistung, siehe Nachrichten-Status.
Hinweis: Der Nachrichtenausgang ist nicht mit der Nachrichten Ablage zu verwechseln. Die Nachrichten Ablage sammelt Einträge, um daraus eine Sammelnachricht zu erzeugen; der Nachrichtenausgang protokolliert, was DocBee tatsächlich verschickt hat.
Nachrichten-Vorlagen
Nachrichten-Vorlagen definieren alle Nachrichten, die aus DocBee versendet werden und ermöglichen die Anpassung der Nachrichten je nach persönlichen Vorstellungen.
Feldbeschreibungen
| Name | Beschreibung |
|---|---|
| Name | Der interne Name der Nachrichten-Vorlage |
| Typ | Definiert, für welches Ereignis diese Nachrichten Vorlage angelegt wird und definiert damit die Platzhalter und die Logik-Objekte. |
| Format | Format der Nachricht |
| Layout | Hier kann ein vorher definiertes Layout hinterlegt werden. Wird ein HTML Layout angelegt (Typ & Format = HTML Layout), so muss in dem Inhalt und Textinhalt des HTML Layouts der Platzhalter %INHALT% verwendet werden. Wird das HTML Layout ausgewählt, so wird der Inhalt der Nachrichten-Vorlage an der Stelle des Platzhalter %INHALT% aus dem HTML Layout angezeigt. Die Layouts werden ineinander verschachtelt.Nicht alle Nachrichten Formate besitzen diese Feld |
| Betreff | Der Betreff der Nachricht, welcher mit Platzhaltern versehen werden kann. Nicht alle Nachrichten Formate besitzen diese Feld |
| HTML aus Text | Wird die Einstellung aktiviert, so wird die HTML E-Mail aus dem Textinhalt generiert. Nicht alle Nachrichten Formate besitzen diese Feld |
| Link | Hier kann der Link als Platzhalter hinterlegt werden, zudem man gelangt, wenn auf die Benachrichtigung geklickt wird.Nicht alle Nachrichten Formate besitzen diese Feld |
| Inhalt | Der Inhalt der Nachricht. Bei HTML E-Mails oder HTML Layout können dort HTML Tags verwendet werden. |
| Textinhalt | Der Textinhalt der Nachricht. Nicht alle Nachrichten Formate besitzen dieses Feld |
| ID | Zeigt die ID der Nachrichtenvorlage. |
| Bilder | Hier können Bilder hochgeladen werden, welche in der Nachricht verwendet werden können. Die Bilder können dann mit dem Logik-Tag docbee_image in der Nachricht verwendet werden. Das Bild kann auch per Knopfdruck in die Nachrichtenvorlage eingefügt werden.Nicht alle Nachrichten Formate besitzen diese Feld |
Hinweis: Die Standard-Emails werden von DocBee als
MultipartE-Mails verschickt und benötigen deswegen sowohl einenTextals auch einenHTML-Teil. Die Auswahl, welche Art von Nachricht angezeigt wird, übernimmt in diesem Fall der Mail-Client des Empfängers.
Typen
Abschluss (Leistung)
| Auslöser | Empfänger |
|---|---|
Abschluss der Leistung oder Freigabe der Leistung je nach Einstellungen unter Administration > Leistungen > Einstellungen und Benachrichtigung verschicken ist in der Leistung aktiviert. |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
docBeeDocument | Leistung | Objekt Leistung |
contact | Kontakt der Leistung oder der Standard-Kontakt | Objekt Kontakt |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
Abschluss (Protokoll)
| Auslöser | Empfänger |
|---|---|
| Abschluss des Protokolls |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
protocolDocument | Protokoll | Objekt Protokoll |
contact | Kontakt der Leistung oder der Standard-Kontakt | Objekt Kontakt |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
Antwort auf Aktualisierung (Vorgang)
| Auslöser | Empfänger |
|---|---|
Nachricht wird via E-Mail an einen Vorgang gesendet. Dies wird nur ausgeführt, falls ein Mail-Parser aktiviert ist und beim Vorgangs-Mail-Parser Automatische Antwort aktiviert ist. |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
ticket | Vorgang | Objekt Vorgang |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
Antwort auf Erstellung (Vorgang)
| Auslöser | Empfänger |
|---|---|
Neuer Vorgang wird aus einer E-Mail erzeugt. Dies wird nur ausgeführt, falls ein Mail-Parser aktiviert ist und beim Vorgangs-Mail-Parser Automatische Antwort aktiviert ist. |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
ticket | Vorgang | Objekt Vorgang |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
Antwort auf Nachricht (Leistung)
| Auslöser | Empfänger |
|---|---|
| Es wird auf eine Vorgangs-Nachricht geantwortet. (Die Verwendete Nachrichten-Vorlage kann im Dialog ausgewählt werden.) |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
docBeeDocument | Leistung | Objekt Leistung |
contact | Kontakt der Leistung oder der Standard-Kontakt | Objekt Kontakt |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
sender | Sender | Objekt Benutzer |
originalMessage | Original Nachricht | Objekt Nachricht |
Antwort auf Nachricht (Vorgang)
| Auslöser | Empfänger |
|---|---|
| Es wird auf eine Vorgangs-Nachricht geantwortet. (Die verwendete Nachrichten-Vorlage kann im Dialog ausgewählt werden.) |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
ticket | Vorgang | Objekt Vorgang |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
sender | Sender | Objekt Benutzer |
originalMessage | Original Nachricht | Objekt Nachricht |
Benachrichtigung Nachricht (Leistung)
| Auslöser | Empfänger |
|---|---|
| Ein Benutzer wurde beim Versenden von Nachrichten als zu benachrichtigen ausgewählt |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
docBeeDocument | Leistung | Objekt Leistung |
contact | Kontakt der Leistung oder der Standard-Kontakt | Objekt Kontakt |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
notifier | Versender der Benachrichtung | Objekt Benutzer |
notifierMessage | Benachrichtigungs-Nachricht | Objekt Benachrichtungs-Nachricht |
Benachrichtigung Nachricht (Vorgang)
| Auslöser | Empfänger |
|---|---|
| Ein Benutzer wurde beim Versenden von Nachrichten als zu benachrichtigen ausgewählt. |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
ticket | Vorgang | Objekt Vorgang |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
notifier | Versender der Benachrichtung | Objekt Benutzer |
notifierMessage | Benachrichtigungs-Nachricht | Objekt Benachrichtungs-Nachricht |
Beobachter Benachrichtigung (abg. Leistung)
| Auslöser | Empfänger |
|---|---|
| Eine Leistung wird abgeschlossen |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
docBeeDocument | Leistung | Objekt Leistung |
contact | Kontakt der Leistung oder der Standard-Kontakt | Objekt Kontakt |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
Beobachter Benachrichtigung (abg. Protokoll)
| Auslöser | Empfänger |
|---|---|
| Eine Protokoll wird abgeschlossen |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
protocollDocument | Protokoll | Objekt Protokoll |
contact | Kontakt des Protokoll oder der Standard-Kontakt | Objekt Kontakt |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
E-Mail Layout
Spezieller Typ, der verwendet werden kann, um ein Standard-Layout für andere E-Mails zu erzeugen.
Erstellung (Leistung)
| Auslöser | Empfänger |
|---|---|
Beim Anlegen einer neuen Leistung, falls die Einstellung Erstellungs-Email an Kunden unter Administration > Leistungen > Einstellungen aktiviert ist |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
docBeeDocument | Leistung | Objekt Leistung |
contact | Kontakt der Leistung oder der Standard-Kontakt | Objekt Kontakt |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
Nachrichten Ablage
| Auslöser | Empfänger |
|---|---|
| Zeitgesteuert über Nachrichten Ablagen |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
bucket | Nachrichten Ablage | Objekt Nachrichten Ablage |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
Nachrichtenversand (Leistung)
| Auslöser | Empfänger |
|---|---|
| Beim Verschicken einer neuen Nachricht vom Typ E-Mail oder SMS. (Die verwendete Nachrichten-Vorlage kann im Dialog ausgewählt werden.) |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
docBeeDocument | Leistung | Objekt Leistung |
contact | Kontakt der Leistung oder der Standard-Kontakt | Objekt Kontakt |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
sender | Versender | Objekt Benutzer |
Nachrichtenversand (Automatisierung)
| Auslöser | Empfänger |
|---|---|
Beim Verschicken einer Nachricht aus (Administration > Automatisierungen) |
|
Logik-Objekte
Die zur Verfügung stehenden Logik-Objekte hängen vom Auslöser der Regel ab.
| Name | Beschreibung | Typ |
|---|---|---|
ticket | Vorgang | Objekt Vorgang |
docBeeDocument | Leistung | Objekt Leistung |
protocolDocument | Protokoll | Objekt Protokoll |
statusChange | Abwesenheits-Status-Änderung | Objekt Abwesenheits-Status-Änderung |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
Nachrichtenversand (Tagesabschluss)
| Auslöser | Empfänger |
|---|---|
| Tagesabschluss Erinnerung, falls beim Tagesabschluss-Profil hinterlegt. |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
user | Benutzer | Objekt Benutzer |
dailyClosing | Tagesabschluss-Daten | Objekt Tagesabschluss-Daten |
Nachrichtenversand (Vorgang)
| Auslöser | Empfänger |
|---|---|
| Beim Verschicken einer neuen Nachricht vom Typ E-Mail oder SMS. (Die verwendete Nachrichten-Vorlage kann im Dialog ausgewählt werden.) |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
ticket | Vorgang | Objekt Vorgang |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
sender | Versender | Objekt Benutzer |
Status Änderung (Vorgang)
| Auslöser | Empfänger |
|---|---|
Status wird geändert und unter Administration > Vorgang > Status ist im Status Nachrichtenversand aktiviert. |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
ticket | Vorgang | Objekt Vorgang |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
previousStatus | Vorheriger Status | Objekt Status |
statusChange | Status-Änderung | Objekt Status-Änderung |
Stornierung (Leistung)
| Auslöser | Empfänger |
|---|---|
Leistung wird storniert und der Nachricht verschicken wurde gesetzt |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
docBeeDocument | Leistung | Objekt Leistung |
contact | Kontakt der Leistung oder der Standard-Kontakt | Objekt Kontakt |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
Termine (Zeitraum Planung)
| Auslöser | Empfänger |
|---|---|
Eine Zeitraum-Planung wird zur Prüfung aktiviert oder neue Planungen werden vorgenommen, während die Zeitraum-Planung im Zustand In Prüfung ist. |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
approval | Zeitraum-Planng Prüfung | Objekt Zeitraum-Planung Prüfung |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
Weiterleitung (Leistung)
| Auslöser | Empfänger |
|---|---|
| Es wird auf eine Leistungs-Nachricht weitergeleitet. (Die verwendete Nachrichten-Vorlage kann im Dialog ausgewählt werden.) |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
docBeeDocument | Leistung | Objekt Leistung |
contact | Kontakt der Leistung oder der Standard-Kontakt | Objekt Kontakt |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
sender | Sender | Objekt Benutzer |
originalMessage | Original Nachricht | Objekt Nachricht |
Weiterleitung (Vorgang)
| Auslöser | Empfänger |
|---|---|
| Es wird auf eine Vorgangs-Nachricht weitergeleitet. (Die verwendete Nachrichten-Vorlage kann im Dialog ausgewählt werden.) |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
ticket | Vorgang | Objekt Vorgang |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
sender | Sender | Objekt Benutzer |
originalMessage | Original Nachricht | Objekt Nachricht |
Wiedervorlage Benachrichtigung (Vorgang)
| Auslöser | Empfänger |
|---|---|
| Falls eine Wiedervorlage mit Benachrichtigung erstellt wurde und das Wiedervorlage-Datum erreicht wird. |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
ticket | Vorgang | Objekt Vorgang |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
reminder | Wiedervorlage | Objekt Wiedervorlage |
Wiedervorlage Info-Nachricht (Vorgang)
| Auslöser | Empfänger |
|---|---|
| Falls eine Wiedervorlage mit Info Nachricht erzeugt wurde. |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
ticket | Vorgang | Objekt Vorgang |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
reminder | Wiedervorlage | Objekt Wiedervorlage |
Zuweisung (Leistung)
| Auslöser | Empfänger |
|---|---|
Falls der Verantwortliche einer Leistung geändert wird und die Leistung nicht sich selbst zugewiesen wird und die Zuweisung unter Administration > Leistungen > Einstellungen aktiviert ist. |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
docBeeDocument | Leistung | Objekt Leistung |
contact | Kontakt der Leistung oder der Standard-Kontakt | Objekt Kontakt |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
Zuweisung (Tätigkeit)
| Auslöser | Empfänger |
|---|---|
Falls der Mitarbeiter einer Leistung geändert wird und als Mitarbeiter nicht sich selbst ausgewählt wurde und die Zuweisung unter Administration > Leistungen > Einstellungen aktiviert ist. |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
docBeeDocument | Leistung | Objekt Leistung |
task | Tätigkeit | Objekt Tätigkeit |
worker | Mitarbeiter | Objekt Benutzer |
contact | Kontakt der Leistung oder der Standard-Kontakt | Objekt Kontakt |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
Zuweisung (Vorgang)
| Auslöser | Empfänger |
|---|---|
Falls der Verantwortliche eines Vorgangs geändert wird und der Vorgang nicht sich selbst zugewiesen wird und die Zuweisung unter Administration > Vorgang > Einstellungen aktiviert ist. |
|
Logik-Objekte
| Name | Beschreibung | Typ |
|---|---|---|
ticket | Vorgang | Objekt Vorgang |
companyData | Firmierung | Objekt Firmierung |
mandant | Mandant | Objekt Mandant |
Platzhalter
Nachrichtenvorlagen können Platzhalter beinhalten, die verwendet werden, um Daten aus DocBee direkt in die Nachricht zu übernehmen.
Ein Platzhalter hat immer das Format %PLATZHALTER_NAME%.
Platzhalter variieren je nach Nachrichtentyp. Eine Erläuterung der verfügbaren Platzhalter ist unter Administration-> Nachrichten -> Vorlagen zu
finden. Wenn Sie innerhalb der Nachrichtenvorlage den Betreff oder Textinhalt über das Stift-Icon auf der rechten Seite bearbeiten, lassen sich im Edit-Fenster die verfügbaren Platzhalter ausklappen:

Logik
In DocBee ab der Version 2020.2 gibt es die Möglichkeit, die Nachrichten-Vorlagen über Logik-Elemente zu erzeugen.
Platzhalter
Die Eigenschaften von Objekten, die nicht vom Typ Objekt oder Liste sind, können mit dem
Standard-Platzhalter-Zeichen ausgegeben werden.
Beispiel
Falls ein Standard-Objekt ticket existiert, wird die Vorgangs-ID des Vorgangs in die Nachricht geschrieben.
%ticket.ticketNumber%
Platzhalter (Bracket-Notation)
Bei Zusatzfeldern und Protokoll-Einträgen können deren Werte über eine Bracket-Notation abgerufen werden.
Die Bracket-Notation hat das Format %OBJEKT.KARTE[PLATZHALTER_NAME]%. In den Brackets steht der
Platzhalter Name des Zusatzfeldes bzw. des Protokoll-Eintrags.
Zusatzfelder
Zusatzfelder stehen für folgende Objekte über die Bracket-Notation zur Verfügung:
| Syntax | Beschreibung |
|---|---|
%customer.customFields[PLATZHALTER_NAME]% | Benutzerdef. Feld des Kunden |
%contact.customFields[PLATZHALTER_NAME]% | Benutzerdef. Feld des Kontakts |
%customerComponent.customFields[PLATZHALTER_NAME]% | Benutzerdef. Feld des Kunden-Objekts |
%location.customFields[PLATZHALTER_NAME]% | Benutzerdef. Feld des Standorts |
%user.customFields[PLATZHALTER_NAME]% | Benutzerdef. Feld eines Benutzers |
%ticket.customFields[PLATZHALTER_NAME]% | Benutzerdef. Feld des Vorgangs |
%docBeeDocument.customFields[PLATZHALTER_NAME]% | Benutzerdef. Feld der Leistung |
%observer.customFields[PLATZHALTER_NAME]% | Benutzerdef. Feld des Beobachters |
%serviceProvider.customFields[PLATZHALTER_NAME]% | Benutzerdef. Feld des Dienstleister |
Beispiel
Falls ein Vorgang ein Zusatzfeld mit dem Platzhalter-Namen KUNDENPROJEKTNR besitzt, kann dessen Wert so ausgegeben werden:
%ticket.customFields[KUNDENPROJEKTNR]%
Die Bracket-Notation funktioniert ebenso innerhalb von Logik-Tags (z.B. docbee_object, docbee_each), wenn das betreffende Objekt über eine Variable bereitgestellt wird.
Protokoll-Einträge
Werte von Protokoll-Einträgen können über die Bracket-Notation abgerufen werden:
| Syntax | Beschreibung |
|---|---|
%protocolDocument.entries[PLATZHALTER_NAME]% | Wert eines Protokoll-Eintrags |
Beispiel
Ein Protokolleintrag mit dem Platzhalter NOTIZ wird wie folgt ausgegeben:
%protocolDocument.entries[NOTIZ]%
Bedingungen
docbee_contains
Mit docbee_contains kann ein Wert überprüft werden und, falls der Wert in der input-Variable enthalten ist, wird der
innere Teil in der Nachricht dargestellt.
Beispiel
Der Text "Die Vorgangs-Beschreibung enthält den Text Beispiel" würde nur angezeigt, falls im Vorgang in der Beschreibung "Beispiel" enthalten ist.
<docbee_contains input='ticket.description' value='Beispiel'>
Die Vorgangs-Beschreibung enthält den Text Beispiel
</docbee_contains>
docbee_notContains
Mit docbee_notContains kann ein Wert überprüft werden und, falls der Wert nicht in der input-Variable enthalten ist,
wird der innere Teil in der Nachricht dargestellt.
Beispiel
Der Text "Die Vorgangs-Beschreibung enthält nicht den Text Beispiel" würde nur angezeigt, falls im Vorgang in der Beschreibung "Beispiel" enthalten ist.
<docbee_notContains input='ticket.description' value='Beispiel'>
Die Vorgangs-Beschreibung enthält nicht den Text Beispiel
</docbee_notContains>
docbee_equals
Mit docbee_equals kann ein Wert überprüft werden und, falls der Wert exakt der input-Variable entspricht, wird der
innere Teil in der Nachricht dargestellt.
Beispiel
Der Text "In der Vorgangs-Beschreibung steht Beispiel A" würde nur angezeigt, falls im Vorgang in der Beschreibung exakt "Beispiel A" steht.
<docbee_equals input='ticket.description' value='Beispiel A'>
In der Vorgangs-Beschreibung steht Beispiel A
</docbee_equals>
docbee_notEquals
Mit docbee_notEquals kann ein Wert überprüft werden und, falls der Wert nicht exakt der input-Variable entspricht,
wird der innere Teil in der Nachricht dargestellt.
Beispiel
Der Text "In der Vorgangs-Beschreibung steht nicht exakt Beispiel A" würde nur angezeigt, falls im Vorgang in der Beschreibung nicht exakt "Beispiel A" steht.
<docbee_notEquals input='ticket.description' value='Beispiel A'>
In der Vorgangs-Beschreibung steht nicht exakt Beispiel A
</docbee_notEquals>
docbee_exist
Mit docbee_exist kann überprüft werden, ob ein Objekt oder eine Liste existiert und falls dies der Fall ist, wird
der innere Teil in der Nachricht dargestellt.
Beispiel
Der Text "Der Vorgang hat einen Kunden" würde nur angezeigt, falls der Vorgang einen Kunden hat.
<docbee_exist input='ticket.customer'>
Der Vorgang hat einen Kunden
</docbee_exist>
docbee_notExist
Mit docbee_notExist kann überprüft werden, ob ein Objekt oder eine Liste nicht existiert und falls dies der Fall
ist, wird der innere Teil in der Nachricht dargestellt.
Beispiel
Der Text "Der Vorgang hat keinen Kunden" würde nur angezeigt, falls der Vorgang keinen Kunden hat.
<docbee_notExist input='ticket.customer'>
Der Vorgang hat keinen Kunden
</docbee_notExist>
Objekt
docbee_object
Mit docbee_object wird der Datensatz aus einem Objekt-Typ geholt und in einer Variable gespeichert.
Beispiel
Das Objekt ticket.customer wird in die Variable ticketCustomer geschrieben und kann dann als Platzhalter verwendet
werden, um hier im Beispiel den Kundennamen auszugeben.
<docbee_object input='ticket.customer' var='ticketCustomer'>
%ticketCustomer.name%
</docbee_object>
docbee_limitText
Mit docbee_limitText kann der Text eines Objekt-Typs auf eine bestimmte Anzahl von Zeichen begrenzt werden.
Beispiel
Der Text des Objekts ticket.description wird auf 50 Zeichen begrenzt und in die Variable ticketDescription gespeichert.
<docbee_limitText input='ticket.description' var='ticketDescription' limit='50'>
%ticketDescription%
</docbee_limitText>
Schleife
docbee_each
Mit docbee_each kann über Listen-Typen iteriert werden, um pro Eintrag den inneren Teil in der Nachricht
darzustellen.
Zusätzlich gibt es die Möglichkeiten die Sortierreihenfolge über die Attribute sort und ascending zu definieren, sowie über das Attribut limit ein Limit zu definieren.
Beispiel
Aus dem Objekt ticket wird die Liste der Leistungen (docBeeDocuments) geholt und in die Variable document
gespeichert. Zusätzlich wird die Liste nach der Leistungs-ID (documentNumber) absteigend (ascending='false')
sortiert. Die Schleife wird maximal 100 Mal ausgeführt (limit='100').
Die Variable document ist dann ein Objekt-Typ und würde in diesem Beispiel die Leistungs-IDs ausgeben.
<docbee_each input='ticket.docBeeDocuments' var='document' sort='documentNumber' ascending='false' limit='100'>
%document.documentNumber%
</docbee_each>
Webhook
docbee_webhooklink
Mit docbee_webhooklink können Webhook Links direkt in der Nachrichten-Vorlage erstellt werden.
Parameter
| Name | Pflichtfeld | Beschreibung |
|---|---|---|
id | Ja | ID des Webhooks |
personInChargeId | Nein* | ID eines Benutzers oder Queue* |
customerId | Nein* | ID des Kunden |
locationId | Nein | ID des Kunden-Standorts |
contactId | Nein | ID des Kunden-Kontakts |
ticketId | Nein | ID eines Vorgangs |
docBeeDocumentId | Nein | ID einer Leistung |
name | Nein | Optionaler Name des Links |
style | Nein | Optionale css styles, die beim Anzeigen des Links angewandt werden |
*Bei Protokoll-Webhooks muss die
personInChargeIdund diecustomerIdgesetzt werden und Queues sind nicht erlaubt als Verantwortlicher
Hinweis: Bei einem Protokoll-Webhook wird immer die Verknüpfung zum Vorgang hergestellt, auch wenn dieser geschlossen sein sollte. Der Vorgang verbleibt im abgeschlossenen Zustand.
Protokoll-Felder automatisch vorausfüllen
Bei einem Webhook vom Typ Protokoll kann docbee_webhooklink zusätzlich beliebig viele
data-<Platzhaltername>-Attribute tragen. Jedes referenziert – über dieselbe Punkt-Notation wie die
festen Attribute oben, z. B. ticket.referenceNumber – einen Wert aus einer im Nachrichtentyp
gebundenen Variable (Vorgang, Kunden-Kontakt, Kunden-Objekt, Kunde, Standort, …) und übernimmt ihn
beim Aufruf des Links automatisch in das gleichnamige Feld des Ziel-Protokolls. Für Zusatzfelder steht
zusätzlich die eckige-Klammer-Notation zur Verfügung, z. B. ticket.customFields[REGISTERNUMMER].
Alternativ lässt sich auch ein fester Wert direkt in die Vorlage eintragen – Freitext, eine Zahl oder ein
Datum, z. B. data-hinweis='Bitte vollständig ausfüllen' oder data-datum='15.01.2026': Ein Wert, der
sich nicht als Verweis auf eine gebundene Variable auflösen lässt, wird unverändert als fester Text
übernommen. Es gibt dafür keine eigene Schreibweise – ein Wert funktioniert entweder als Verweis oder,
wenn nicht, automatisch als fester Wert.
| Name | Pflichtfeld | Beschreibung |
|---|---|---|
data-<Platzhaltername> | Nein | Wert-Referenz oder fester Wert für das Protokollfeld mit diesem Platzhalternamen (Groß-/Kleinschreibung wird beim Abgleich ignoriert) |
data-<Platzhaltername>-group | Nein | Zahl, die den Wert einer bestimmten Zeile eines Mehrfachgruppen-Feldes zuordnet (ohne Angabe: erste Zeile) |
Hinweis: Fehlt der referenzierte Wert für den aktuellen Vorgang oder das aktuelle Objekt, bleibt nur das betroffene Protokollfeld leer – der Rest des Links funktioniert unverändert.
Hinweis: Ein Protokollfeld vom Typ Mehrfachauswahl erwartet eine Liste von IDs. Diese lässt sich aktuell nur als literale, durch Komma getrennte Zahlenliste übergeben (z. B.
data-auswahl='3,7,12') – eine Wildcard-Referenz auf ein Mehrfachauswahl-Zusatzfeld liefert die im Vorgang hinterlegte Namensliste, keine IDs.
Beispiel
Im Beispiel wird ein Webhook Link für den Webhook mit der ID 1 und den Verantwortlichen (Benutzer) mit der ID 10
erstellt.
Die Kunden Verknüpfung wird aus dem Kunden des Vorgangs gesetzt. Zusätzlich werden die Vorgangs-Referenznummer und der
Name des Kunden-Kontakts automatisch ins Protokoll übernommen.
<docbee_object input='ticket.customer' var='ticketCustomer'>
<docbee_webhooklink id='1' personInChargeId='10' customerId='ticketCustomer.id' ticketId='ticket.id' name='Link zum Webhook' style='color:#ff0000'
data-referenznummer='ticket.referenceNumber' data-ansprechpartner='contact.name' />
</docbee_object>
Bilder
docbee_image
Mit docbee_image können Bilder in die Nachricht eingebunden werden.
Parameter
| Name | Pflichtfeld | Beschreibung |
|---|---|---|
id | Ja | ID des Bildes. Die ID des Bildes wird in der Nachrichtenvorlage angezeigt. |
alt | Nein | Alternativ-Text, der angezeigt wird, falls das Bild nicht geladen werden kann. |
width | Nein | Optionale Breite des Bildes in Pixel. |
height | Nein | Optionale Höhe des Bildes in Pixel. |
Beispiel
Ein Bild mit der ID 1 wird in die Nachricht eingebunden.
<docbee_image id='1' alt='Beispielbild' width='100' height='50' />
Objekt-Beschreibungen
Vorgang
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
ticketNumber | Vorgangs-ID | Text |
referenceNumber | Referenznummer | Text |
customer | Kunde | Objekt Kunde |
location | Standort | Objekt Standort |
contact | Kontakt | Objekt Kontakt |
owner | Verantwortlicher | Objekt Benutzer/Queue |
priority | Priorität | Objekt Priorität |
status | Status | Objekt Status |
department | Abteilung | Objekt Abteilung |
category | Vorgangs-Kategorie | Objekt Vorgangs-Kategorie |
dueDate | Fälligkeit | Datum mit Uhrzeit |
slaDueDate | SLA Fälligkeit | Datum mit Uhrzeit |
description | Beschreibung | Text |
internalDescription | Interne Beschreibung | Text |
docBeeDocuments | Leistungen | Liste Leistung |
protocolDocuments | Protokolle | Liste Protokoll |
referenceNumber | Referenznummer | Text |
externalReferenceNumber | Externe Referenznummer | Text |
erpReferenceNumber | ERP Referenznummer | Text |
billable | Fakturierbar | Bool |
link | HTTP Link zum Vorgang | HTTP Link |
allPlanningTimes | Alle Planungszeiten aller Tätigkeiten der verknüpften Leistungen | Liste Planungszeit |
messages | Nachrichten | Liste Nachricht |
similarTickets | Ähnliche Vorgänge | Liste Vorgang |
similarTicketsSameCustomer | Ähnliche Vorgänge des gleichen Kunden | Liste Vorgang |
urgencyScore | Dringlichkeits-Score des Vorgangs | Gleitkommazahl |
customerObjects | Kunden-Objekte | Liste Kunden-Objekt |
tags | Tags | Liste Tag |
inwardTicketLinks | Über Vorgangs-Verknüpfungen eingehend mit diesem Vorgang verknüpfte Vorgänge | Liste Vorgang |
outwardTicketLinks | Über Vorgangs-Verknüpfungen ausgehend mit diesem Vorgang verknüpfte Vorgänge | Liste Vorgang |
customFields[PLATZHALTER_NAME] | Wert eines benutzerdefinierten Feldes des Vorgangs (Bracket-Notation) | Text |
Leistung
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
documentNumber | Leistungs-ID | Text |
referenceNumber | Referenznummer | Text |
externalReferenceNumber | Externe Referenznummer | Text |
erpReferenceNumber | ERP Referenznummer | Text |
customer | Kunde | Objekt Kunde |
location | Standort | Objekt Standort |
contact | Kontakt | Objekt Kontakt |
personInCharge | Verantwortlicher | Objekt Benutzer/Queue |
priority | Priorität | Objekt Priorität |
ticket | Vorgang | Objekt Vorgang |
tasks | Tätigkeiten | Liste Tätigkeit |
protocolDocuments | Protokolle | Liste Protokoll |
finished | Abgeschlossen? | Bool |
finishedDate | Abschlussdatum | Datum mit Uhrzeit |
approved | Freigegeben? | Bool |
approvalDate | Freigabedatum | Datum mit Uhrzeit |
canceled | Storniert? | Bool |
canceledDate | Stornierdatum | Datum mit Uhrzeit |
completedSuccessfully | Erfolgreich abgeschlossen? | Bool |
drafted | Entwurf? | Bool |
billable | Fakturierbar | Bool |
preFinished | Vorläufig abgeschlossen | Bool |
recordTravelTimeAfterPreFinished | Rückreise erfassen nach vorläufigen Abschluss | Bool |
link | HTTP Link zur Leistung | HTTP Link |
messages | Nachrichten | Liste Nachricht |
tags | Tags | Liste Tag |
customFields[PLATZHALTER_NAME] | Wert eines benutzerdefinierten Feldes der Leistung (Bracket-Notation) | Text |
Protokoll
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
documentNumber | Protokolle-ID | Text |
customer | Kunde | Objekt Kunde |
location | Standort | Objekt Standort |
contact | Kontakt | Objekt Kontakt |
personInCharge | Verantwortlicher | Objekt Benutzer/Queue |
ticket | Vorgang | Objekt Vorgang |
docBeeDocument | Leistung | Objekt Leistung |
template | Protokoll-Muster | Objekt Protokoll-Muster |
finished | Abgeschlossen? | Bool |
finishedDate | Abschlussdatum | Datum mit Uhrzeit |
dueDate | Fälligkeit | Datum mit Uhrzeit |
link | HTTP Link zum Protokoll | HTTP Link |
tags | Tags | Liste Tag |
entries[PLATZHALTER_NAME] | Wert eines Protokoll-Eintrags (Bracket-Notation) | Text |
Protokoll-Muster
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
internalName | Interner Name | Text |
revision | Revision | Nummer |
Tätigkeit
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
description | Beschreibung | Text |
internalDescription | Beschreibung | Text |
dueDate | Fälligkeit | Datum mit Uhrzeit |
contingent | Kontingent | Objekt Kontingent |
serviceType | Leistungsart | Objekt Leistungsart |
planningTimes | Planungszeiten | Liste Planungszeit |
workers | Mitarbeiter | Liste Benutzer |
docBeeDocument | Verknüpfte Leistung | Objekt Leistung |
materials | Materialien | Liste Material |
worklogs | Leistungserfassungen | Liste Leistungserfassung |
customerObjects | Kunden-Objekte | Liste Kunden-Objekt |
Leistungsart
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
number | Nummer | Text |
Kontingent
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
type | Typ | Text (Werte: TIME, MONEY) |
visibleForCustomer | Für Kunden sichtbar? | Bool |
showOnInvoice | Auf Abrechnung anzeigen? | Bool |
deactivate | Deaktiviert? | Bool |
leftOverMoney | Rest-Geldwert | Gleitkommazahl |
leftOverTime | Rest-Zeitwert in Stunden | Gleitkommazahl |
Planungszeit
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
startDate | Start-Datum | Datum mit Uhrzeit |
endDate | End-Datum | Datum mit Uhrzeit |
estimate | Dauer in Stunden | Gleitkommazahl |
type | Typ | Text (Werte: ARRIVAL, RETURN, WORK) |
task | Tätigkeit | Objekt Tätigkeit |
Material
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
serial | Seriennummer | Text |
amount | Menge | Gleitkommazahl |
Kunden-Objekt
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
number | Nummer | Text |
details | Details | Text |
deactivated | Deaktiviert | Bool |
acquisitionDate | Anschaffungstag | Datum mit Uhrzeit |
customer | Kunde | Objekt Kunde |
location | Standort | Objekt Standort |
contact | Kontakt | Objekt Kontakt |
ipAddress | IP-Adresse | Text |
externalAddress | Externe IP-Adresse | Text |
mac1Address | MAC-Adresse 1 | Text |
mac2Address | MAC-Adresse 2 | Text |
mac3Address | MAC-Adresse 3 | Text |
os | Betriebssystem | Text |
servicePack | Service-Pack | Text |
totalMemory | Gesamtspeicher | Text |
role | Rolle | Text |
chassisType | Bauform | Text |
scanCode | Scan-Code | Text |
processorCount | Prozessor-Anzahl | Nummer |
object | Objekt | Objekt Objekt |
parent | Kunden-Objekt | Objekt Kunden-Objekt |
children | Unterobjekte | Liste Kunden-Objekt |
customFields[PLATZHALTER_NAME] | Wert eines benutzerdefinierten Feldes des Kunden-Objekts (Bracket-Notation) | Text |
Objekt
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
objectNumber | Objekt-Nummer | Text |
objectCategory | Objekt-Kategorie` | Objekt Objekt-Kategorie |
customerObjects | Kunden-Objekt | Liste Kunden-Object |
Objekt-Kategorie
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
isMonitored | Unterstützt Monitoring | Bool |
visibleForCustomer | Sichtbar für Kunde | Bool |
withScanCode | Mit Scan-Code | Bool |
Leistungserfassung
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
started | Start-Datum | Datum mit Uhrzeit |
time | Dauer in Stunden | Gleitkommazahl |
comment | Kommentar | Text |
worker | Mitarbeiter | Objekt Benutzer/Queue |
Mandant
| Name | Beschreibung | Typ |
|---|---|---|
name | Name | Text |
shortname | Kürzel | Text |
Status
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
escalated | Eskaliert? | Bool |
Firmierung
| Name | Beschreibung | Typ |
|---|---|---|
name | Name | Text |
street | Straße & Hausnummer | Text |
city | Ort | Text |
zipcode | PLZ | Text |
telephone | Telefonummer | Text |
telefax | Faxnummer | Text |
Vorgangs-Kategorie
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
Wiedervorlage
| Name | Beschreibung | Typ |
|---|---|---|
user | Benutzer | Objekt Benutzer |
ticket | Vorgang | Objekt Vorgang |
date | Name | Datum |
Status-Änderung
| Name | Beschreibung | Typ |
|---|---|---|
status | Status | Objekt Status |
ticket | Vorgang | Objekt Vorgang |
date | Name | Datum mit Uhrzeit |
source | Quelle | Text |
Kunde
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
customerId | Kundennummer | Text |
shortName | Kurzbezeichnung | Text |
wildcardAddress | E-Mail Domain | Text |
inhouse | Inhouse | Bool |
selectable | Auswählbar | Bool |
info | Info | Text |
customFields[PLATZHALTER_NAME] | Wert eines benutzerdefinierten Feldes des Kunden (Bracket-Notation) | Text |
Standort
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
customer | Kunde | Objekt Kunde |
name | Name | Text |
street | Straße & Hausnummer | Text |
city | Ort | Text |
zipcode | PLZ | Text |
telephone | Telefonnummer | Text |
isDefault | Standard-Standort | Bool |
customFields[PLATZHALTER_NAME] | Wert eines benutzerdefinierten Feldes des Standorts (Bracket-Notation) | Text |
Kontakt
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
customer | Kunde | Objekt Kunde |
location | Standort | Objekt Standort |
name | Name | Text |
email | Text | |
mobile | Mobilnummer | Text |
telephone | Telefonnummer | Text |
telefax | Faxnummer | Text |
labeling | Bezeichnung | Text |
info | Info | Text |
isDocumentContact | Ist Standard-Dokumenten Kontakt | Bool |
customFields[PLATZHALTER_NAME] | Wert eines benutzerdefinierten Feldes des Kontakts (Bracket-Notation) | Text |
Benutzer/Queue
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
email | Text | |
username | Benutzername | Text |
telephone | Telefonummer | Text |
mobile | Mobilenummer | Text |
type | Mobilenummer | Text (Werte: USER, QUEUE, SERVICE_PROVIDER, CUSTOMER) |
department | Abteilung | Objekt Abteilung |
serviceProvider | Externer Dienstleister | Objekt Externer Dienstleister |
customFields[PLATZHALTER_NAME] | Wert eines benutzerdefinierten Feldes des Benutzers (Bracket-Notation) | Text |
Priorität
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
Abteilung
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
Externer Dienstleister
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
shortName | Kurzname | Text |
number | Nummer | Text |
email | Text | |
customFields[PLATZHALTER_NAME] | Wert eines benutzerdefinierten Feldes der Externen Dienstleisters (Bracket-Notation) | Text |
Nachricht
| Name | Beschreibung | Typ |
|---|---|---|
content | Inhalt | Text |
subject | Betreff | Text |
receivedDate | Datum | Datum mit Uhrzeit |
Benachrichtungs-Nachricht
| Name | Beschreibung | Typ |
|---|---|---|
message | Nachricht | Text |
shortMessage | Nachricht (Kurzform) | Text |
Tagesabschluss-Daten
| Name | Beschreibung | Typ |
|---|---|---|
timeLogged | Zeit in Stunden, die protokolliert wurde | Gleitkommazahl |
timeRemaining | Zeit in Stunden, die noch fehlen | Gleitkommazahl |
timeRequired | Zeit in Stunden, wie viel mindestens gebucht werden musste. | Gleitkommazahl |
date | Tagesabschluss-Datum | Datum |
link | Link zum Tagesabschluss | HTTP Link |
Abwesenheit
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
startDate | Start-Datum | Datum mit Uhrzeit |
endDate | End-Datum | Datum mit Uhrzeit |
status | Status | Text |
user | Abwesender | Objekt Benutzer |
reason | Grund | Objekt Abwesenheits-Grund |
link | Link zur Abwesenheit | HTTP Link |
Abwesenheits-Grund
| Name | Beschreibung | Typ |
|---|---|---|
id | Interne DocBee ID | Text |
name | Name | Text |
needsApproval | Freigabe benötigt? | Bool |
needsDailyClosing | Tagesabschluss benötigt? | Bool |
Abwesenheit-Status-Änderung
| Name | Beschreibung | Typ |
|---|---|---|
date | Datum der Änderung | Datum mit Uhrzeit |
name | Name | Text |
comment | Kommentar | Text |
user | Benutzer, der die Status-Änderung erzeugt hat | Objekt Benutzer |
away | Abwesenheit | Objekt Abwesenheit |
Zeitraum-Planung Prüfung
| Name | Beschreibung | Typ |
|---|---|---|
name | Name | Text |
startDate | Start-Datum | Datum |
endDate | End-Datum | Datum |
personInCharge | Verantwortlicher für die Prüfung | Objekt Benutzer |
Nachricht
| Name | Beschreibung | Typ |
|---|---|---|
subject | Betreff | Text |
content | Text-Inhalt | Text |
htmlContent | HTML-Inhalt | Text |
sender | Sender | Text |
ticket | Vorgang | Objekt Vorgang |
docBeeDocument | Leistung | Objekt Leistung |
Hinweis: Im HTML-Inhalt sind auch die Bilder enthalten, die in der Nachricht verwendet werden, um diese beispielsweise an einen KI-Agenten zu übergeben.
Nachrichten Ablage
| Name | Beschreibung | Typ |
|---|---|---|
name | Nachrichten Ablage Name | Text |
docBeeDocuments | Leistungen | Liste Leistung |
protocolDocuments | Protokolle | Liste Protokoll |
tickets | Vorgänge | Liste Vorgang |
messages | Nachrichten | Liste Nachricht |
Mail-Parser
In DocBee können sogenannte Mail-Parser hinterlegt werden. Ein Mail-Parser wird nachträglich mit einer Funktion verknüpft und beginnt erst danach mit der Ausführung.
Die Standard Funktion für Mail-Parser ist "Mail zu Vorgang". Dafür muss, nachdem der Mail-Parser angelegt wurde, die Verknüpfung in den Vorgangs Einstellungen vorgenommen werden.
Hinweis: Sofern Sie Nachrichten an ihr DocBee Postfach weiterleiten wollen, achten Sie darauf, den Absender beizubehalten, da sich die automatische Kundenzuordnung in DocBee am Absender orientiert.
Feldbeschreibungen
Generell
| Feld | Beschreibung |
|---|---|
| Name | Definiert den internen Namen des, als Mail Parser angelegten, Postfachs |
| Protokoll |
|
| Sender Email | Definiert die Email, die als Versender für Antworten genutzt wird. Die Sender Email Adresse sollte entweder direkt als Email-Adresse z.B. email@ihredomain.de oder im Format 'Name' <email@ihredomain.de> angegeben werden. Wichtig: Der eingestellte Mail-Server unter Administration > Nachrichten > Einstellungen muss die Berechtigung haben, die Email für diesen Sender zu verschicken |
| Sender Email Aliase | Hier kann eine Liste von Weiterleitungen und Alias-Adressen der Sender-E-Mail Adresse hinterlegt werden. Diese E-Mail-Adressen werden beim Versand aus DocBee ignoriert, um keine Endlossschleife beim Mail-Parser zu erzeugen. Die Trennung mehrerer Postfächer erfolgt mit einem Semikolon ohne Leerzeichen. |
| Verarbeitungsmodus | Definiert wie eine Mail verarbeitet wird (Siehe Verarbeitungsmodus) |
| Automatische Emails filtern | Wird die Einstellung aktiviert, so werden automatische E-Mails, wie z.B. Abwesenheitsnotizen beim Eingang gefiltert, damit dazu kein Vorgang aktualisiert bzw. neu angelegt wir. Hinweis: Automatische E-Mails werden nur gefiltert, falls diese vom Sender über einen entsprechenden Header markiert wurden. Für andere E-Mails benutzen Sie die weiteren "Lesen Filter". |
| Automatische Emails Antwort Filter | Wird die Einstellung aktiviert, wird keine automatische Antwort aus DocBee auf automatische E-Mails, wie z.B. Abwesenheitsnotizen aus DocBee gesendet. Dies kann Endlossschleifen beim Mail-Parser vermeiden. |
| E-Mail-Adresse Antwort Filter (RegEx) | Hier kann ein Regulärer Ausdruck (RegEx) eingegeben werden, um keine Antwort zu schicken, falls die E-Mail Adresse dem Regulären Ausdruck entspricht. (Groß- und Kleinschreibung wird nicht beachtet) |
| E-Mail-Adresse Antwort Filter (Liste) | Hier kann eine Liste von Adressen eingegeben werden um keine Antwort zu schicken falls die E-Mail Adresse in der Liste vorkommt. (Groß- und Kleinschreibung wird nicht beachtet) |
| Betreff Antwort Filter (RegEx) | Hier kann ein Regulärer Ausdruck (RegEx) eingegeben werden, um keine Antwort zu schicken, falls der E-Mail Betreff dem Regulären Ausdruck entspricht. (Groß- und Kleinschreibung wird nicht beachtet) |
| E-Mail-Adresse Lesen Filter (RegEx) | Hier kann ein Regulärer Ausdruck (RegEx) eingegeben werden, um aus dieser E-Mail keinen Vorgang zu erzeugen oder zu aktualisieren, falls die E-Mail Adresse dem Regulären Ausdruck entspricht. (Groß- und Kleinschreibung wird nicht beachtet) |
| E-Mail-Adresse Lesen Filter (Liste) | Hier kann eine Liste von Adressen eingegeben werden um aus dieser E-Mail keinen Vorgang zu erzeugen oder zu aktualisieren falls die E-Mail Adresse in der Liste vorkommt. (Groß- und Kleinschreibung wird nicht beachtet) |
| Betreff Lesen Filter (RegEx) | Hier kann ein Regulärer Ausdruck (RegEx) eingegeben werden, um keinen Vorgang zu erzeugen oder zu aktualisieren, falls der E-Mail Betreff dem Regulären Ausdruck entspricht. (Groß- und Kleinschreibung wird nicht beachtet) |
Protokoll
IMAP / IMAPS
| Feld | Beschreibung |
|---|---|
| Serveradresse | Die URL oder IP Adresse des Mail-Servers. WICHTIG: Hier darf kein Protokoll angegeben werden |
| Port | Port des Mail-Servers (Standard IMAP: 143, IMAPS: 993) |
| Benutzername | Der Benutzername des Postfachs |
| Passwort | Das Passwort des Postfachs |
Exchange
| Name | Beschreibung |
|---|---|
| Exchange Version | Ihre eingesetzte Exchange Version |
| Serveradresse | Die URL oder IP Adresse der Exchange EWS Schnittstelle. Hinweis: Hier wird das Protokoll ( https://) benötigt. Normalweise hat die Adresse folgenden Aufbau https://www.ihredomain.de/ews/Exchange.asmx |
| Alle Zertifikate erlauben | Falls dies aktiviert wird, wird die Zertifikatsprüfung deaktiviert um auch Selfsigned Zertifikate zu erlauben. Hinweis: Wir empfehlen nicht die Deaktivierung der Zertifikatsprüfung |
| Benutzername | Benutzername Wichtig:Der Benutzer muss die Berechtigung haben, für die oben eigetragene Sender E-Mail Adresse E-Mails zu versenden. |
| Passwort | Passwort des Benutzers |
Office 365 / MS 365 (MS Graph)
| Name | Beschreibung |
|---|---|
| Anwendungs-ID (Client) | Die Anwendungs-ID (Client) Microsoft Azure -> App-Registrierungen -> Anwendung -> Übersicht |
| Geheimer Clientschlüssel | Der Geheime Clientschlüssel aus Microsoft Azure -> App-Registrierungen -> Anwendung -> Zertifikate & Geheimnisse |
| Verzeichnis-ID (Mandant) | Die Verzeichnis-ID (Mandant) aus Microsoft Azure -> App-Registrierungen -> Anwendung -> Übersicht |
Hinweis: Die Anwendung benötigt zum Empfangen von E-Mails die Berechtigung
Mail.Read.
Hinweis: Weitere Informationen zur Anbindung über MS Graph finden Sie unter Microsoft Graph Schnittstelle
Verarbeitungsmodus
Gelesen
Beim Verarbeitungsmodus Gelesen werden alle ungelesen E-Mails von DocBee aus dem Posteingang verarbeitet und nach der
Verarbeitung aufgelesen gesetzt.
Wichtig: Stellen Sie daher sicher, dass keine andere Person oder kein anderer Dienst die E-Mails abgreift und diese dadurch evtl. vor dem Abruf durch DocBee den Status "gelesen" erhalten.
Verschieben
Beim Verarbeitungsmodus Verschieben werden alle E-Mails, die im Posteingang sind, von DocBee verarbeitet und nach der
Verarbeitung in den Zielordner verschoben.
Wichtig: Der Zielordner muss sich auf der obersten Ebene befinden damit DocBee die E-Mails verschiebt
Hinweis: Falls Sie den Verarbeitungsmodus ändern, sollten sie den Posteingang vollständig in den Zielordner verschieben.
Nachrichten Ablage
In DocBee können sogenannte Nachrichten Ablagen erzeugen. Diese Nachrichtenablagen können verwendet werden, um über die Regeln Vorgänge, Leistungen, Protokolle oder Nachrichten zur Ablage hinzufügen, um eine Sammelnachricht zu erzeugen.
Wichtig: Der Inhalt der Sammel-Nachricht kann über die Nachrichten-Vorlage konfiguriert werden unter der Verwendung
der Nachrichten Logik
Hinweis: Nach jedem Versenden wird die Ablage geleert und kann dann wieder befüllt werden.
Feldbeschreibungen
Generell
| Feld | Beschreibung |
|---|---|
| Name | Definiert den Namen der Nachrichten Ablage |
| Sende Uhrzeit | Wann soll die Nachricht verschickt werden? |
| Empfänger | Welche Benutzer soll die Nachricht erhalten? |
| Sende E-Mail | Soll die Ablage via E-Mail verschickt werden? |
| E-Mail Nachrichten-Vorlage | E-Mail Nachrichten Vorlage |
| Sende Benachrichtung | Soll die Ablage via Benachrichtigung verschickt werden? |
| Benachrichtigung Nachrichten-Vorlage | Benachrichtigung Nachrichten Vorlage |
Beispiel-Nachrichten Vorlage
Hier ein Beispiel für eine Nachrichten Ablage, die geänderte Vorgänge enthält und gesammelt als E-Mail verschickt wird.
Sehr geehrte Damen und Herren,
folgende Vorgänge haben sich geändert:
<docbee_each input="bucket.tickets" var="ticket">
%ticket.ticketNumber%
-------------------------------
%ticket.description%
</docbee_each>
Mit freundlichen Grüßen
Ihr DocBee Team
FAQ
Warum verschickt DocBee keine E-Mails?
Um das Problem zu lösen, prüfen Sie bitte folgende Schritte
- Ist der E-Mail Versand überhaupt aktiviert? Prüfen Sie die Option
AktiviertunterAdministration > Nachrichten > Einstellungen > Mail-Server. Ist sie deaktiviert, verschickt DocBee keine E-Mails und erzeugt dabei auch keinen Fehler im Fehlerprotokoll (siehe Deaktivierter E-Mail Versand). - Wurden die Nachrichten-Mail-Server-Einstellungen hinterlegt?
- Wird die Test E-Mail
Administration > Nachrichten > Einstellungen > E-Mail Einstellungen prüfenerfolgreich verschickt? - Prüfen Sie, ob im Fehlerprotokoll ein Mail Fehler vorliegt.
Warum wird im Fehlerprotokoll angezeigt, dass E-Mails nicht verschickt werden konnten, obwohl einige E-Mails verschickt werden?
Eine mögliche Ursache für dieses Problem ist, dass Ihr Mail-Server nicht im Namen von bestimmten Mail-Parser verschicken darf. Überprüfen Sie Ihre Einstellungen, ob der E-Mail Versender im Namen der Mail-Parser verschicken darf.
Wie und wann genau kann man eine Sender-Mailadresse anstatt der der Standart Mailadresse aus den Mail-Server-Einstellungen verwenden?
Um Vorgänge und Leistungsnachweise mit der korrekten Mail-Adresse zu versenden, müssen die Einstellungen des Mail-Parsers angepasst werden. Der Parser muss so konfiguriert werden, dass er die richtige Mail-Adresse für jeden Vorgang und Leistungsnachweis verwendet. Darüber hinaus muss die bearbeitende Fakultät als Absender der Mail angegeben werden.
Dies ist also abhängig von der Mail Parser Konfiguration im Vorgangsbereich (Administration > Vorgänge > Mail Parser Konfiguration). Hier wird der entsprechende Mail Parser hinterlegt.
Warum bekommen ich keine Verbindung zu meinem lokalen Exchange Server?
Um das Problem zu lösen, prüfen Sie bitte folgende Schritte
- Wurden die korrekten Einstellungen für den Exchange-Server hinterlegt?
- Ist die EWS-API aktiviert und ist ein Zugriff über die URL
https://<ihredomain>/ews/Exchange.asmxmöglich? (Dort sollte eine Anmeldemaske erscheinen) - Prüfen Sie, ob im Fehlerprotokoll ein Mail Fehler vorliegt.
Meine Exchange Server Daten sind korrekt bekomme aber trotzdem ein HTTP Status 404 zurückgeliefert im Fehlerprotokoll?
Bitte überprüfen Sie ob der OnPremises Server wirklich über IIS kommuniziert oder über HTTP.SYS.
Am einfachsten lässt sich dies über einen curl -v https://<ihredomain>/ews/Exchange.asmx vom Server überprüfen, falls im Server Header Microsoft-IIS/x.x steht wird IIS verwendet, falls dort Microsoft-HTTPAPI/2.0 steht wird HTTP.SYS verwendet.
Beim letzten Fall muss entweder der Zugriff über IIS umgeleitet werden, oder im HTTP.SYS der Pfad /ews/Exchange.asmx freigegeben werden.
Warum erscheint die Fehlermeldung "503 – Command Concurrency Limit Reached" oder "503 – null"?
Diese Fehler werden direkt von der Microsoft Graph API zurückgegeben und betreffen sowohl den Mail-Versand als auch den Mail-Parser über Office 365 / MS 365. Sie bedeuten, dass Microsofts Server temporär überlastet sind oder interne Kapazitätsgrenzen überschritten wurden.
Der Fehler entsteht auf der Seite von Microsoft und liegt außerhalb des Einflussbereichs von DocBee. Sobald Microsoft das Problem behoben hat, stellt sich die Verbindung automatisch wieder her – eine Änderung in DocBee ist nicht notwendig.
Um das Problem einzugrenzen bzw. an Microsoft zu melden, prüfen Sie bitte folgende Schritte
- Prüfen Sie unter status.office365.com, ob Microsoft eine aktuelle Störung gemeldet hat. Die Seite ist ohne Anmeldung zugänglich.
- Stellen Sie bei Bedarf eine Serviceanfrage direkt bei Microsoft über das Microsoft 365 Admin Center unter
Support > Neue Serviceanfrage. Hierfür werden Administratorrechte benötigt. - Notieren Sie Zeitpunkt und exakte Fehlermeldung, um die Anfrage bei Microsoft so präzise wie möglich beschreiben zu können.
Warum fehlt bei einem über den Mail-Parser erzeugten Vorgang der Standort?
Der Mail-Parser übernimmt nur den Standort, dem der gefundene Kontakt zugeordnet ist. Um das Problem zu lösen, prüfen Sie bitte folgende Schritte
- Ist die Absenderadresse der eingegangenen E-Mail bei einem Kontakt hinterlegt? Nur dann setzt der Mail-Parser Kunde und Kontakt am Vorgang.
- Ist bei diesem Kontakt das Feld
Standortgefüllt? Ist es leer, bleibt auch der Standort des Vorgangs leer – auch dann, wenn beim Kunden ein Standort als Standard-Adresse markiert ist. - Wählen Sie den Standort in diesem Fall nachträglich im Vorgang aus, oder ordnen Sie den Kontakt dauerhaft einem Standort zu.
In der Weboberfläche ist das bewusst anders: Dort wird die Standard-Adresse vorbelegt, sobald der Kunde feststeht – auch dann, wenn Sie nur den Kontakt auswählen. Diese Vorbelegung können Sie vor dem Speichern prüfen und korrigieren, beim Mail-Parser ist das nicht möglich.