Zum Hauptinhalt springen

E-Mail-Vorlagenvariablen

Zweck​

Diese Tabelle listet die Variablen auf, die die Plattform für jeden E-Mail-Vorlagentyp automatisch füllt – die Daten, die jede Variable enthält, etwa einen Link zum betroffenen Objekt oder den Benutzer, der eine Aktion ausgelöst hat, und für welche Vorlagen sie gilt. Verwenden Sie sie beim Anpassen einer Vorlage, um zu wissen, was angezeigt werden kann.

Was eine Vorlage lesen kann​

Ab 20.4 kann eine angepasste Vorlage nur die Variablen in dieser Tabelle und die dafür aufgeführten Member lesen, etwa object.name. themeColors.secondary, igrafxuser.firstName und igrafxuser.lastName sind ab 20.4.2 lesbar.

Alles andere verhindert, dass die Vorlage gerendert wird:

  • Der Editor verweigert das Speichern der Vorlage und zeigt „Diese Vorlage enthält einen Formatierungsfehler. Bitte korrigieren Sie den Fehler vor dem Speichern.“
  • Eine vor 20.4 gespeicherte Vorlage verhindert, dass diese E-Mail gesendet wird. Stattdessen sendet die Plattform eine Fehler-E-Mail an die Adresse unter Fehlermeldung per E-Mail senden an, sofern unter E-Mail verwalten eine festgelegt ist.

Verfügbare Variablen​

Die Spalte Verfügbare Vorlagen verwendet drei Gruppen:

  • Alle Vorlagen: jede E-Mail-Vorlage, einschließlich der Einladungs-E-Mail.
  • Alle Standardbenachrichtigungen: die in der Zeile browserUrl aufgeführten E-Mails.
  • E-Mails zur Verfahrensplanung: E-Mail für (manuell) gestarteten Durchgang, E-Mail für (automatisch) gestarteten Durchgang, Warnungs-E-Mail für gestarteten Durchgang, Fehler-E-Mail für gestarteten Durchgang, E-Mail über bevorstehenden (manuellen) Durchgang und E-Mail über bevorstehenden (automatischen) Durchgang.

