Platzhalter
Definition
Ein Platzhalter ist ein Parameter, den Sie in der Designumgebung in eine MIME-Vorlage einfügen können. Zur Laufzeit wird dieser Parameter durch einen benutzerdefinierten Wert ersetzt.
Verwendung
Sie können Platzhalter verwenden, um in Guided Procedures (GP) E-Mails zu personalisieren. Die Skriptsprache ermöglicht es Ihnen, Platzhalter für die Kontextparameter des Callable Object, das die bereitgestellte E-Mail-Vorlage verwendet, sowie für die integrierten Parameter, die Systeminformationen liefern, und die integrierten Prozessrollen anzulegen. Wenn Sie z.B. den Empfänger in der E-Mail direkt ansprechen wollen, können Sie am Anfang der E-Mail einen Platzhalter einfügen, den das System zur Laufzeit durch den entsprechenden Namen ersetzt.
Struktur
Um auf die Kontextparameter, integrierten Parameter und integrierten Prozessrollen zugreifen zu können, müssen Sie den Parameternamen Präfixe voranstellen.
Folgende Präfixe werden unterstützt:
Präfixe
Syntax |
Beschreibung |
ctxt |
Präfix für den Zugriff auf Kontextparameter |
sy |
Präfix für den Zugriff auf integrierte Parameter |
role |
Präfix für den Zugriff auf integrierte GP-Rollen |
Das Trennzeichen für Präfixe ist der Punkt (.).
Um den Ersatz der Platzhalter zu ermöglichen, müssen Sie folgende Syntax verwenden.
` if( exists(<replacement_parameter>) ) \\optional { writeln(<replacement_parameter>); } ` |
Zugriff auf Kontextparameter
Kontextparameter werden mit dem Präfix ctct abgerufen. Der an das Präfix angehängte technische Parametername steht für den entsprechenden Platzhalter.
Wenn das Callable Object zwei Kontextparameter mit den technischen Namen lastName und firstName hat, können Sie aus einer E-Mail-Vorlage heraus mit den Strings ctxt.lastName und ctxt.firstName auf diese Parameter Bezug nehmen.
Handelt es sich bei dem Kontextparametertyp um eine Struktur, werden auch die Teilelemente der Struktur durch das Trennungszeichen Punkt (.) angesprochen.
Wenn das Callable Object eine Struktur mit dem technischen Namen personalData als Kontextparameter hat und die Struktur aus zwei Teilelementen mit den technischen Namen lastName und firstName besteht, können Sie aus einer E-Mail-Vorlage heraus mit den Strings ctxt.personalDatalastName und ctxt.personalData.firstName auf diese Elemente Bezug nehmen.
Wenn das Callable Object einen Kontextparameter mit einem Punkt (.) im technischen Namen hat, wird dieser Punkt in der E-Mail-Vorlage als . referenziert.
Wenn das Callable Object einen Kontextparameter mit einem Bindestrich (-) im technischen Namen hat, wird dieser Bindestrich in der E-Mail-Vorlage als - referenziert.
Wenn das Callable Object einen Strukturparameter mit dem technischen Namen str.Data und in der Struktur ein Teilelement mit dem technischem Namen first.last-Name hat, können Sie das Teilelement in der E-Mail-Vorlage mit dem String ctxt.str.Data.first.-Name referenzieren.
So lassen sich Fehler vermeiden, die daraus entstehen, dass der Punkt als Trennzeichen zwischen der Struktur und seinen Teilelementen in der Skriptsprache fungiert und gleichzeitig im technischen Namen von Parametern verwendet wird. Das gleiche gilt für einen Bindestrich, der als Trennzeichen für Parameter in der Skriptsprache fungiert und gleichzeitig im technischen Namen von Parametern verwendet wird.
Dies gilt für alle Typen von Callable Objects, die sowohl Eingabe- als auch Ausgabeparameter haben. Wenn ein Eingabe- und ein Ausgabeparameter dieselben technischen Namen haben, nimmt das GP-Framework auf den Wert des Ausgabeparameters Bezug.
Funktionen zur Kontextbehandlung
Syntax |
Beschreibung |
|
set(Kontextname, Wert) |
Setzt den Wert eines Kontextparameters
|
|
append(Kontextname, Wert) |
Reserviert (nicht von GP verwendet) |
|
delete(Kontextname) |
Löscht den Kontextparameter. Sie sollten die Funktion clear anstelle der Funktion delete in GP benutzen. |
|
clear(Kontextname) |
Löscht den Kontextparameter.
|
Wenn Sie die Skriptsprache für den Zugriff auf Kontextparameter verwenden, müssen Sie folgende Einschränkungen beachten:
■ Wenn die Listenoption für den Kontextparameter gesetzt ist, kann auf den Parameter nicht im Kontext einer E-Mail-Vorlage zugegriffen werden.
■ Die technischen Namen der Kontextparameter müssen aus alphanumerischen Zeichen bestehen.
■ Zugriffsarten mit nicht-trivialer String-Darstellung sollten vermieden werden.
Zugriff auf integrierte Parameter
Integrierte Parameter werden mit dem Präfix sy abgerufen. Der an das Präfix angehängte integrierte Parameter steht für den entsprechenden Platzhalter.
Integrierte Parameter
Syntax |
Beschreibung |
currenttime |
Aktuelle Uhrzeit |
processid |
Prozess-ID des aktuellen GP-Prozesses |
workitemurl |
URL des aktuellen Workitems im aktuellen GP-Prozess |
sy.currenttime wird durch das Datum ersetzt, wenn das Callable Object, das die angegebene E-Mail-Vorlage verwendet, abgeschlossen ist.
Zugriff auf integrierte Prozessrollen
Die GP-Prozessrollen werden mit dem Präfix role abgerufen.
GP-Prozessrollen
Syntax |
Beschreibung |
Initiator |
Initiator des aktuellen GP-Prozesses |
Beobachter |
Beobachter des aktuellen GP-Prozesses |
Empfänger |
Empfänger der von der E-Mail-Vorlage generierten E-Mail |
Auf folgende Parameter kann über die oben genannten Rollen zugegriffen werden:
Parameter
Syntax |
Beschreibung |
firstname |
Vorname des Benutzers |
lastname |
Nachname des Benutzers |
accountname |
Account-Name (ID) des Benutzers |
Der an die integrierte Prozessrolle angehängte Parameter steht für den entsprechenden Platzhalter.
role.initiator.firstname wird durch den Vornamen des Prozessinitiators ersetzt.
Beispiel
Sie können die Annahme-E-Mail für einen Bewerber folgendermaßen personalisieren: Es wird angenommen, dass der Bewerber den Prozess gestartet hat, z. B. in dem er ein Bewerbungsformular ausgefüllt hat.
<html> <head> <title>Bestätigung</title> </head> <body> <p> Sehr geehrte(r) Frau / Herr ` writeln (role.initiator.lastname) `, </p> <p>Ihre Bewerbung wurde angenommen.</p> <p>Mit freundlichen Grüßen</p> <p><i>Personalleiter</i></p> </body> </html> |
Zur Laufzeit ersetzt das System den Parameter durch den Nachnamen des Bewerbers.