Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Außerdem gibt es einen Job zum Versenden und Empfangen von E-Mails. Damit werden E-Mail etwas später versendet, können nach Fehlern aber zurück gerollt werden, so dass sie nicht mehrfach versehndet versendet werden.

Des weiteren gibt es auch die Möglichkeit, Vorlagen / Templates für E-Mails zu konfigurieren.

...

ThemaBeschreibung
E-Mail Template

Das BO E-Mail-Template bietet die Möglichkeit, Vorlagen für E-Mails zu erstellen, die dann aus Regeln heraus versendet werden können. Ein Administrator hat damit die Möglichkeit, die von Nuclos versendeten E-Mails selbst zu gestalten und kurzfristig zu ändern. Die Templates bieten hierzu viele Möglichkeiten:

  • Der Zugriff auf beliebig weit referenzierte Attribute aus einem frei wählbaren Basis-BO (z.B Auftrag), ähnlich wie bei Nuclos-Formularen
  • Verschiedene Quellen von Adressen (Attribut, Nucletparameter, Benutzer, Benutzergruppe, ...)
  • Verschiedene Quellen von Anhängen (Datei, Formular, ...)
  • Verschiedene Sprachen von Betreff, Nachricht und Anhang
  • Textbausteine
  • E-Mail-Empfänger, die E-Mail-Adresse, Anrede und Sprache der E-Mail bestimmen
  • Standardisierte und konfigurierbare Footer und Signaturen
  • Vorschau und Test des Templates

Komplexere E-Mail-Bestandteile, wie z.B. eine Tabelle mit allen Auftragspositionen, müssen durch eine Regel unterstützt werden.

E-Mail Baustein

Können Bausteine definiert werden, die dann in den E-Mail-Templates zur Verfügung stehen. Möglich sind

Textbaustein

  • Reine (ggf. mehrsprachige) Standard-Textbausteine (AGB, Versandinfos, Signatur, ...)
  • Bausteine, die einen Footer oder eine Signatur bereitstellen

Regelbaustein

  • Komplexe Bausteine, die eine Regelunterstützung benötigen (z.B. Tabelle mit Auftragspositionen)Bausteine, die den E-Mail-Empfänger (Adresse, Anrede, Sprache) definieren
  • Bausteine, die eine oder mehrere E-Mail-Adressen ermitteln (z.B. für Subscribe-Funktionalitäten)
  • Bausteine, die einen Anhang generiereneine Sprache definieren

Empfänger

  • Bausteine, die eine Sprache definierenden E-Mail-Empfänger (Adresse, Anrede, Sprache) definieren

Anhang

  • Bausteine, die einen Footer oder eine Signatur bereitstellenAnhang generieren

Versandbedingung

  • Bausteine, die entscheiden, ob eine E-Mail versendet werden soll oder nicht

Zur Sicherheit lassen sich Bausteine auf bestimmte BO's einschränken, wenn z.B. wenn der Baustein Bearbeiter  für die BO's Rechnung und Auftrag existiert, aber nicht für das BO Artikel 

E-Mail SpracheDefiniert die zur Verfügung stehenden Sprachen
Regelbausteine

Zur Erzeugung einer E-Mail aus einem E-Mail-Template muss eine Instanz einer Klasse mit übergeben werden, die das Interface Regelbausteine  implementiert.

...

Das Nuclet bringt eine Implementierung mit, die einige Beispiele enthält. Wenn Sie eigene Regelbausteine benötigen, sollten Sie sich eine eigene Implementierung in Ihrem Nuclet anlegen, damit diese nicht überschrieben wird, wenn das E-Mail-Nuclet mal aktualisiert wird.

In der Methode EMailUtils.getRegelBausteine() dann einfach diese Implementierung erzeugen.

Konfiguration von E-Mail-Templates von Version 1.1.3


