Platzhalter werden für die Ersetzung von Formularwerten verwendet und stehen in Aktionen sowie Templates zur Verfügung.

Verwenden von Platzhaltern

Symbol für das Öffnen einer Platzhalterauswahl an einem Options- und einem Textfeld im Aktionstyp E-Mail.

Die geöffnete Platzhalterauswahl. Hier kann ein Formularfeld ausgewählt werden, dessen Wert genutzt wird.

Verwendung in Aktionen

Bei Optionsfeldern von Aktionen, die diese unterstützen, kann über das Symbol rechts die Platzhalterauswahl geöffnet werden.

Verwendung in Templates

Platzhalter können auch in Templates genutzt werden. Der Knopf Platzhalter öffnet das entsprechende Auswahlmenü.

Das Platzhaltermenü kann über den Knopf Platzhalter im Template-Editor geöffnet werden oder auch über die Tastenkombination Strg + Leerzeichenzeichentaste.

Platzhaltertypen

Formularplatzhalter

Syntax

[%<NameDesFormularelements>%]

Dieser Platzhalter wird ersetzt durch den Wert des Formularelements mit dem angegebenen Namen. Formularplatzhalter werden in Aktionen wie z.B. E-Mail, Text erzeugen, Datenbank sowie bei Templates verwendet.

Beispielweise wird der Platzhalter [%tfVorname%] durch den Wert des Eingabefelds mit Namen Vorname ersetzt.

Spezielle Formularplatzhalter

Einige spezielle Formularplatzhalter existieren für alle Formulare:

  • [%xf-action%] Der Name der Schaltfläche, die zum Absenden verwendet wurde. Kann etwa genutzt werden, um über eine Bedingung bestimmte Aktionen nur auszuführen, wenn eine bestimmte Schaltfläche gedrückt wurde.
  • [%lang%] Verweist auf die Sprache, die beim Ausfüllen des Formulars verwendet wurde, z.B. de, de-CH, en/ oder fr-FR.

Systemplatzhalter

Syntax

[%$<Name>%]

Dieser Platzhalter wird ersetzt durch den entsprechenden Systemwert. Aktuell stehen folgende Systemplatzhalter in Aktionen und Templates zur Verfügung.

  • [%$CLIENT_ID%]
    Gibt die Mandant-ID des Formulars zurück.

  • [%$FORM_LINK%]
    Gibt die URL des Formulars zurück.

  • [%$FORM_PROCESS_LINK%]
    Gibt die URL des Formulars mit dem Inhalt des Vorgangs zurück.

  • [%$FORM_VERIFY_LINK%]
    Gibt die einmalige Bestätigungs-URL zurück (nötig für Double-Opt-In).

  • [%$PROCESS_ID%]
    Gibt die aktuelle Prozess-ID des Vorgangs zurück.

  • [%$PROJECT_ALIAS%]
    Alias des derzeitigen Formulars.

  • [%$PROJECT_ID%]
    Gibt die Formular-ID zurück.

  • [%$PROJECT_NAME%]
    Name des derzeitigen Formulars.

  • [%$RECORD_ID%]
    ID des derzeitigen Vorgangs.

  • [%$SOURCE_SERVER%]
    Gibt den Namen des Servers zurück, auf welchem dieser bereitgestellt und abgesendet wurde (Name des Frontend-Servers oder lokal).

  • [%$SOURCE_SERVER_URL%]
    Gibt die URL des Servers zurück, auf welchem dieser bereitgestellt und abgesendet wurde (Name des Frontend-Servers oder lokal).

  • [%$STATUS_ID%]
    ID des derzeitigen Status.

  • [%$STATUS_NAME%]
    Name des derzeitigen Status.

Parametrisierbare Systemplatzhalter

Syntax

[%$<Name>(<Paramater>...)%]
  • [%$DATE("<format>", <lang>)%]
    Verfügbar ab FORMCYCLE Version 6.0.5 Aktuelles Datum. Die Parameter sind optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch die Paramater kann das Format und die Sprache bestimmt werden.

    Beispiel: [%$DATE("dd.mm.yyyy", de)%]

    (siehe SimpleDateFormat)

  • [%$FORM_DATE_CREATED("<format>", <lang>)%]
    Verfügbar ab FORMCYCLE Version 6.0.5 Erstellungsdatum des Vorgangs. Die Parameter sind optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch die Paramater kann das Format und die Sprache bestimmt werden.

    Beispiel: [%$FORM_DATE_CREATED("dd.mm.yyyy", de)%]

    (siehe SimpleDateFormat)

  • [%$FORM_DATE_MODIFIED("<format>", <lang>)%]
    Verfügbar ab FORMCYCLE Version 6.0.5 Datum der letzten Änderung des Vorgangs. Die Parameter sind optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch die Paramater kann das Format und die Sprache bestimmt werden.

    Beispiel: [%$FORM_DATE_MODIFIED("dd.mm.yyyy", de)%]

    (siehe SimpleDateFormat)

