Exemples de code JavaScript dans les workflows javascript-in-workflows

Ces exemples montrent comment vous pouvez utiliser le code JavaScript dans un workflow :

En savoir plus sur les méthodes SOAP statiques et non statiques.

Dans ces exemples, l’extension ECMAScript pour XML (E4X) est utilisée. Avec cette extension, vous pouvez combiner des appels JavaScript et des primitives XML dans le même script.

Pour tester ces exemples, procédez comme suit :

Exemple 1 : écriture dans la base de données write-example

Pour écrire dans la base de données, vous pouvez utiliser la méthode Write statique sur le schéma xtk:session :

Étape 1 : composer une demande d’écriture

Vous pouvez ajouter, mettre à jour et supprimer des enregistrements.

Insertion d’un enregistrement

L’opération insert étant l’opération par défaut, vous n’avez pas besoin de la préciser.

Indiquez ces informations sous forme d’attributs XML :

Exemple :

var myXML = <recipient xtkschema="nms:recipient"
    firstName="Isabel"
    lastName="Garcia"
    email="isabel.garcia@mycompany.com"/>

Mise à jour d’un enregistrement

Utilisez l’opération _update.

Indiquez ces informations sous forme d’attributs XML :

Exemple :

var myXML = <recipient xtkschema="nms:recipient"
    status="Client"
    email="isabel.garcia@mycompany.com"
    operation="_update"
    _key="@email"/>

Suppression d’un enregistrement

Utilisez la méthode DeleteCollection. En savoir plus.

Indiquez les informations suivantes :

Exemple :

xtk.session.DeleteCollection(
    "nms:recipient",
    <where>
        <condition expr="[@email] = 'isabel.garcia@mycompany.com'"/>
    </where>,
    false
    )

Étape 2 : écrire l’enregistrement

Appelez la méthode Write non statique sur le schéma xtk:session :

xtk.session.Write(myXML)

Aucune valeur n’est renvoyée pour cette méthode.

Ajoutez le code complet à une activité Code JavaScript dans le workflow :

var myXML = <recipient xtkschema="nms:recipient"
    firstName="Isabel"
    lastName="Garcia"
    email="isabel.garcia@mycompany.com"/>

xtk.session.Write(myXML)

Cette vidéo montre comment écrire dans la base de données :

Exemple 2 : interrogation de la base de données read-example

Pour interroger la base de données, vous pouvez utiliser la méthode d’instance xtk:queryDef non statique :

Étape 1 : composer une requête

Spécifiez le code XML pour une entité queryDef.

Syntaxe :

<queryDef schema="nms:recipient" operation="">
    <!-- select, where, and orderBy clauses as XML elements -->
</queryDef>

Indiquez les informations suivantes :

Vous pouvez utiliser les opérations suivantes :

Écrivez les clauses select, where et orderBy en tant qu’éléments XML :

Étape 2 : créer un objet de requête

Pour créer une entité à partir du code XML, utilisez la méthode create(content) :

var query = xtk.queryDef.create(
    <queryDef schema="nms:recipient" operation="select">
    …
    </queryDef>)

Préfixez la méthode create(content) avec le schéma de l’entité à créer.

L’argument content correspond à un argument de chaîne et est facultatif. Cet argument contient le code XML qui décrit l’entité.

Étape 3 : exécuter la requête

Procédez comme suit :

Résultats d’une opération select

Toutes les correspondances sont renvoyées sous forme de collection :

<recipient-collection>
    <recipient email="jane.smith@mycompany.com">
    <recipient email="john.harris@mycompany.com">
</recipient-collection>

Pour effectuer une itération sur les résultats, utilisez la boucle for each :

for each (var rcp in res:recipient)
    logInfo(rcp.@email)

La boucle comprend une variable de destinataire locale. L’e-mail de chaque destinataire renvoyé dans la collection de destinataires est imprimé. En savoir plus sur la fonction logInfo.

Résultats d’une opération getIfExists

Chaque correspondance est renvoyée en tant qu’élément :

