Fonctions GetEnv
Les constantes d’environnement vous permettent de récupérer des données en cours de production.
Syntaxe :
Les constantes sont utilisées comme suit :
GetEnv(“nom de constante”)
Les fonctions GetEnv sont les suivantes :
Numéro de l'enregistrement actuel
La constante d’environnement CurRecordNumber retourne le numéro de l’enregistrement actuellement traité.
En cas de production avec découpage, chaque tâche poursuit la numérotation du lot précédent.
Par exemple, si la production des enregistrements 21 à 40 est divisée en deux tâches, la numérotation de la première tâche sera assujettie de numéros de 1 à 10 et celle de la seconde tâche, 11 à 20.
Syntaxe :
GetEnv (“CurRecordNumber”)
Exemple :
GetEnv("CurRecordNumber") = 5
Numéro de l'enregistrement actuel dans un lot
La constante d’environnement CurRecordNumberInBatch retourne le numéro de l’enregistrement actuellement traité.
En cas de production découpée, chaque tâche relance la numérotation.
Par exemple, si la production des enregistrements 21 à 40 est divisée en deux tâches, la numérotation de la première tâche sera assujettie de numéros de 1 à 10 et celle de la seconde tâche, 1 à 10.
Syntaxe :
GetEnv (“CurRecordNumberInBatch”)
Exemple :
GetEnv("CurRecordNumberInBatch") = 5
Print Media
La constante d’environnement PrintMedia retourne sur Vrai s’il s’agit de la production d’un document d’impression.
Syntaxe :
GetEnv(“PrintMedia”)
Jeu d'épreuvage
La constante d’environnement ProofSet retourne à Vrai s’il s’agit de la production d’un jeu d’épreuvage.
Syntaxe :
GetEnv(“ProofSet”)
HTML Media
La constante d’environnement TextMedia retourne à Vrai s’il s’agit de la production d’un HTML : sur demande, e-mail, ou une épreuve html.
Syntaxe :
GetEnv(“HTMLMedia”)
Text Media
La constante d’environnement TextMedia retourne à Vrai s’il s’agit de la production d’un texte : SMS, texte.
Syntaxe :
GetEnv(“TextMedia”)
Application hôte
La constante d’environnement HostApplication retourne le nom de l’application qui exécute le plan. Les valeurs retournées possibles sont énumérées ci-dessous.
|
Valeur de retour |
Description |
|---|---|
|
|
Le plan est exécuté par uProduce. uProduce utilise un plan pour produire des sorties multicanal Concernant les campagnes d'impression, uProduce peut produire des tâches d'impression et d'épreuvage, ainsi que des jeux d'épreuves. Pour les campagnes Web, uProduce peut produire des ICP et des lots d'e-mails. Pour les campagnes cross-média, uProduce peut effectuer tous les types de production ci-dessus . |
|
|
Le plan ou l'expression est exécuté par uCreate. uCreate peut produire les types de sortie suivants : Impression : en choisissant l’option Impression dynamique du panneau. Jeux d’épreuvage : en choisissant l' option d'exportation du panneau. |
|
|
Le plan est exécuté par uPlan. uPlan utilise un plan pour produire des jeux d’épreuvage. |
Syntaxe :
GetEnv("HostApplication")
Job ID (Identifiant de la Tâche)
La constante d'environnement Jobid renvoie l’identifiant de la tâche en cours.
Syntaxe :
GetEnv ("JobId")
Exemple :
GetEnv("JobId") = 103
Identifiant de la tâche parent
La constante d'environnement ParentJobId renvoie, dans le cas d'une tâche turbo , l'ID de tâche parent.
Syntaxe :
GetEnv ("ParentJobId")
Exemple :
GetEnv("ParentJobId") = 103
Type de travail
La constante d’environnement JobType retourne le type de travail défini dans le bon de travail. Les valeurs retournées possibles sont énumérées ci-dessous.
|
Valeur |
Description |
|---|---|
|
|
Un travail d’impression. Dans uCreate Print, cette valeur indique une tâche créée à l’aide de l’option Impression dynamique du panneau . Dans uProduce, cette valeur indique une tâche créée en cliquant sur le bouton Traiter de la page Détails du document . |
|
|
Un travail d’épreuvage. Cette valeur indique une tâche créée à l'aide de uProduce, en cliquant sur le bouton Épreuve de la page Détails du document. |
|
|
Un travail de jeu d’épreuvage. Dans uCreate Print, cette valeur indique une tâche créée à l'aide de l'option Exporter... option de menu. Dans uProduce, cette valeur indique une tâche créée en cliquant sur le bouton Générer de la page Détails du plan. Dans uPlan, cette valeur indique une tâche créée à l'aide de l'une des options «Générer» du menu Données (par exemple, générer un jeu d'épreuves... option). |
|
|
Un travail de production HTML dynamique (précédemment appelé production HTML). Cette valeur indique un travail créé au moyen de uProduce, en cliquant sur le bouton Deploy de la page de détails du document (HTML ou TXT). |
|
|
Un travail de Port de contenu interactif (ICP). Cette valeur indique que le Plan est exécuté par un ICP. |
|
|
Un travail collectant des informations sur un futur travail d’impression. Plusieurs tâches FLAT du même document sont plus tard amalgamés et utilisés comme entrée d’un travail d'impression unique. C’est normalement le cas avec un amalgame de travaux créé par uStore. |
|
|
Un travail d’Emails par lot. Cette valeur indique une tâche créée en cliquant sur le bouton Envoyer de la page Détails de l'activité d'e-mail. |
|
|
Un travail de test d’emails par lot. Cette valeur indique une tâche créée en cliquant sur le bouton Test de la page Détails de l'activité d'e-mail. |
Syntaxe :
GetEnv("JobType")
Découpage
En cas de découpage de tâche, vous pouvez obtenir le numéro de référence de découpage.
Syntaxe :
GetEnv ("SplitPart")
Exemple :
GetEnv("SplitPart") = 2
Nom du document
La constante d’environnement DocumentName retourne le nom du document à partir du bon de travail.
Le nom du document est toujours définit dans les travaux d’impression et les travaux d’e-mail. Si le nom du document n’est pas défini, cette fonction retourne à une chaîne vide.
Ce paramètre peut être utilisé dans les expressions d’objet de contenu de la campagne pour définir une logique différente pour différents documents au sein de la même campagne. Par exemple, vous pouvez définir une règle permettant de créer des images haute résolution pour un document spécifique nommé "HighQualityPostcard" et des images basse résolution pour les documents portant un autre nom.
Syntaxe :
GetEnv(“ DocumentName“)
Exemple :
GetEnv("DocumentName") = HighQualityPostcard
Identifiant de document
La constante d’environnement DocumentID retourne l’identifiant du document à partir du bon de travail.
L’identifiant du document est toujours fini pour les travaux créés par uProduce, mais jamais pour ceux créés par uCreate. Si l’identifiant du document n’est pas défini, cette fonction retourne à une chaîne vide.
Ce paramètre peut être utilisé dans les expressions d'objet de contenu de la campagne
pour définir une logique différente pour différents documents
au sein d'une même campagne.
Par exemple, vous pouvez définir une règle qui crée des images haute résolution pour
un document spécifique dont l'ID est 5 et des images basse résolution pour le document
portant n'importe quel autre ID.
Syntaxe :
GetEnv(“ DocumentID“)
Exemple :
GetEnv("DocumentID") = 5
Document Type
La constante d’environnement DocumentType retourne le type de travail défini dans la fiche de travail. Les valeurs de retour possibles sont énumérées dans le tableau suivant.
|
Valeur de retour |
Description |
|---|---|
|
|
Un document HTML |
|
|
Un document Adobe InDesign |
|
|
Un document texte |
|
|
Un document XLIM propriétaire XMPie |
Syntaxe :
GetEnv("DocumentType")
Remarque : Cette expression retourne une valeur valide uniquement pour les types de travaux suivants (tous les autres types de travaux retournent une valeur vide) :
PROOF
ON_DEMAND
EMAIL_MARKETING
EMAIL_MARKETING_TEST
ID d’instance
En créant une instance à partir d’un modèle, le site Web est défini dans le modèle et il est partagé par toutes les instances.
Toutes les instances accèdent aux mêmes pages internet et utilisent les mêmes URLs de sites internet. L’ID d’instance ID est l’URL utilisée pour différencier les instances.
Afin d’obtenir la valeur InstanceID, vous devez créer un objet de contenu qui comprenne la fonction GetEnv("InstanceID").
Par exemple, pour créer une URL vers une page Web spécifique en utilisant l’objet de contenu InstanceID, c’est-à-dire {{ GetEnvInstanceID}}, le format de l’URL doit être comme suit :
http://www.MyDomain.com/{{GetEnvInstanceID}}/{{XMPieRecipientKey}}
http://www.MyDomain.com/MyFolder/Landing.html?iid={{GetEnvInstanceID}}&rid={{XMPieRecipientKey}}
Syntaxe :
GetEnv("InstanceID")
URL de base
URL de base du site Web défini dans la campagne , le modèle ou l'instance Circle.
Syntaxe :
GetEnv("BaseURL")
Exemple :
GetEnv("BaseURL") = "http://www.MyDomain.com/1432/{{XMPieRecipientKey}}"
URL du document en ligne de base
URL de base d'un PDF à la demande défini dans la campagne, le modèle ou l'instance Circle.
Syntaxe :
GetEnv("BaseOnlineDocURL")
Exemple :
GetEnv("BaseOnlineDocURL") = "http://www.MyDomain.com/XMPieDownloadPDF?"
ID intuitif du point de contact dans Circle
La constante d’environnement CircleTouchpointFriendlyID renvoie l’identifiant intuitif du point de contact Circle depuis la fiche de travail.
Syntaxe :
GetEnv("CircleTouchpointFriendlyID")
TopMostJobId
La constante d'environnement ParentJobId renvoie , dans le cas d'un tâche turbo, l’identifiant de la tâche parent.
Syntaxe :
GetEnv ("TopMostJobId")
Exemple :
GetEnv("TopMostJobId") = 103
RecipientFilter
La constante d'environnement RecipientFilter renvoie le filtre destinataire utilisé en production, à savoir le nom du tableau, le nom du filtre de plan ou la requête.
Syntaxe :
GetEnv ("RecipientFilter")
Exemple :
GetEnv("RecipientFilter") = "Recipient Table"
HotFolderFileName
La fonction Getenv ("HotFolderFileName") renvoie le nom du fichier ayant déclenché la tâche.
À noter que, lorsqu’une tâche n'a pas été déclenchée par le mécanisme Dossier actif, cette fonction renvoie une chaîne vide.
Vous pouvez utiliser cette fonction pour créer un ADOR qui sera utilisé comme nom de fichier de sortie basé sur cet ADOR.
Syntaxe :
GetEnv ("HotFolderFileName")
Exemple :
GetEnv ("HotFolderFileName")