E-Mail: über Benutzeroberfläche erstellen und versenden

Interne ID: agorum.mail.ui

Mit diesem Knoten erstellen Sie über eine Bedienoberfläche eine neue E-Mail und legen diese entweder als Entwurf ab oder versenden sie direkt. Hierzu verwendet der Knoten die Parameter, die im Datenobjekt der Datenvariable angegeben wurden.

Aussehen des Knotens

Verhaltensweise

Erreicht das System den Knoten, zeigt es dem Benutzer eine Bedienoberfläche, mit der eine neue E-Mail aus dem Workflow heraus verfasst und versandt werden kann. Dabei ist es möglich, die Bearbeitungsmöglichkeiten der Bedienoberfläche einzuschränken und über die Datenvariable mit vordefinierten Werten zu initialisieren. Vor Anzeige der Bedienoberfläche prüft das System die Daten der Datenvariable zunächst in einer einfachen Validierung. Wird die Eingabe in der Bedienoberfläche erfolgreich abgeschlossen und die E-Mail versandt oder als Entwurf gespeichert, erfolgt noch einmal eine strikte Validierung. Verlassen wird der Workflow über das entsprechende Outlet, das der Aktion zugeordnet ist:

Outlet	Beschreibung
sent	Wird angesteuert, wenn die E-Mail gesendet wurde.
draftSaved	Wird angesteuert, wenn die E-Mail als Entwurf gespeichert wurde.
canceled	Wird angesteuert, wenn die Bedienoberfläche abgebrochen wurde.

Das erzeugte E-Mail-Objekt wird in der Ergebnisvariable zurückgegeben.

Folgenden Angaben sind für den E-Mail-Versand verpflichtend:

Empfänger
Betreff

Endpoints

Standard	Veränderbar?	Weitere Endpoints möglich?
Default (Inlet)	Nein, kann nur ausgeblendet werden.	nicht nötig
Default (Outlet)	Nein, kann nur ausgeblendet werden.	nicht nötig

Parameter

Parameter	Beschreibung	Beispiel
Editier-Optionen	Deaktiviert verschiedene Elemente in der Bedienoberfläche. Sie können einzelne Eingabefelder (de-)aktivieren, um die Benutzereingaben auf bestimmte Felder zu begrenzen. Sie können Aktionen steuern, mit denen die Bedienoberfläche abgeschlossen werden kann. Der Benutzer darf alle Optionen bearbeiten, die angehakt wurden, und kann nur aktivierte Aktionen ausführen.	Editier-Optionen
Datenvariable	Definiert die Variable, in der das Datenobjekt liegt, aus dem die E-Mail-Knoten alle nötigen Parameter erhalten, um die E-Mail zu verarbeiten. Das Parameterobjekt besteht aus den gleichen Parametern, wie sie auch in der JavaScript-Bibliothek common/mail verwendet werden. Der Parameter attachments wird über die Eingangsvariable des jeweiligen Knotens abgebildet.	Datenvariable
buttons	Entfernt alle Standard-Schaltflächen und ermöglicht es, eigene Schaltflächen zu gestalten. 3 vordefinierte Outlets existieren, die die internen Standard-Funktionen auslösen: send, draft, cancel. Wenn Sie einen dieser vordefinierten Outlet-Namen verwenden, geschieht dasselbe wie bei den Standard-Schaltflächen.	buttons
Eingangsvariable	Definiert die Variable, die ein Array von Elementene enthält, die mit diesem Knoten als E-Mail-Anhänge verarbeitet werden sollen. Wenn Sie die Variable nicht angeben, verwendet das System automatisch die Anhänge des Workflows aus der internen Variable sys_acw_attachments.	Eingangsvariable
Ergebnisvariable	Definiert die Variable, die das Ergebnis des Knotens enthält, in diesem Fall ein Array mit der UUID des erzeugten E-Mail-Objekts. Wenn Sie die Variable nicht angeben, wird das Ergebnis nicht im Token abgelegt.	Ergebnisvariable
Beschreibung	Definiert die Beschreibung, die das System im Workflow anzeigt (in den jeweiligen Listen).	–
Automatisches Annehmen	Definiert, ob die UI-Maske automatisch vom Benutzer angenommen wird, wenn dieser eine Eingabe in der Oberfläche tätigt. Gilt für Masken, die an mehrere Benutzer gleichzeitig gerichtet sind. Im Standard ist der Parameter aktiviert.	–
Benutzer/Gruppe (Bearbeiter)	Setzt die definierten Benutzer / Benutzergruppen des passierenden Tokens als Bearbeiter des Workflowschritts und aller nachfolgenden Schritte inklusive Zugriff auf die Anhänge des Workflows. Haben Sie eine Benutzergruppe als Bearbeiter gesetzt, darf jedes Mitglied aus dieser Benutzergruppe den Workflow annehmen, bearbeiten und abgeben.	Benutzer/Gruppe (Bearbeiter)
Benutzer/Gruppe (Betrachter)	Setzt die definierten Benutzer / Benutzergruppen als Betrachter des Workflowschritts und aller nachfolgenden Schritte inklusive Zugriff auf die Anhänge des Workflows. Haben Sie eine Benutzergruppe als Betrachter gesetzt, darf jedes Mitglied aus dieser Benutzergruppe den Workflowschritt bei Bedarf annehmen, bearbeiten und abgeben.	Benutzer/Gruppe (Betrachter)

