Liste der Steuerparameter
Aus Melin DokuWiki
Eine der häufigsten Fragen bei Projekten mit Melin ist nach einer Liste aller Templatevariablen die im NanoCMS und im Mailing verwendet werden können.
Bisher wollten wir eine solche Liste nicht zusammenstellen, da die Variablen mehr oder weniger alle von den Plugins im Workflow abhängen.
Da es jedoch eindeutigen Bedarf gibt ist sie also hier. Um die Liste sortierbar zu machen ist es eine große Tabelle geworden, in einer Spalte steht das Plugin das diesen Parameter verarbeitet. Wenn dort "NanoCMS" steht, dann wird der Wert von in Melin verarbeitet bevor die Daten an den Workflow übergeben werden.
[bearbeiten] Nutzerdefinierbare Variablen
| Variable | Verarbeitet durch | Beschreibung | Beispiel-Wert |
|---|---|---|---|
| ADAPPROVAL | Workflow | Mailing wird nach Freigabe erst verschickt wenn die angegebene Datei vorliegt (Externe Freigabe, Plugin: adapproval) | SITE-DIR/freigaben/wuv/anzeigen.xml |
| ADSERVERQUERY_KEY | Workflow | Abfrage von Werbung (Text und HTML) aktivieren (Plugin: adserverquery) | ADSERVER |
| ADSERVERQUERY_VAL | Workflow | Mailing wird nach Freigabe erst verschickt wenn die angegebene Datei vorliegt (Plugin: adserverquery) | http://ad.efv.de/ RealMedia/ ads/ adstream_sx.ads/ newsletterwuv |
| ADSERVERQUERY_PARAMS | Workflow | Mailing wird nach Freigabe erst verschickt wenn die angegebene Datei vorliegt (Plugin: adserverquery) | kopf,unt1,unt2 |
| AUTOPUBLISH_DAY | Desktop | Tag (im Format xx) an dem automatisch publiziert werden solll | 21 |
| AUTOPUBLISH_HOUR | Desktop | Stunde (im 24h-Format) in der automatisch publiziert werden solll | 18 |
| AUTOPUBLISH_MIN | Desktop | Minute (im Format xx) in der automatisch publiziert werden solll | 21 |
| AUTOPUBLISH_MON | Desktop | MOnat (im Format MM, Januar = 01) an dem automatisch publiziert werden solll | 01 |
| AUTOPUBLISH_YEAR | Desktop | Jahr (im Format YYYY) an dem automatisch publiziert werden solll | 2012 |
| M_CLIENT_ID | Actionlogger | Legt fest zu welchem Mandant das Mailing zugeordnet wird in den Statistiken. Wenn Mandantendatenbanken definiert sind wird ggf. auch vom MMDB getEmails und MMDB Emailsender die Datenbank des entsprechenden Mandanten verwendet. Wird in Melin 4 automatisch gesetzt wenn nicht im Template vorhanden | 0 (für Superuser) |
| EXPORT_HTML2XML | NanoCMS | Fast ein Pflichtfeld. Das NanoCMS speichert Inhalte getrennt vom Layout, mit dieser Funktion erzeugt man das Feld X_BODY im XML-File das Content UND Layout enthält, die Grundlage für das Mailing | 1 |
| FROM | Emailsender | Absender-Emailadresse | newsletter@melin.com |
| LOG_CLIENT_ID | Actionlogger | Definiert den Mandant bei dem die Versandstatistiken erscheinen sollen | 0 |
| M_CHARSET | Emailsender | Content-Typ des Mailings. Um Umlauteprobleme zu vermeiden sollte das auf jeden Fall gesetzt werden. | UTF-8 |
| M_CREATE_PDF | NanoCMS | Beim Speichern des Dokuments wird eine PDF-Version erzeugt und in der Datenbanktabelle CMS_FULLTEXT abgelegt | 1 |
| M_CHECK_CHANNEL | Emailsender | Aktiviert den Abruf von Themenkanälen beim Versand (aus Performancegründen muss das aktiviert werden) | 1 |
| M_CLICK_RATE | Emailsender | Aktiviert die Messung von Klick ohne Benutzerinformation (baut Zählpixel ein) - alternativ (besser da man das Script auf Liveserver verteilen kann) kann man das Zählpixel auch selbst einbauen an irgendeiner Stelle, z.B. mit <img src="http://melin.sv-www.de/ p.php?OC=$UD[SYSTEM_CUSTOMER_ID]&ML= _M_PERCENT_ MAILING_ID_M_PERCENT_&NL= %NEWSLETTER_ID%" width=1 height=1> | |
| M_CONTENTTYPE | Emailsender | Content-Typ des Mailings. Um Umlauteprobleme zu vermeiden sollte das auf jeden Fall gesetzt werden. | text/html; charset=UTF-8 |
| M_CUSTOM_SCDB_SELECT | MMDB GetEmails | Abrufen der Abonnentenliste mit eigenem SQL-Statement | SELECT email AS EMAIL, id as USER_ID FROM abonnenten WHERE id = '_M_EMAIL' |
| M_EMAIL_SELECT_STATEMENT | Emailsender | Statement um die Emailadresse pro Empfänger aus einer Datenbank zu ziehen (wenn als Abonnentenliste zB. keine Emailadressen sondern Kundennummer vorliegen) | SELECT id AS EMAIL FROM abonnenten |
| M_EMAILSENDER_SUBSCRIBERSQL | Emailsender | Zusätzliche Abonnentendaten aus externer SQL-DB holen | SELECT * FROM meineTabelle WHERE EMAIL = %EMAIL%" |
| M_ENVELOPE_FROM | Emailsender | Adresse angeben auf der die Bounces ankommen sollen, siehe auch Verp | bounce@melin.com |
| M_GETAPPROVAL | NanoCMS | RollenID die man braucht um eine Freigabe erzeilen zu können | 2 |
| M_GETBYTARGETS | Workflow | Bemailt statt einer Emppfängerliste eine Zielgruppenliste aus dem Zielgruppenfilter | 612177 |
| M_IS_MULTIPART | Emailsender | Aktiviert die Kombination von Text und HTML zu Multipart | 1 |
| M_LINK_COMPRESS | Emailsender | Veraltete Version des Linktrackings | http://melin.de/j.jsp?ID= |
| M_LINK_TRACK | Emailsender | Linktracking: stellt allen Links im Mailing den gegebeben String voran um damit zu tracken | http://www.melin.com/melin/j.jsp?ML= _M_PERCENT_ M_MAILING_ID_M_PERCENT_&SC= _M_PERCENT_ SYSTEM_CUSTOMER_ID _M_PERCENT_&T= |
| M_NO_INLINE | Emailsender | Blockiert den Versand mit Inline-Images, selbst wenn welche enthalten sein sollten | 1 |
| M_PREVIEWBUTTON_HIDE | Desktop | Preview-Button ist nicht sichtbar | 1 |
| M_PREVIEW_NL | NanoCMS | Zeigt auf dem Schreibtisch einen "Vorschau an Gruppe" Button der Versand an eine hiermit definierte Testliste ermöglicht | 27 |
| M_PUBLISH_ROLE | NanoCMS | Der Publish-Button erscheint nur wenn man die gegebene Rolle(n) hat (wie M_REQUIRE_ROLE_FOR_PUBLISH) | bounce@melin.com |
| M_REQ_FILE | NanoCMS | Publish-Button erscheint nur wenn die angegebene Datei existiert | SITE-DIR/control.txt |
| M_REQUIRE_CLIENTID_FOR_PUBLISH | NanoCMS | Der Publish-Button erscheint nur wenn man die gegebenen Mandant(en) hat | 0,1,2 |
| M_REQUIRE_CLIENTID_FOR_EDIT | NanoCMS | Der Edit-Button erscheint nur wenn man die gegebenen Mandant(en) hat | 0,1,2 |
| M_REQUIRE_CLIENTID_FOR_VIEW | NanoCMS | Der Anzeigen-Button erscheint nur wenn man die gegebenen Mandant(en) hat | 0,1,2 |
| M_REQUIRE_BUID_FOR_PUBLISH | NanoCMS | Der Publish-Button erscheint nur wenn man die gegebenen Business Units hat | 0,1,2 |
| M_REQUIRE_BUID_FOR_EDIT | NanoCMS | Der Edit-Button erscheint nur wenn man die gegebenen Business Units hat | 0,1,2 |
| M_REQUIRE_BUID_FOR_VIEW | NanoCMS | Der Anzeigen-Button erscheint nur wenn man die gegebenen Business Units hat | 0,1,2 |
| M_REQUIRE_ROLE_FOR_PUBLISH | NanoCMS | Der Publish-Button erscheint nur wenn man die gegebenen Rollen(en) hat | 0,1,2 |
| M_REQUIRE_ROLEID_FOR_EDIT | NanoCMS | Der Edit-Button erscheint nur wenn man die gegebenen Rolle(n) hat | 0,1,2 |
| M_REQUIRE_ROLEID_FOR_VIEW | NanoCMS | Der Anzeigen-Button erscheint nur wenn man die gegebenen Rolle(n) hat | 0,1,2 |
| M_SEND_INLINE | Emailsender | Bilder immer inline schicken. Vor alle Bilder wird als Pfad das "DocumentRoot" der Melin-Installation (htdocs) gesetzt | 1 |
| M_SENDER | Emailsender | Absender Klartext-Name | Newsletter Infobrief |
| M_SKIP_ATTACHEMENTS | Emailsender | Nicht nach Attachements suchen (Option beschleunigt den Versand minimal) | 1 |
| M_TEMPLATE | Emailsender | Versandtemplate verwenden | SITE-DIR/ templates/ standalone_multipart.txt |
| M_TRIGGER_LIMIT | NanoCMS | Beim Freischalten wird nur eine Regel ausgeführt und die anderen übersprungen | osCommerce |
| MAILING_TYPE | Workflow | Art des Mailings (MULTIPART, TEXT, HTML) | MULLTIPART |
| NANOCMS_TRUEPARSER | NanoCMS | Edit-Modus: Ersetzt Personalisierungsfelder durch die Daten des eingeloggten Benutzers und versteckt die Platzhalter | Ihr aktueller Newsletter |
| NEWSLETTER_ID | Workflow | Bei einem Live-Versand wird die durch NEWSLETTER_ID definierte Empfängerliste bemailt (Plugin: mmdb_getemails) | 1 |
| M_PREVIEW_NL | Desktop | Auf dem Schreibtisch erscheint eine weitere Vorschau-Funktion: "Vorschau an Testliste" (M_PREVIEW_NL entspricht der NEWSLETTER_ID einer Testliste) | 1 |
| M_ALLOW_MULTIPUBLISH | Desktop | Zeigt einen neuen Button auf dem Schreibtisch der das Dokument auf die Schreibtische der angegeben Mandanten kopiert (neue Dokumente) | 1,2,3 |
| SUBJECT | Emailsender | Betreff des Mailings | Ihr aktueller Newsletter |
| TEXT_REPRESENTATION | NanoCMS | Das fertige Mailing (Text-Teil). Wenn das Eingabetemplate mehrsprachig ist wird für jede Sprachversion eine Variante erzeugt (TEXT_REPRESENTATION_DE, TEXT_REPRESENTATION_EN,...) | - |
| TRIGGER | NanoCMS | Setzt einen Wert den man über die Freischaltregel bei den Zielsystemen abfragen kann ("Value"). Abhängig vom Wert kann man eine Zielsystemregel ausführen. In den meisten Fällen lässt man das Feld weg und auch das Feld TRIGGER und VALUE in den Zielsystemen weg. | BCS |
| M_URL_PREFIX | Emailsender | Vor alle Bilder den gegebenen Pfad setzen | http://www.melin.de/ |
Die meisten Variablen werden in einem separaten Block am Ende des Templates als HIDDEN-Felder gesetzt, jedoch spricht nichts dagegen diese zum Teil auch für Redakteure editierbar zu machen oder sie per DropDown wählbar zu machen. In den Mustertemplates findet sich oft folgende Konstruktion
#IF ((" <!--XX-OPMODE-->" EQ "EDIT") OR (" <!--XX-OPMODE-->" EQ "NEW"))
<!-- default template for multipart mailings -->
<INPUT NAME="MELIN:M_TEMPLATE" VALUE="SITE-DIR/templates/standalone_multipart.txt" TYPE=HIDDEN>
<INPUT NAME="MELIN:M_IS_MULTIPART" VALUE="1" TYPE=HIDDEN>
#ENDIF
Die Frage die auch oft gestellt wird ist die nach den Pflichtfeldern. Um eine Mail zu verschicken müssen mindestens die folgenden Felder gesetzt sein:
- FROM
- SUBJECT
- M_TEMPLATE
- M_RECEIVER
- M_SENDER
- EXPORT_HTML2XML
Häufig genutzte weitere Felder sind
- M_CONTENTTYPE
- M_CHARSET
- M_IS_MULTIPART
- M_LINK_TRACK
[bearbeiten] Automatisch definierte Variablen
Zusätzlich zu den anwenderdefinierbaren Variablen erzeugt das NanoCMS auch eine Reihe von Variablen automatisch die nicht geändert werden können/sollten, es sei denn man weiß genau was man tut:
| Variable | Verarbeitet durch | Beschreibung | Beispiel-Wert |
|---|---|---|---|
| __DOCID | NanoCMS | Eindeutige ID des Mailings | 1232535742181 |
| __SECTION | NanoCMS | ID der Sektion ("Menüpunkt) in der Designvorlage zu dem das Dokument gehört | 401 |
| __SEQUENTIAL | NanoCMS | ? (kommt aus der structure.xml) | ? |
| __TEMPLATE | NanoCMS | Eingabetemplate im NanoCMS | /cms/themes/default/split.tmpl |
| __THEME | NanoCMS | Designvorlage | default |
| __CREATOR | NanoCMS | ID des Dokumenten-Erstellers (erster Redakteur) | 1 |
| __CREATED | NanoCMS | Zeitstempel an dem das Dokument erstellt wurde | 2009-01-21 12:02:22 |
| __LAST_EDITOR | NanoCMS | ID des letzen Bearbeiters | 1 |
| __LAST_MODIFIED | NanoCMS | Zeitstempel an dem das Dokument zuletzt bearbeitet wurde | 2009-01-21 12:02:22 |
| __ACL_ROLES | NanoCMS | Rolle(n) im NanoCMS die ein Redakteur benötigt um das Dokument bearbeiten zu können | 1,2,3 |
| __ACL_USERS | NanoCMS | User im NanoCMS die ein Redakteur benötigt um das Dokument bearbeiten zu können | 1,2,3 |
| __ACL_CLIENTS | NanoCMS | Mandant(en) im NanoCMS die ein Redakteur benötigt um das Dokument bearbeiten zu können | 1,2,3 |
| __LINGUA | NanoCMS | In Mehrsprachigen Templates die Liste der Sprachversionen | de,en |
| __CUSTOM_FOOTER | NanoCMS | In Mehrsprachigen Templates die Liste der Footer pro Sprache | footer_nl_de.txt,footer_nl_de.txt |
| __CUSTOM_NEWSLETTER | NanoCMS | In Mehrsprachigen Templates die NEWSLETTER_IDs (Empfängerlisten) pro Sprache | 102,104 |
| X_BODY | NanoCMS | Das fertige Mailing (HTML-Teil). Wenn das Eingabetemplate mehrsprachig ist wird für jede Sprachversion eine Variante erzeugt (X_BODY_DE, X_BODY_EN,...) | - |