<recipient id="52,378,079">

Si aucune correspondance n’est trouvée, un élément vide est renvoyé :

<recipient/>

Vous pouvez vous référer au nœud de la clé primaire, par exemple, l’attribut @id :

if (res.@id !=undefined)
    { // match was found
    …
    }

Résultat d’une opération get

Une correspondance est renvoyée en tant qu’élément :

<recipient id="52,378,079">

Si aucune correspondance n’est trouvée, une erreur est renvoyée.

Résultat d’une opération count

Un élément avec l’attribut count est renvoyé :

<recipient count="200">

Pour utiliser le résultat, reportez-vous à l’attribut @count :

if (res.@count > 0)
    { // matches were found
    …
    }

Pour l’opération select, ajoutez ce code à une activité Code JavaScript dans le workflow :

var myXML =
<queryDef schema="nms:recipient" operation="select">
    <select>
        <node expr="@firstName"/>
        <node expr="@lastName"/>
    </select>
</queryDef>

var query = xtk.queryDef.create(myXML)

var res = query.ExecuteQuery()

for each (var rcp in res.recipient)
    logInfo(rcp.@firstName + " " + rcp.@lastName)

L’opération select étant l’opération par défaut, vous n’avez pas besoin de la préciser.

Cette vidéo montre comment effectuer une lecture à partir de la base de données :

Déclenchement d’un workflow trigger-example

Vous pouvez déclencher des workflows par programme, par exemple dans des workflows techniques ou pour traiter les informations saisies par un utilisateur sur une page d’application web.

Le déclenchement d’un workflow s’effectue à l’aide d’événements. Vous pouvez utiliser ces fonctionnalités pour les événements :

Vous pouvez déclencher des workflows de différentes manières :

Syntaxe de la méthode PostEvent :

PostEvent(
    String     //ID of the target workflow
    String     //Name of the target activity
    String     //Name of the transition to be activated in case of multiple transitions
    XML        //Event parameters, in the <variables/> element
    Boolean    //To trigger the target workflow only once, set this parameter to true.
)

Dans cet exemple, une fois le workflow terminé, un texte court est transmis à l’activité Signal du workflow wkfExampleReceiver  :

var strLabel = "Adobe Campaign, Marketing that delivers"
xtk.workflow.PostEvent(
    "wkfExampleReceiver",
    "signal",
    "",
    <variables strLine={strLabel}/>,
    false)

Comme le dernier paramètre est défini sur false, le workflow wkfExampleReceiver est déclenché chaque fois que le workflow initial est terminé.

Lorsque vous déclenchez des workflows, tenez compte des principes suivants :

Cette vidéo montre comment utiliser des méthodes d’API statiques :

Cette vidéo montre comment déclencher des workflows :

Interaction avec la base de données interact-example

Ces exemples montrent comment effectuer ces actions :

Procédez comme suit :

Syntaxe de la méthode queryDef avec une clause select

<queryDef schema="schema_key" operation="operation_type">
    <select>
        <node expr="expression1">
        <node sql="expression2">
    </select>
    <where>
        <condition expr="expression1"/>
        <condition sql="expression2"/>
    </where>
    <orderBy>
        <node expr="expression1">
        <node sql="expression2">
    </orderBy>
    <groupBy>
        <node expr="expression1">
        <node sql="expression2">
    </groupBy>
    <having>
        <condition expr="expression1"/>
        <condition sql="expression2"/>
    </having>
</queryDef>

Méthode Create

Exemple 1 : sélection d’enregistrements et écriture dans le journal

Les noms internes des workflows situés dans le dossier wfExamples sont sélectionnés. Les résultats sont triés par nom interne, par ordre croissant et écrits dans le journal.

var query = xtk.queryDef.create(
    <queryDef schema="xtk:workflow" operation="select">
        <select>
            <node expr="@internalName"/>
        </select>
        <where>
            <condition expr="[folder/@name]='wfExamples'"/>
        </where>
        <orderBy>
            <node expr="@internalName" sortDesc="false"/>
        </orderBy>
    </queryDef>
    )