buttons

Im Editor

Im Editor legen Sie über einen neuen Eintrag für eine Schaltfläche an.

Feld	Beschreibung
Outlet	Definiert den Ausgang (das Outlet des Knotens), den der Workflow nimmt, wenn ein Benutzer diese Schaltfläche in der Bedienoberfläche anklickt. Der Name muss eindeutig sein. Sie müssen das Outlet erst am Knoten erstellen, damit das System es finden kann. Wenn Sie eine der 3 Standard-Outlets (send, draft, cancel) verwenden, löst der Workflow die jeweilige Standard-Aktion aus und der Workflow verlässt den Knoten über die bereits definierten Outlets (sent, draftSaved, canceled). Bei allen anderen Outlet-Namen können Sie ein eigenes Outlet definieren und implementieren und somit eigene Aktionen auslösen.
Text (optional)	Definiert den Text, der auf der Schaltfläche erscheint. Wenn Sie keinen Text definieren, müssen Sie ein Icon (über das Feld Icon) definieren. Icon und Text können Sie kombinieren, d. h. Sie können beide verwenden.
Icon (optional)	Definiert das Icon, das auf der Schaltfläche erscheint. Wenn Sie kein Icon definieren, müssen Sie einen Text (über das Feld Text) definieren. Icon und Text können Sie kombinieren, d. h. Sie können beide verwenden.
Validieren	Aktiviert Alle Werte in den Feldern der Bedienoberfläche müssen valide sein, ansonsten kann die Schaltfläche nicht angeklickt werden und bleibt grau. Deaktiviert Die Bedienoberfläche kann über die Schaltfläche auch verlassen werden, ohne dass die Werte valide sein müssen.
Ausrichtung	Definiert, ob die Schaltfläche in der Bedienoberfläche links oder rechts erscheint. Die Schaltflächen erscheinen in der definierten Reihenfolge jeweils auf links und rechts aufgeteilt. Wenn Sie keine Ausrichtung definieren, ist der Standard rechts.

Als Expression

Die Schaltflächen können Sie programmatisch über eine Expression setzen.

Format

[
  {
    outlet: 'next',
    text: 'Next',
    icon: 'aguila-icon cancel',
    validate: true,
    alignment: 'right'
  }
]

Sie können etwa solche Schaltflächen über den Knoten Skript erstellen, der dem Knoten metadata collection form vorangestellt ist. Der Inhalt eines solchen Skript-Knotens sieht etwa folgendermaßen aus:

token.variables.myButtons = [
  {
    outlet: 'next',
    text: 'Next',
    icon: 'aguila-icon cancel',
    validate: true,
    alignment: 'right'
  }
];

Als Expression geben Sie Folgendes an:

token.variables.myButtons

Hinweis: Schaltflächen können Sie nur als Expression programmatisch setzen.

Editier-Optionen

Aktionen

Aktion	Beschreibung
E-Mail absenden	Versendet die E-Mail im Anschluss und erscheint nur, wenn Sie keine eigenen Schaltflächen (über den Parameter buttons) definiert haben.
E-Mail abspeichern	Speichert die E-Mail im Anschluss als Entwurf und erscheint nur, wenn Sie keine eigenen Schaltflächen (über den Parameter buttons) definiert haben.
Versand abbrechen	Bricht die Eingabe ab und erscheint nur, wenn Sie keine eigenen Schaltflächen (über den Parameter buttons) definiert haben.

Hinweis: Mindestens eine der Aktionen muss zwingend aktiviert werden, da der Benutzer die Bedienoberfläche sonst nicht mehr abschließen und verlassen kann, oder Sie müssen eigene Schaltflächen (buttons) definiert haben.

Eingabefelder

Eingabefeld	Beschreibung
Empfänger	Definiert den oder die Empfänger der E-Mail.
Empfänger (Kopie / CC)	Definiert den oder die Empfänger der E-Mail-Kopie.
Empfänger (Blind-Kopie / BCC)	Definiert den oder die Empfänger der E-Mail-Blind-Kopie.
Antwort an	Definiert die E-Mail-Adresse(n) für die Antwort.
Betreff	Definiert den Betreff der E-Mail.
Inhalt	Definiert den Inhalt der E-Mail.
Anhänge	Definiert die Anhänge der E-Mail.