Weitere
Bereich E-Mail-Template
Name Pflicht Eindeutiger Name des Templates
Basis-NucletoptionalDas Nuclet aus dem das Basis-BO kommen soll
Basis-BOoptionalDas BO, auf das sich die E-Mail bezieht (z.B. Auftrag)
Empfänger optionalEin Regelbaustein, der als Empfänger  gekennzeichnet ist und für die die Methode getRecipient()  in der Regelbaustein-Implementierung ein Ergebnis mit E-Mail-Adresse, Anrede und ggf. Sprache zurück liefert.
Footer Empfänger-BOoptionalEin als Footer  gekennzeichneter TextbausteinSignatur optionalEin Wenn der Emfpänger z.B. allgemein als Regelbaustein für das BO Mitarbeiter implementiert wurde, kann hier einfach Mitarbeiter angegeben werden
Empfänger-RolleoptionalWenn der Mitarbeiter in verschiedenen Rollen im Basis-BO vorkommt, kann diese hier spezifiziert werden, z.B. Ansprechpartner  oder Kundenberater  
Footer optionalEin als Footer  gekennzeichneter Textbaustein
Signatur optionalEin als Signatur gekennzeichneter Textbaustein
Bereich Weitere Eigenschaften
Sprache (Baustein)optionalDie Sprache, in der die E-Mail versendet werden soll, definiert durch einen als Sprache  gekennzeichneten Textbaustein
Sprache (statisch)optionalDie Sprache, in der die E-Mail versendet werden soll, direkt angegeben
Html?optionalE-Mail wird im Html-Format versendet (empfohlen)
Nach Versand löschen?optionalSensible E-Mails (z.B. mit Passwort-Links o.ä.) können nach dem Versand automatisch aus dem E-Mail-Protokoll gelöscht werden
Aktiv?optionalAktiviert oder deaktiviert den Versand der E-Mails
Bereich Template-Test
ID des Basis-BOVersandbedingungoptionalWenn ein Basis-BO angegeben ist, kann Hier kann Regelbaustein ausgewählt werden, der eine Versandbedingung ist, die entscheidet, ob die E-Mail versendet werden soll
Bereich Template-Test
ID des Basis-BOoptionalWenn ein Basis-BO angegeben ist, kann hier eine intid angegeben werden, für die die Vorschau erstellt und die Test-E-Mail versendet werden soll
SpracheoptionalHier kann die Sprache der Vorschau und der Test-E-Mail forciert werden
Empfänger der Test-E-MailoptionalWenn kein Empfänger angegeben ist, wird die E-Mail an die im Nucletparameter Email Umleitung auf hinterlegte Adresse versendet
Erzeuge Vorschau
Erzeugt eine Vorschau im Reiter Vorschau 
Sendet Test-E-Mail
Für den finalen Test kann damit eine Test-E-Mail versendet werden
Reiter Konfiguration

Betreff + Nachrichtoptional