Einige Variablen sind nicht immer gesetzt; die Tabelle gibt an, wann. Prüfen Sie eine solche Variable mit ??, bevor Sie sie ausgeben, zum Beispiel [#if lastRun??], oder geben Sie ihr mit ! einen Ersatzwert, zum Beispiel ${object.getTranslation(useLocale)!object.name}. Datumswerte benötigen ein Format, bevor Sie sie ausgeben, zum Beispiel ${lastRun?datetime?string(igrafxuser.dateFormat)}.

Variable

Verfügbare Vorlagen (lesbare Namen)

Erläuterung

baseUrl

Alle Vorlagen

Basis-URL von Process Design zum Erstellen von Links

browserUrl

Alle Standardbenachrichtigungen:

E-Mail über Änderung der freigegebenen Version
E-Mail über gestartetes Freigabeverfahren
E-Mail über abgeschlossenes Freigabeverfahren
E-Mail über abgelehntes Freigabeverfahren
E-Mail über abgebrochenes Freigabeverfahren
E-Mail über gestartetes Bestätigungsverfahren
E-Mail über abgeschlossenes Bestätigungsverfahren
E-Mail über abgebrochenes Bestätigungsverfahren
E-Mail über gestartetes Überprüfungsverfahren
E-Mail über abgeschlossenes Überprüfungsverfahren
E-Mail über abgebrochenes Überprüfungsverfahren
E-Mail einchecken
E-Mail mit Kommentaren
E-Mail über Auflösung eines Kommentars
E-Mail über erneutes Öffnen eines Kommentars
E-Mail über die Löschung eines Kommentars
E-Mail zu gestartetem Kenntnisnahmeverfahren
E-Mail zu angehaltenem Kenntnisnahmeverfahren
E-Mail zu wiederaufgenommenem Kenntnisnahmeverfahren
E-Mail zu abgebrochenem Kenntnisnahmeverfahren
E-Mail – Aufmerksamkeit erforderlich
E-Mail-Benachrichtigung über mehrere Verfahren

Deep Link zur relevanten Seite für das Ereignis, zu dem die E-Mail gehört. Er führt immer zum betroffenen Objekt selbst – Sie können keinen Pfad wie /Login anhängen.

object.id
object.name
object.getTranslation(useLocale)
object.typeEnum
object.parentObject

Alle Standardbenachrichtigungen
E-Mails zur Verfahrensplanung

Das Repository-Objekt, das zum Ereignis gehört.

  • getTranslation(useLocale): sein Name in der Sprache des Empfängers. Nicht gesetzt, wenn das Objekt keine Übersetzung hat.
  • typeEnum: der interne Name des Objekttyps, etwa Document (IGX-Dokument), Diagram (IGX-Diagramm), Component, WebDiagram (Diagramm) oder Folder. Um Inhalte nur anzuzeigen, wenn es einen Flowcharter-Client-Link gibt, prüfen Sie stattdessen clientLink??.
  • parentObject: der Ordner, in dem es sich befindet, mit denselben Membern.

repository.shortname
repository.name

Alle Standardbenachrichtigungen
E-Mails zur Verfahrensplanung

Kurzname oder Name des Repositorys, in dem sich das betreffende Objekt befindet

themeColors.primary
themeColors.secondary
themeColors.accent

Alle Vorlagen

Marken- bzw. Mandantenfarben zur Gestaltung der E-Mail.

  • secondary: eine hellere Farbe für Hintergründe. Bei einem benutzerdefinierten Design eine helle Abstufung von primary.
  • accent: bei einem benutzerdefinierten Design identisch mit primary.

isRequiredWatcher

Alle Standardbenachrichtigungen

Ob der Beobachter als „erforderlich“ gekennzeichnet ist.

useLocale
useLocale.language

Alle Standardbenachrichtigungen
E-Mails zur Verfahrensplanung

Das für jeden Empfänger am besten passende Inhalts- bzw. UI-Gebietsschema. language ist dessen Sprachcode, etwa de.

universityUrl

Alle Vorlagen

Link zur iGrafx University

annotation

E-Mail mit Kommentaren
E-Mail über Auflösung eines Kommentars
E-Mail über erneutes Öffnen eines Kommentars
E-Mail über die Löschung eines Kommentars

Text der Anmerkung bzw. des Kommentars.

pausedCycleComment

E-Mail zu angehaltenem Kenntnisnahmeverfahren

Kommentar, der beim Anhalten des Kenntnisnahmeverfahrens eingegeben wurde.

resumedCycleComment

E-Mail zu wiederaufgenommenem Kenntnisnahmeverfahren

Grund bzw. Details, wenn eine Kenntnisnahme fortgesetzt wird.

triggeringUser

E-Mail über gestartetes Überprüfungsverfahren
E-Mail über gestartetes Freigabeverfahren
E-Mail über gestartetes Bestätigungsverfahren
E-Mail zu gestartetem Kenntnisnahmeverfahren
E-Mail – Aufmerksamkeit erforderlich
E-Mail zu wiederaufgenommenem Kenntnisnahmeverfahren
E-Mail über abgebrochenes Freigabeverfahren
E-Mail über abgebrochenes Überprüfungsverfahren
E-Mail über abgebrochenes Bestätigungsverfahren
E-Mail zu abgebrochenem Kenntnisnahmeverfahren
E-Mail mit Kommentaren; E-Mail über Auflösung eines Kommentars
E-Mail über erneutes Öffnen eines Kommentars
E-Mail über die Löschung eines Kommentars
E-Mail einchecken
E-Mail zu angehaltenem Kenntnisnahmeverfahren
E-Mail über abgelehntes Freigabeverfahren

Anzeigename des Benutzers, der das Ereignis ausgelöst hat.

startCycleComment

E-Mail über gestartetes Überprüfungsverfahren
E-Mail über gestartetes Freigabeverfahren
E-Mail über gestartetes Bestätigungsverfahren
E-Mail zu gestartetem Kenntnisnahmeverfahren
E-Mail – Aufmerksamkeit erforderlich
E-Mail zu wiederaufgenommenem Kenntnisnahmeverfahren

Einführende Notiz bzw. Kommentar, wenn ein Verfahren startet oder fortgesetzt wird oder Aufmerksamkeit angefordert wird.

cancelCycleComment

E-Mail über abgebrochenes Freigabeverfahren
E-Mail über abgebrochenes Überprüfungsverfahren
E-Mail über abgebrochenes Bestätigungsverfahren
E-Mail zu abgebrochenem Kenntnisnahmeverfahren

Grund, der beim Abbrechen des Verfahrens angegeben wurde.

version

E-Mail über Änderung der freigegebenen Version
E-Mail über abgeschlossenes Freigabeverfahren

Die konkrete Versionsnummer, die für die Benachrichtigung über die Freigabeänderung bzw. den Abschluss des Verfahrens relevant ist.

numberOfUpdates

E-Mail – Aufmerksamkeit erforderlich

Anzahl der Verfahren, zu denen der Benutzer hinzugefügt wurde

clientLink

Alle Standardbenachrichtigungen (nur wenn das Objekt ein IGX-Dokument, ein IGX-Diagramm oder eine Komponente ist)

Direkter Flowcharter-Client-Link zum Öffnen des Dokuments oder Objekts.

dueDate

E-Mail zu gestartetem Kenntnisnahmeverfahren

Fälligkeitsdatum als Zeichenfolge in der Sprache des Empfängers (oder „noch festzulegen“).

isOverDue

E-Mail zu gestartetem Kenntnisnahmeverfahren

true, wenn die aktuelle Zeit nach dueDate liegt.

igrafxuser.loginName
igrafxuser.displayName
igrafxuser.firstName
igrafxuser.lastName
igrafxuser.dateFormat
igrafxuser.timeZoneCurrent.ID

E-Mails zur Verfahrensplanung

Der Benutzer, der das Verfahren geplant hat. Diese E-Mails gehen immer an diesen Benutzer.

  • dateFormat: sein Datumsformatmuster.
  • timeZoneCurrent.ID: seine Zeitzonen-ID, etwa Europe/Berlin.

schedule.scheduleType
schedule.manualStart
schedule.markObjectUnapproved
schedule.getNextCycleRunDate(lastRun)

E-Mails zur Verfahrensplanung

Die Planungseinstellungen des Verfahrens, beschrieben unter Ein Verfahren planen.

  • scheduleType: der Verfahrenstyp, einer der Werte von enums.CycleType.
  • manualStart: true für Nachricht an den Disponenten senden, das Verfahren manuell zu starten.
  • markObjectUnapproved: true für Freigegebene Version auf „Keine“ setzen.
  • getNextCycleRunDate(lastRun): das Datum, an dem das nächste Verfahren startet. Übergeben Sie lastRun genau wie gezeigt.

lastRun

E-Mails zur Verfahrensplanung

Datum, an dem das vorherige Verfahren dieses Typs für das Objekt abgeschlossen wurde. Nicht gesetzt, bevor das erste abgeschlossen ist.

flowClientLink

E-Mail für (manuell) gestarteten Durchgang
E-Mail für (automatisch) gestarteten Durchgang
E-Mail über bevorstehenden (manuellen) Durchgang
E-Mail über bevorstehenden (automatischen) Durchgang

Nur wenn das Objekt kein Webdiagramm ist.

Die Entsprechung von clientLink für die E-Mails zur Verfahrensplanung.

errorProp

Fehler-E-Mail für gestarteten Durchgang

Lokalisierungsschlüssel des Grundes, aus dem das Verfahren nicht starten konnte. Zeigen Sie den Text mit ${string[errorProp]} an.

siteTitle
siteUrl
username

Einladungs-E-Mail

Der Titel der Website, die URL der Website und der Anmeldename des Benutzers, der die E-Mail erhält.

isNewUser
plainPassword

Einladungs-E-Mail, nur wenn sie über Einladungs-E-Mail an Benutzer senden oder E-Mail mit Aufforderung zur Zurücksetzung des Kennworts an Benutzer senden gesendet wird (siehe Benutzer und Gruppen verwalten).

  • isNewUser: true für eine Einladung und false für ein Zurücksetzen des Kennworts.
  • plainPassword: das temporäre Kennwort. Nicht gesetzt in Cloud-Bereitstellungen, die die Anmeldung über den iGrafx-Benutzerdienst verwalten, oder für Benutzer in einem Benutzerverzeichnis vom Typ Von API verwaltet.

string.<key>

Alle Vorlagen

Jede Lokalisierungseigenschaft, in der Sprache des Empfängers. Siehe Auf eigene Formulierungen verweisen.

enums.CycleType

Alle Vorlagen

Werte für den Verfahrenstyp: Approval, Reviewer, Signoff (Bestätigung) und Acknowledgement. Zum Beispiel ist schedule.scheduleType == enums.CycleType.Signoff bei einem Bestätigungsverfahren true.

[@ice.mailbreadcrumbs object repository useLocale /]

Alle Standardbenachrichtigungen
E-Mails zur Verfahrensplanung

Makro, das den Repository-Namen und den Ordnerpfad des Objekts ausgibt, mit dem Objektnamen in der Sprache des Empfängers. Erfordert [#import "/igx-shared.ftl" as ice/] am Anfang der Vorlage.