Datenvariable

Im Editor

Im Editor geben Sie den Namen der Workflow-Variable an. Das System platziert die Variable automatisch in der Variable des Tokens (token.variables). Das Datenobjekt mit den darin enthaltenen Parametern erstellen Sie über den Knoten E-Mail: Daten vorbereiten.

mail.data

Als Expression

Wenn Sie diesen Parameter als Expression angeben, geben Sie den vollständigen Pfad zur Variable an, von der das System den eigentlichen Namen der gewünschten Variable lesen soll.

'token.variables.' + 'mail.' + 'data'
'token.variables.mail.data'

Das Ergebnis der Expression lautet jeweils:

'token.variables.nameOfMailData'

Der Inhalt der angegebenen Variable wird für die Verarbeitung von diesem Knoten verwendet.

Aufbau des Datenobjekts

variables: {
   ...
   sys_acw_attachments: [],

mail: {
      data: {
         from: 'user@your.domain', // Absender-Adresse
         to: [ 'to@your.domain' ],  // Array der Empfänger-Adressen
         cc: [ 'cc@your.domain' ], // Array der CC-Empfänger-Adressen
         bcc: [ 'bcc@your.domain' ], // Array der BCC-Empfänger-Adressen
         subject: 'Betreff',
         body: 'Mail-Inhalt, auf mit HTML möglich',
      
         replyTo: 'antwort@your.domain',

         // Absender der Mail, Beispiel: objects.find('user:demo')
         user: <agorum user>,

         // RFC822MessageId der E-Mail, auf die geantwortet wurde
         inReplyTo: 'b290204d-3b19-4332-9926-95521537cce9@your.domain'
      }
   },
   ...
}

Eingangsvariable

Für generelle Schreibweise von Variablen im Editor oder als Expression siehe Schreibweise von Variablen.

Im Editor

Im Editor geben Sie den Namen der Workflow-Variable an. Das System platziert die Variable automatisch in der Variable des Tokens (token.variables).

inputVariable

Als Expression

Wenn Sie diesen Parameter als Expression angeben, geben Sie den vollständigen Pfad zur Variable an, von der das System den eigentlichen Namen der gewünschten Variable lesen soll.

'token.variables.nameOfInputVariable'

Ergebnisvariable

Für generelle Schreibweise von Variablen im Editor oder als Expression siehe Schreibweise von Variablen.

Im Editor

Im Editor geben Sie den Namen der Workflow-Variable an. Das System platziert die Variable automatisch in der Variable des Tokens (token.variables).

resultVariable

Als Expression

Wenn Sie diesen Parameter als Expression angeben, geben Sie den vollständigen Pfad zur Variable an, von der das System den eigentlichen Namen der gewünschten Variable lesen soll.

'token.variables.nameOfResultVariable'

Benutzer/Gruppe (Bearbeiter)

Im Editor

Im Editor wählen Sie die entsprechenden Benutzer / Benutzergruppen, die Sie als Bearbeiter setzen wollen.

Als Expression

Als Expression können Sie zuvor definierte Variablen setzen, etwa solche, die Sie über einen vorherigen Skript-Knoten definiert haben:

Aufbau der Variable / Zugriff auf die Variable

token.variables.sampleRecipient

Zugriff auf mehrere Variablen über ein Array

[ token.variables.sampleRecipient, token.variables.testAssign ]

Beispiel eines solchen Skript-Knotens inklusive Beispiel, wie Sie die Rechte auf Anhänge vergeben können, siehe Rechte als Expression vergeben.

Benutzer/Gruppe (Betrachter)

Dieser Parameter dient dazu, einen Stellvertreter, etwa eine Urlaubsvertretung, zu definieren. Die Benutzer oder Benutzergruppen, die Sie als Betrachter wählen, können jeden Schritt eines Workflows nachvollziehen und etwa bei Bedarf Auskunft geben. Bei Bedarf können Sie in den Workflow eingreifen, indem Sie die Schaltfläche Annehmen anklicken. Die Betrachter können danach genauso wie ein Bearbeiter Daten in die Bedienoberfläche eingeben.

Betrachter können den Schritt in der Bedienoberfläche einsehen, sofern diese die Filteroption für mich im Filter Workflow Aufgaben deaktivieren.

Im Editor

Im Editor wählen Sie die entsprechenden Benutzer / Benutzergruppen, die Sie als Bearbeiter setzen wollen.

Als Expression

gleicher Fall wie bei Benutzer/Gruppe (Bearbeiter)