Hier können Betreff und Nachricht definiert werden. Dabei können verwendet werden

  • Beliebiger Text
  • Datenfelder aus dem Basis-BO in der Form z.B. #{Auftragsnr} oder #{Kunde.Kundengruppe.Name}. Verfügbare Datenfelder sind als Hilfe im Reiter Verfügbare Datenfelder  zu finden
  • Textbausteine, die entweder nicht auf ein BO eingeschränkt (##{AGB}) sind oder für das Basis-BO erlaubt sind (##{Ansprechpartner}), als Hilfe zu finden im Reiter Verfügbare Textbausteine 

Für Betreff und Nachricht können alternative Texte in anderen Sprachen angegeben werden (siehe Reiter Betreffs(übersetzt) und Nachrichten (übersetzt))

Reiter Adressenoptional

Wenn ein Empfänger angegeben ist, wird die E-Mail an die dort ermittelte E-Mail-Adresse versendet. Zusätzlich oder alternativ können weitere Adressen hinzugefügt werden aus

  • direkt angegebenen Adressen (z.B. CC info@firma.de)
  • einem Nuclos Benutzer
  • allen Nuclos Benutzern einer bestimmten Benutzergruppe
  • einem Attribut des Basis-BO (oder weiter referenzierten Attributen, z.B. die E-Mail-Adresse des Zuständigen des Auftrages)
  • einem Nuclet Parameter
  • einem Baustein, der als E-Mail-Adresse gekennzeichnet ist
Reiter Anhängeoptional

Hier können Anhänge für die E-Mail definiert werden, z.B.

  • ein Report oder Formular 
  • eine im Template hinterlegte Datei
  • ein Baustein, der als Anhang gekennzeichnet ist und für den die Methode getAttachments() eine Liste von Dateien zurück liefert

Für jeden Anhang können alternative Anhänge in anderen sprachen definiert werden

Reiter BeschreibungStatuswechseloptional

Hier

können weitere Informationen für das Template hinterlegt werdenReiter E-Mails

kann konfiguriert werden, bei welchem Statuswechsel die E-Mail versendet werden soll. Eine entsprechende Regel muss dazu allerdings für jeden möglichen Statuswechsel des betroffenen Statusmodells zugeordnet werden. Hilfreich für diese Regel ist dann die Methode

EMailUtils.sendAllAcceptedEMails(StateChangeContext context, RegelBausteine regelBausteine)

Weitere
Reiter BeschreibungoptionalHier können weitere Informationen für das Template hinterlegt werden
Reiter E-Mails
Zeigt die E-Mails an, die bereits aus diesem Template generiert wurden

...

E: : : : new RegelBausteineImplEMailTemplate template = EMailUtils.getEMailTemplate(Konstanten.EMailTemplate.SERIENNUMMER);
Token token = NucletTokenUtils.getToken(seriennummer);
if (template.getAktiv()) {
EMailContext.TemplateParameters parameters = new EMailContext.TemplateParameters(EMailHelper.Parameters.TOKEN, token);
EMailVersand.sendMail(new EMailContext(template, new RegelBausteineImpl(), seriennummer, parameters, context));
}
Initialisierung

Nach dem Nucletimport muss einmal der Job Initialisiere Nuclet Emailversand ausgeführt werden

Der Job legt u.a. einige Standard-E-Mail-Bausteine an, so dass Sie gleich ein Template bauen können.

E-Mail-Template
Ein E-Mail-Template für eine Rechnung könnte z.B. so aussehen

Image Modified

Rechnungsformular als Anhang

Image Modified

Regelbaustein für einen Empfänger

Image Modified

Das Interface Regelbausteine



Text
String getValue(String name, Modifiable<Long> bo, EMailTemplateSprache language, TemplateParameters parameters, RuleContext context)
Anhänge
List<NuclosFile> getAttachments(String name, Modifiable<Long> bo, EMailTemplateSprache language, TemplateParameters parameters)
Empfänger
TemplateRecipient getRecipient(String name, Modifiable<Long> bo, EMailTemplateSprache language, TemplateParameters parameters)
Sprache
public String getValue(final String name, final
NuclosLocale getLocale(EMailTemplateSprache langugage)
Versandbedingung
Beispiel (Text)

boolean isSendMail(EMailTemplateBaustein versandbedingung, Modifiable<Long> bo)

Adresse des WebclientsString getWebclientAddress()
AnredegetSalutation(User user, EMailTemplateSprache sprache)


Beispiel (Text)

public String getValue(final String name, final Modifiable<Long> bo, EMailTemplateSprache language, TemplateParameters parameters, RuleContext context) throws BusinessException {
if (SIGNATUR.equals(name)) {
return EMailHelper.getSignature();
} else if (RECHNUNGSPOSITIONEN.equals(name)) {
return EMailHelper.getAuftragspositionengetRechnungspositionen(bo, parameters, name);
}
    throw new BusinessException("Unbekannter Name für einen Regelbaustein: \"" + name + "\"");
}
Beispiel (Empfänger)

@Override
public TemplateRecipient getRecipient(String name, Modifiable<Long> bo, EMailTemplateSprache language, TemplateParameters parameters) throws BusinessException {
   if (ANSPRECHPARTNER.equals(name)) {
return EMailHelper.getTemplateRecipient(EMailHelper.getAnsprechpartner(bo, parameters, name));
} else if (BEARBEITER.equals(name)) {
return EMailHelper.getTemplateRecipient(EMailHelper.getBearbeiter(bo, name));
   throw new BusinessException("Unbekannter Name für einen Empfänger: \"" + name + "\"");
}
Beispiel (Verwendung in Regeln)
Einfachster Fall
EMailTemplate template = EMailUtils.getEMailTemplate(Konstanten.EMailTemplate.RECHNUNG);
if (template.getAktiv()) {
EMailVersand.sendMail(new EMailContext(template,
EMailUtils.getRegelBausteine(), rechnung, context));
}
In einigen Fällen muss man womöglich noch zu zusätzliche Informationen an das Template weiter geben. Diese geschieht durch parameter.
Erzeugung von Templates (Klasse EMailTemplateKonfiguration)

Die Klasse EMailTemplateKonfiguration stellt Datenstrukturen und Methoden bereit, um Sprachen, Bausteine und Templates durch Regeln zu erstellen.

Dies kann besonders bei der Nucletentwicklung hilfreich sein, um solche Objekte auf anderen Instanzen neu zu erstellen.


Verfügbare Datenstrukturen
  • Sprache
  • Baustein
  • Template
  • Restriction
  • Adresse
  • Statuswechsel
  • Anhang
  • BausteinTranslation
  • AnhangTranslation
  • SubjectTranslation
  • MessageTranslation
Verfügbare Methoden zur Erstellung
  • EMailTemplate createTemplate(Template template, final JobContext context)
  • void createSprache(Sprache sprache, final JobContext context)
  • void insertBausteinTranslation(EMailTemplateBaustein baustein, BausteinTranslation translation)
  • void insertBausteinRestriction(EMailTemplateBaustein baustein, Restriction restriction)
  • EMailTemplateAnhang insertAnhang(EMailTemplate template, Anhang anhang)
  • void insertStatuswechsel(EMailTemplate template, Statuswechsel statuswechsel)
  • void insertAnhangTranslation(EMailTemplateAnhang anhang, AnhangTranslation translation)
  • void insertBetreffTranslation(EMailTemplate template, SubjectTranslation translation)
  • void insertNachrichtTranslation(EMailTemplate template, MessageTranslation translation)
  • void insertAdresse(EMailTemplate template, Adresse adresse)
  • EMailTemplateBaustein createBaustein(Baustein baustein, final JobContext context)
Beispiel (Konfiguration Baustein)
public static final EMailTemplateKonfiguration.Baustein FOOTER_INTERN = new EMailTemplateKonfiguration.Baustein() {{
setName(RegelBausteineImpl.Footer.FOOTER_INTERN);
setText("<br>\n<br>Vielen Dank und freundliche Grüße,\n<br>\n<br>##{" + RegelBausteineImpl.Standard.AKTUELLER_BENUTZER + "}");
setFooter(true);
}};
Beispiel (Konfiguration Template)
public static final EMailTemplateKonfiguration.Template TEMPLATE_PROJEKT = new EMailTemplateKonfiguration.Template() {{
setName("Projekt aktiv");
setNuclet("org.nuclet.firma");
setAktiv(false);
setTable("Projekt");
setTestID(1234567);
setSpracheStatisch(EMailUtils.DEUTSCH);
setSubject("Neues Projekt");
setMessage("##{" + RegelBausteineImpl.Standard.ALLGEMEINE_ANREDE + "}" +
"\n<br>" +
"\n<br>das Projekt #{@Nummer} wurde soeben angelegt.");
setFooter(RegelBausteineImpl.Footer.FOOTER_INTERN);
setSignature(RegelBausteineImpl.Signature.SIGNATUR);
addAddress(new EMailTemplateKonfiguration.Adresse() {{
setAttribute("Beauftragtdurch");
setAttributeRef("Emailbenutzer");
setPflichtfeld(true);
}});
}};
Beispiel Erzeugung
EMailTemplateKonfiguration.createBaustein(FOOTER_INTERN, jobContext);
EMailTemplateKonfiguration.createTemplate(TEMPLATE_PROJEKT, jobContext);

Version 1.1.2

Beschreibung von Version 1.1.2

...