GetEnv-Funktionen
Umgebungskonstanten ermöglichen es Ihnen, Daten während der Produktion abzufragen.
Syntax:
Konstanten werden wie folgt verwendet:
GetEnv(“Konstantenname”)
GetEnv-Funktionen:
Aktuelle Datensatznummer
Die Umgebungskonstante CurRecordNumber gibt die Nummer des Datensatzes aus, der gerade verarbeitet wird.
Falls die Produktion aufgeteilt wird, wird bei jedem Auftrag die Nummerierung des vorherigen Stapels fortgeführt.
Wenn beispielsweise die Produktion der Datensätze 21 - 40 in zwei Aufträge aufgeteilt wird, ist die Nummerierung des ersten Auftrags 1 - 10 und die des zweiten Auftrags 11 - 20.
Syntax:
GetEnv (“CurRecordNumber”)
Beispiel:
GetEnv("CurRecordNumber") = 5
Aktuelle Datensatznummer in Stapel
Die Umgebungskonstante CurRecordNumberInBatch gibt die Nummer des Datensatzes aus, der gerade verarbeitet wird.
Falls die Produktion aufgeteilt wird, wird bei jedem Auftrag die Nummerierung neu gestartet.
Wenn beispielsweise die Produktion der Datensätze 21 - 40 in zwei Aufträge aufgeteilt wird, ist die Nummerierung des ersten Auftrags 1 - 10 und die des zweiten Auftrags 1 - 10.
Syntax:
GetEnv ("CurRecordNumberInBatch")
Beispiel:
GetEnv("CurRecordNumberInBatch") = 5
Printmedien
Die Umgebungskonstante PrintMedia gibt True aus, wenn ein Printmedium hergestellt wird.
Syntax:
GetEnv(“PrintMedia”)
Proof-Set
Die Umgebungskonstante ProofSet gibt True aus, wenn ein Korrekturabzug hergestellt wird.
Syntax:
GetEnv(“ProofSet”)
HTMLMedia
Die Umgebungskonstante HTMLMedia gibt True aus, wenn ein HTML hergestellt wird: bei Bedarf, E-Mail oder Proof-HTML.
Syntax:
GetEnv(“HTMLMedia”)
TextMedia
Die Umgebungskonstante TextMedia gibt True aus, wenn ein Text hergestellt wird: SMS, Text.
Syntax:
GetEnv(“TextMedia”)
Hostanwendung
Die Umgebungskonstante HostApplication gibt den Namen der Anwendung aus, die den Plan ausführt. Mögliche Ausgabewerte sind unten aufgeführt.
|
Ausgabewert |
Beschreibung |
|---|---|
|
|
Der Plan wird von uProduce ausgeführt. uProduce verwendet einen Plan, um Cross-Media ausgaben herzustellen. Für Druckkampagnen kann uProduce Druck- und Proof-Aufträge sowie Proof-Sets herstellen. Für Internetkampagnen kann uProduce ICPs und E-Mail-Stapel herstellen. Für Cross-Media Kampagnen kann uProduce alle o.g. Produktionsarten ausführen. |
|
|
Der Plan oder Ausdruck wird von uCreate ausgeführt. uCreate kann folgende Ausgabearten produzieren: Druck: durch Auswahl von dynamischer Druck des Panels. Proof-Set: durch Auswahl der Exportoption des Panels. |
|
|
Der Plan wird von uPlan ausgeführt. uPlan verwendet zur Herstellung von Proof-Sets einen Plan. |
Syntax:
GetEnv("HostApplication")
Job ID
Die Umgebungskonstante JobID gibt die Auftragsnummer aus.
Syntax:
GetEnv ("JobId")
Beispiel:
GetEnv("JobId") = 103
ID übergeordneter Auftrag
Die Umgebungskonstante ParentJobId gibt im Falle eines Turboauftrags die Auftragsnummer des übergeordneten Auftrags an.
Syntax:
GetEnv ("ParentJobId")
Beispiel:
GetEnv("ParentJobId") = 103
Job Type
Die Umgebungskonstante JobType gibt die im Auftragsticket definierte Auftragsart zurück. Mögliche Ausgabewerte sind unten aufgeführt.
|
Wert |
Beschreibung |
|---|---|
|
|
Ein Druckauftrag. In uCreate Print deutet dieser Wert auf einen Auftrag hin, der mit der Menüoption Dynamischer Druck des Panels erstellt wurde. In uProduce deutet dieser Wert auf einen Auftrag hin, der über einen Klick auf die Schaltfläche Verarbeiten in der Seite Dokumentdetails erstellt wurde. |
|
|
Ein Auftrag zur Überprüfung. In uProduce deutet dieser Wert auf einen Auftrag hin, der über einen Klick auf die Schaltfläche Proof in der Seite Dokumentdetails erstellt wurde. |
|
|
Ein Proof-Set-Auftrag. In uCreate Print deutet dieser Wert auf einen Auftrag hin, der mit der Menüoption Exportieren des Panels erstellt wurde. In uProduce deutet dieser Wert auf einen Auftrag hin, der über einen Klick auf die Schaltfläche Erstellen in der Seite Plan-Details . In uPlan bedeutet dieser Wert, dass ein Auftrag mithilfe Erzeugen-Optionen des „Datenmenüs“ erstellt wurde, (zum Beispiel Proof-Set erzeugen...). |
|
|
Ein dynamische HTML-Produktionsauftrag (einst als „HTML-Produktion” bezeichnet). In uProduce deutet dieser Wert auf einen Auftrag hin, der über einen Klick auf die Schaltfläche Bereitstellen auf der Seite „Dokumentdetails“ (HTML oder TXT) erstellt wurde. |
|
|
Ein ICP-Auftrag (Interactive Content Port Job). Dieser Wert gibt an, dass der Plan von einem ICP ausgeführt wird. |
|
|
Ein Auftrag, der Informationen über einen künftigen Druckauftrag sammelt. Verschiedene FLAT-Aufträge desselben Dokumentes werden später gruppiert und als Eingabe eines einzigen Druckauftrags verwendet. Dies ist normalerweise der Fall bei einer Auftragsgruppierung, die mit uStore erstellt wurde. |
|
|
Ein E-Mail-Stapel-Auftrag. Dieser Wert weist auf einen Auftrag hin, der durch das Klicken auf die Schaltfläche Senden auf der Detailseite E-Mail-Aktivität erstellt wurde. |
|
|
Ein E-Mail-Stapel-Auftrag. Dieser Wert weist auf einen Auftrag hin, der durch das Klicken auf die Schaltfläche Test der Detailseite E-Mail-Aktivität erstellt wurde. |
Syntax:
GetEnv("JobType")
Teilenummer
Wenn ein Auftrag aufgeteilt wird, können Sie die Nummer des aktuellen Teils abrufen.
Syntax:
GetEnv ("SplitPart")
Beispiel:
GetEnv("SplitPart") = 2
DocumentName
Die Umgebungskonstante DocumentName gibt den Namen des Dokumentes vom Auftragsticket zurück.
Der Name des Dokuments wird in Print-Aufträgen und E-Mail-Aufträgen immer definiert. Wenn der dokumentname nicht definiert ist, gibt diese Funktion eine leere Zeichenkette aus.
Dieser Parameter kann in den ADOR-Ausdrücken der Kampagne dazu verwendet werden, eine unterschiedliche Logik für unterschiedliche Dokumente innerhalb derselben Kampagne festzulegen. Zum Beispiel, Sie können eine Regel einrichten, die hochauflösende Bilder für ein bestimmtes Dokument namens „HighQualityPostcard” und niedrig auflösende Bilder für Dokumente mit jedem anderen Namen erstellt.
Syntax:
GetEnv (“DocumentName”)
Beispiel:
GetEnv("DocumentName") = HighQualityPostcard
DocumentID
Die Umgebungskonstante DocumentID gibt den Namen des Dokumentes vom Auftragsticket zurück.
Die Dokumentkennung ist in Aufträgen, die mit uProduce erstellt wurden, immer definiert, aber nie in Aufträgen, die mit uCreate erstellt wurden. Wenn die Dokument-ID nicht definiert ist, gibt diese Funktion eine leere Zeichenkette aus.
Dieser Parameter kann in den ADOR-Ausdrücken
der Kampagne dazu verwendet werden, eine unterschiedliche Logik für
unterschiedliche Dokumente innerhalb derselben Kampagne festzulegen.
Sie können beispielsweise eine Regel einrichten, die
hochauflösende Bilder für ein bestimmtes Dokument mit der Kennung 5
und niedrig auflösende Bilder für Dokumente mit jeder anderen Kennung erstellt.
Syntax:
GetEnv (“DocumentID”)
Beispiel:
GetEnv("DocumentID") = 5
Document Type
Die Umgebungskonstante DocumentType gibt den im Auftragsticket definierten Dokumenttyp zurück. Mögliche Ausgabewerte finden Sie in unten befindlicher Tabelle.
|
Ausgabewert |
Beschreibung |
|---|---|
|
|
Ein HTML-Dokument |
|
|
Ein Adobe-InDesign-Dokument |
|
|
Ein Text-Dokument |
|
|
Ein XMPie eigenes XLIM-Dokument |
Syntax:
GetEnv("DocumentType")
Hinweis: Dieser Ausdruck gibt einen gültigen Wert nur für die folgenden Auftragsarten zurück (andere Auftragsarten geben eine leere Zeichenkette zurück):
PROOF
ON_DEMAND
EMAIL_MARKETING
EMAIL_MARKETING_TEST
Instanz-ID
Wenn Sie eine Vorlage nutzen, um eine Instanz zu erstellen, wird die Webseite in der Vorlage definiert und wird von allen Instanzen geteilt.
Alle Instanzen greifen auf dieselben Webseiten zu und verwenden dieselben URLs. Die Instanz-ID in der URL wird dazu verwendet, zwischen Instanzen zu differenzieren.
Um den Wert von InstanceID zu erhalten, müssen Sie ein ADOR erstellen, das die Funktion GetEnv("InstanceID“) beinhaltet.
Um beispielsweise eine URL für eine spezifische Webseite mithilfe des ADORs Instanz-ID zu erstellen, zum Beispiel {{GetEnvInstanceID}}, sollte das URL-Format wie folgt aussehen:
http://www.MyDomain.com/{{GetEnvInstanceID}}/{{XMPieRecipientKey}}
http://www.MyDomain.com/MyFolder/Landing.html?iid={{GetEnvInstanceID}}&rid={{XMPieRecipientKey}}
Syntax:
GetEnv("InstanceID")
Base URL
Die Base URL für die Website, wie sie in der Circle-Kampagne, -Vorlage oder -Instanz definiert wurde.
Syntax:
GetEnv("BaseURL")
Beispiel:
GetEnv("BaseURL") = "http://www.MyDomain.com/1432/{{XMPieRecipientKey}}"
Online-Dokument Base URL
Die Base URL für das On-Demand-PDF wie sie in der Circle-Kampagne, -Vorlage oder -Instanz definiert wurde.
Syntax:
GetEnv("BaseOnlineDocURL")
Beispiel:
GetEnv("BaseOnlineDocURL") = "http://www.MyDomain.com/XMPieDownloadPDF?"
Circle Touchpoint Friendly ID
Die Umgebungskonstante CircleTouchpointFriendlyID gibt die Friendly ID des Circle-Touchpoints vom Auftragsticket zurück.
Syntax:
GetEnv("CircleTouchpointFriendlyID")
TopMostJobId
Die Umgebungskonstante TopMostJobId gibt die Auftragsnummer, oder im Falle eines Turboauftrags, die Auftragsnummer des übergeordneten Auftrags an.
Syntax:
GetEnv ("TopMostJobId")
Beispiel:
GetEnv("TopMostJobId") = 103
RecipientFilter
Die Umgebungskonstante RecipientFilter gibt den Empfängerfilter zurück, der bei der Produktion verwendet wurde. Dabei handelt es sich entweder um den Tabellennamen, den Namen des Planfilters oder die Anfrage.
Syntax:
GetEnv ("RecipientFilter")
Beispiel:
GetEnv("RecipientFilter") = "Recipient Table"
HotFolderFileName
Die Funktion GetEnv ("HotFolderFileName") gibt den Namen der Datei zurück, die den Auftrag ausgelöst hat.
Hinweis: Wenn ein Auftrag nicht vom Hot-Folder-Mechanismus ausgelöst wurde, gibt diese Funktion eine leere Zeichenfolge zurück.
Sie können diese Funktion zur Erstellung eines ADORs verwenden, das als Ausgabedatei-Name basierend auf diesem ADOR verwendet wird.
Syntax:
GetEnv ("HotFolderFileName")
Beispiel:
GetEnv ("HotFolderFileName")