var res = query.ExecuteQuery()
for each (var w in res.workflow)
    logInfo(w.@internalName)

Exemple 2 : suppression d’enregistrements

Le prénom, le nom, l’e-mail et l’identifiant de tous les destinataires nommés Chris Smith sont sélectionnés. Les résultats sont triés par e-mail, par ordre croissant et écrits dans le journal. Une opération delete est utilisée pour supprimer les enregistrements sélectionnés.

// Build the query, create a query object and hold the object in a variable
var query = xtk.queryDef.create(
        <queryDef schema="nms:recipient" operation="select">
            <select>
                <node expr="@firstName"/>
                <node expr="@lastName"/>
                <node expr="@email"/>
                <node expr="@id"/>
            </select>
            <where>
                <condition expr="[folder/@label]='Recipients'"/>
                <condition expr="[@lastName]='Smith'"/>
                <condition expr="[@firstName]='Chris'"/>
            </where>
            <orderBy>
                <node expr="@email" sortDesc="false"/>
            </orderBy>
        </queryDef>
)

//Run the query using the ExecuteQuery method against the created object
var res = query.ExecuteQuery()

//Loop through the results, print out the person's name and email, then delete the records
for each (var rec in res.recipient)
    {
     logInfo("Delete record = Email: " + rec.@email + ', ' + rec.@firstName + ' ' + rec.@lastName)
     xtk.session.Write(<recipient xtkschema="nms:recipient" _operation="delete" id={rec.@id}/>)
    }

Exemple 3 : sélection des enregistrements et écriture dans le journal

Dans cet exemple, une méthode non statique est utilisée. L’e-mail et l’année de naissance de tous les destinataires dont les informations sont stockées dans le dossier 1234 et dont le nom de domaine de messagerie commence par « adobe » sont sélectionnés. Les résultats sont triés par date de naissance dans l’ordre décroissant. L’e-mail du destinataire est écrit dans le journal.

var query = xtk.queryDef.create(
<queryDef schema="nms:recipient" operation="select">
    <select>
        <node expr="@email"/>
        <node sql="sEmail"/>
        <node expr="Year(@birthDate)"/>
    </select>
    <where>
        <condition expr="[@folder-id] = 1234 and @domain like 'adobe%'"/>
        <condition sql="iFolderId = 1234 and sDomain like 'adobe%'"/>
    </where>
    <orderBy>
        <node expr="@birthDate" sortDesc="true"/>
    </orderBy>
</queryDef>
)

var res = query.ExecuteQuery()
for each (var w in res.recipient)
    logInfo(w.@email)

Méthode Write

Vous pouvez insérer, mettre à jour et supprimer des enregistrements. Vous pouvez utiliser la méthode Write sur n’importe quel schéma dans Adobe Campaign. Cette méthode étant statique, il n’est pas nécessaire de créer un objet. Vous pouvez utiliser les opérations suivantes :

Exemple 1 : insertion ou mise à jour d’un enregistrement

xtk.session.Write(
<recipient
    xtkschema="nms:recipient"
    _operation="insertOrUpdate" _key="@email"
    lastName="Lennon"
    firstName="John"
    email="johnlennon@thebeatles.com"
/>
)

Exemple 2 : suppression d’enregistrements

Cet exemple combine une méthode statique à une méthode non statique.

var query=xtk.queryDef.create(
<queryDef schema="nms:recipient" operation="select">
    <select>
        <node expr="@Id"/>
    </select>
    <where>
        <condition expr="[@email]='johnlennon@thebeatles.com'"/>
    </where>
</queryDef>
);

var res = query.ExecuteQuery()
for each (var w in res.recipient) {
xtk.session.Write(
    <recipient xtkschema="nms:recipient" _operation="delete" id={w.@id}/>
);
}

Cette vidéo montre comment utiliser des méthodes d’API non statiques :

Cette vidéo présente un exemple d’utilisation d’une méthode d’API non statique dans un workflow :

Rubriques connexes

Documentation des API