Systemplatzhalter für HTML-Templates

Syntax

[%$<Name>(<Parameter1>,<Parameter2>)%]

Zusätzlich zu den allgemeingültigen Systemplatzhaltern gibt es noch einige weitere Systemplatzhalter, welche nur innerhalb eines HTML-Templates verwendet werden können. Diese dienen zum Herunterladen von Anhängen und sind hierfür nur innerhalb der Browser-Session nach dem Absenden eines Formulars nutzbar.

  • [%$ATTACHMENT_LIST%]
    Stellt alle an einem Vorgang verfügbaren Anhänge (Attachments) in einer Liste zum Herunterladen bereits. Die erzeugte Liste wird als ul-HTML-Element in das Tempalte eingefügt.

  • [%$ATTACHMENT_ZIP=Dateiname,Link-Text%]
    Erzeugt einen Link zum Herunterladen aller Anhänge eines Vorgangs. Die Parameter Dateiname sowie Link-Text sind optional, sodass dieser Systemplatzhalter in folgenden Varianten genutzt werden kann.

    • [%$ATTACHMENT_ZIP=Dateiname,Link-Text%]
      Erzeugt einen Link mit dem Text Link-Text zum Herunterladen der Datei, die den Dateinamen Dateiname erhält.

    • [%$ATTACHMENT_ZIP=Dateiname%]
      Erzeugt einen Link mit dem Text Dateiname zum Herunterladen der Datei, die den Dateinamen Dateiname erhält.

    • [%$ATTACHMENT_ZIP%]
      Erzeugt einen Link mit dem Text attachment.zip zum Herunterladen der Datei, die den Dateinamen attachment.zip erhält.

  • [%$ATTACHMENT=Anhang,Link-Text,Dateiname%]
    Erzeugt einen Link zum Download eines einzelnen Anhangs eines Vorgangs mit dem Namen "Anhang". Dieser muss für eine korrekte Funktion den Namen einer erzeugten bzw. an den Vorgang angehangenen Datei entsprechen. Die Parameter "Link-Text" und "Dateiname" sind hierbei optional, sodass sich folgende Verwendungsmöglichkeiten ergeben.

    • [%$ATTACHMENT=Anhang,Link-Text,Downloadname%]
      Erzeugt einen Link mit dem Text Link-Text zum Herunterladen des Anhangs mit dem Namen Anhang, der den Dateinamen Dateiname erhält.

    • [%$ATTACHMENT=Anhang,Link-Text%]
      Erzeugt einen Link mit dem Text Link-Text zum Herunterladen des Anhangs mit dem Namen Anhang, der den Dateinamen Anhang erhält.

    • [%$ATTACHMENT=Anhang%]
      Erzeugt einen Link mit dem Text Anhang zum Herunterladen des Anhangs mit dem Namen Anhang, der den Dateinamen Anhang erhält.

Zusätzlich ist bei dieser Art von Platzhaltern zu beachten, dass sie automatisch aus dem Template entfernt werden, wenn keine entsprechende Datei gefunden wurde bzw. erzeugt werden konnte.

Textbausteinplatzhalter

Syntax

[%$$<Name>%]

Ein Textbausteinplatzhalter gibt den Inhalt eines Templates zurück und wird z.B. in Aktionen vom Typ E-Mail verwendet.

Aktionsplatzhalter

Syntax

[%$<Aktionsname>.<RückgabeWert>%]

Einige Aktionen haben Rückgabewerte, die über diesen Platzhalter ausgelesen werden können.

Sie sehen ähnlich wie Systemplatzhalter aus, haben aber im Unterschied zu diesen einen Punkt als Trennzeichen zwischen dem Namen der Aktion und dem Rückgabewert. Folgende Rückgabebezeichner sind vorhanden.

  • [%$<Aktionsname>.SUCCESS%]
    Rückgabe ob Aktion erfolgreich ausgeführt wurde. Liefert Boolean (true/false) zurück.

  • [%$<Aktionsname>.COUNT%]
    Rückgabe der Anzahl von Ergebnissen. Liefert Integer-Wert zurück.

  • [%$<Aktionsname>.RESULT%]
    Rückgabe eines einzelnen Ergebnis. Liefert String-Wert zurück.

  • [%$<Aktionsname>.RESULT[<Index>].<Bezeichner>%]
    Einige Aktionen liefern mehrere Ergebnisse zurück (List<Map<String,String>> in Java). Der Bezeichner ist dabei fest durch die Verarbeitung definiert. Wird häufig bei Plugins verwendet, falls mehrere Ergebnisse zurückgegeben werden.

Tags:
Erstellt von gru am 2019/03/25 11:59
Copyright 2000-2019