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
Typ	Normal TLS SSL Exchange => Unterstützt wird Microsoft Exchange ab 2007 SP1 Office 365 (MS Graph)
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

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.

1. Melden Sie sich unter https://www.messagebird.com an.
2. Öffnen Sie den Menüpunkt Entwickler.
3. Wählen Sie dort API-Zugang aus.
4. Danach klicken Sie auf Zugangsschlüssel hinzufügen
5. Im Dialog geben Sie einen Namen (Beschreibung) für den API Key an z.B. DocBee und wählen den Typ Live.
6. Danach können Sie in der Liste über Schlüssel anzeigen den Key kopieren (Dieser muss als Access Key in DocBee eingetragen werden).
7. Fertig.

Hinweis: MessageBird gibt die Möglichkeit, kostenlose Test SMS zu verschicken. Dies funktioniert aber nur an die Telefonnummer, die im Konto hinterlegt ist.

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.

Hinweis: Die Standard-Emails werden von DocBee als Multipart E-Mails verschickt und benötigen deswegen sowohl einen Text als auch einen HTML-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.	Der in der Leistung eingetragene Kunden-Kontakt, wenn bei diesem Kontakt Sende Email (Ausgewählt) aktiviert ist. Alle Kunden-Kontakte des Kunden, bei welchen in den Einstellungen Sende Email 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

Abschluss (Protokoll)

Auslöser	Empfänger
Abschluss des Protokolls	Der im Protokoll eingetragene Kunden-Kontakt, wenn bei diesem Kontakt Sende Email (Ausgewählt) aktiviert ist. Alle Kunden-Kontakte des Kunden, bei welchen in den Einstellungen Sende Email aktiviert ist. Weitere E-Mail Empfänger aus dem Protokoll-Muster.

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.	Absender der E-Mail.

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.	Absender der E-Mail.

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.)	Absender der Original-Nachricht und zusätzlich manuell hinterlegte Empfänger bzw. CC-Empfänger

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.)	Absender der Original-Nachricht und zusätzlich manuell hinterlegte Empfänger bzw. CC Empfänger

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	Die ausgewählten Benutzer

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.	Die ausgewählten Benutzer

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	Der zugehörige Beobachter

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	Der zugehörige Beobachter

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	Der in der Leistung eingetragene Kunden-Kontakt, wenn bei diesem Kontakt Sende Email (Ausgewählt) aktiviert ist. Alle Kunden-Kontakte des Kunden, bei welchen in den Einstellungen Sende Email 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	In der Nachrichten Ablage hinterlegten Empfänger

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.)	Die hinterlegten Empfänger im Nachrichten Dialog

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)	Die hinterlegten Empfänger in der Regel.

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.	Benutzer des Tagesabschluss, der nicht erfolgt ist. Eventuell hinterlegte CC.

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.)	Die hinterlegten Empfänger im Nachrichten-Dialog

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.	E-Mail des Kunden-Kontakts des Vorgangs, falls Email an Kunden im Status aktiviert ist. E-Mail des Verantwortlichen des Vorgangs, falls Email an Verantwortlichen im Status aktiviert ist.

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	Der in der Leistung eingetragene Kunden-Kontakt, wenn bei diesem Kontakt Sende Email (Ausgewählt) aktiviert ist. Alle Kunden-Kontakte des Kunden, bei welchen in den Einstellungen Sende Email 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

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.	Verantwortlicher eines Planungs-Eintrags, falls Prüfung benötigt aktiviert 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.)	Manuell hinterlegte Empfänger bzw. CC-Empfänger

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.)	Manuell hinterlegte Empfänger bzw. CC-Empfänger

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.	Benutzer, der die Wiedervorlage erstellt hat.

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.	Der Vorgang der Wiedervorlage.

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.	Verantwortlicher der Leistung.

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.	Mitarbeiter der Tätigkeit.

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.	Verantwortlicher des Vorgangs.

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 Platzhalter ist unter der Nachrichtenvorlage zu finden.

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%

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>

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öglichkeit die Sortierreihenfolge über die Attribute sort und ascending 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) aufsteigenden (ascending='false') sortiert. 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'>
    %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
name	Nein	Optionaler Name des Links

*Bei Protokoll-Webhooks muss die personInChargeId und die customerId gesetzt werden und Queues sind nicht erlaubt als Verantwortlicher

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.

<docbee_object input='ticket.customer' var='ticketCustomer'>
    <docbee_webhooklink id='1' personInChargeId='10' customerId='ticketCustomer.id' name='Link zum Webhook' />
</docbee_object>

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

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

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

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

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

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

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

Kontakt

Name	Beschreibung	Typ
id	Interne DocBee ID	Text
customer	Kunde	Objekt Kunde
location	Standort	Objekt Standort
name	Name	Text
email	E-Mail	Text
mobile	Mobilnummer	Text
telephone	Telefonnummer	Text
telefax	Faxnummer	Text
labeling	Bezeichnung	Text
info	Info	Text
isDocumentContact	Ist Standard-Dokumenten Kontakt	Bool

Benutzer/Queue

Name	Beschreibung	Typ
id	Interne DocBee ID	Text
name	Name	Text
email	E-Mail	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

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	E-Mail	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	Inhalt	Text
sender	Sender	Text
ticket	Vorgang	Objekt Vorgang
docBeeDocument	Leistung	Objekt Leistung

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	IMAP IMAPS Exchange Office 365 (MS Graph)
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 wird.
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)
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)
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

1. Wurden die Nachrichten-Mail-Server-Einstellungen hinterlegt?
2. Wird die Test E-Mail Administration > Nachrichten > Einstellungen > E-Mail Einstellungen prüfen erfolgreich verschickt?
3. 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.