Show Menu
SUJETS×

Appeler un workflow avec des paramètres externes

Campaign Standard vous permet d'appeler un workflow avec des paramètres (un nom d'audience à cibler, un nom de fichier à importer, un contenu de message, etc.). De cette façon, vous pouvez facilement intégrer vos automatisations Campaign avec votre système externe.
Prenons l'exemple suivant où nous voulons envoyer des emails directement à partir d'un CMS. Dans ce cas, vous pouvez configurer votre système afin de sélectionner l'audience et le contenu email dans le CMS. Cliquer sur Envoyer appellera ensuite un workflow Campaign avec ces paramètres, vous permettant de les utiliser dans le workflow de manière à définir l'audience et le contenu d'URL à utiliser dans la diffusion.
Le processus pour appeler un workflow avec des paramètres est le suivant :
  1. Déclarez les paramètres dans le . External signal Voir Déclarer les paramètres dans l'activité Signal externe .
  2. Configure the End activity or the API call to define the parameters and trigger the workflow External signal activity.
Une fois le workflow déclenché, les paramètres sont ingérés dans les variables d'événements du workflow et peuvent être utilisés au sein du workflow. Voir Personnaliser un workflow avec des paramètres externes .

Déclarer les paramètres dans l'activité Signal externe

The first step to call a workflow with parameters is to declare them in an External signal activity.
  1. Ouvrez le , puis sélectionnez l’ External signal Parameters onglet.
  2. Click the Create element button, then specify the name and type of each parameter.
    Assurez-vous que le nom et le nombre de paramètres correspondent à ce qui est défini lors de l'appel du workflow (voir Définir les paramètres lors de l'appel du workflow ). De plus, les types des paramètres doivent être cohérents par rapport aux valeurs attendues.
  3. Une fois les paramètres déclarés, terminez la configuration du workflow, puis exécutez-le.

Définir les paramètres lors de l'appel du workflow

Cette section explique comment définir des paramètres lors de l'appel d'un workflow. Pour plus d'informations sur l'exécution de cette opération à partir d'un appel API, consultez la documentation des API REST .
Avant de définir les paramètres, vérifiez les éléments suivants :
To configure the End activity, follow the steps below:
  1. Ouvrez le , puis sélectionnez l’ End External signal onglet.
  2. Sélectionnez le workflow et l'activité Signal externe que vous voulez appeler.
  3. Click the Create element button to add a parameter, then fill in its name and value.
    Make sure that all the parameters have been declared in the External signal activity. Dans le cas contraire, une erreur se produira lors de l'exécution de l'activité.
  4. Une fois les paramètres définis, confirmez l'activité, puis enregistrez votre workflow.

Suivi des variables d'événements

Il est possible de suivre les variables d'événements disponibles dans le workflow, y compris les paramètres externes déclarés. Pour cela, procédez comme suit :
  1. Sélectionnez le qui suit le External signal , puis cliquez sur le Log and tasks bouton.
  2. In the Tasks tab, click button.
  3. Le contexte d'exécution de la tâche s'affiche (ID, état, durée, etc.), y compris toutes les variables d'événements actuellement disponibles dans le workflow.

Personnaliser un workflow avec des paramètres externes

Une fois le workflow déclenché, les paramètres sont ingérés dans les variables d'événements et peuvent être utilisés pour personnaliser les activités du workflow.
They can, for example, be used to define which audience to read in the Read audience activity, the name of the file to transfer in the Transfer file activity, etc.
Les activités personnalisables avec des variables d'événements sont présentées dans cette section .

Utiliser des variables d'événements

Les variables d'événements sont utilisées dans une expression qui doit respecter la syntaxe standard .
The syntax to use events variables must follow the format below, and use the parameter's name that has been defined in the External signal activity (see Declaring the parameters in the External signal activity ):
$(vars/@parameterName)

Dans cette syntaxe, la fonction $ renvoie le type de données chaîne . Si vous souhaitez spécifier un autre type de données, utilisez les fonctions suivantes :
  • $long  : nombre entier.
  • $float  : nombre décimal.
  • $boolean  : vrai/faux.
  • $datetime  : horodatage.
Si vous utilisez une variable dans une activité, l'interface vous aide à l'appeler.
  • : sélectionnez la variable de parmi toutes les variables disponibles dans le flux de travaux.
  •  : éditez les expressions en associant des variables et des fonctions. Pour plus d'informations sur l'éditeur d'expression, voir cette section .
Rubriques connexes :

Personnaliser les activités avec des variables d'événements

Les variables d'événements peuvent servir à personnaliser plusieurs activités, répertoriées dans la section ci-dessous. Pour plus d'informations sur la façon d'appeler une variable à partir d'une activité, consultez cette section .
Read audience : définissez le à en fonction des variables de.
Pour plus d'informations sur la façon d'utiliser l'activité, consultez la section dédiée .
Test Activité  :  : créez des conditions reposant sur des variables d'événements.
Pour plus d'informations sur la façon d'utiliser l'activité, consultez la section dédiée .
Transfer file : personnalisez le fichier à transférer en fonction de variables .
Pour plus d'informations sur la façon d'utiliser l'activité, consultez la section dédiée .
Query : peuvent être référencés dans un , en utilisant , en combinant des variables et des fonctions de. To do this, add a rule then click the Advanced mode link to access the expression editing window (see Advanced expression editing ).
Pour plus d'informations sur la façon d'utiliser l'activité, consultez la section dédiée .
Channels : personnalisez les en fonction des variables .
Les valeurs des paramètres de diffusion sont récupérées chaque fois que la diffusion est préparée.
La préparation des diffusions récurrentes repose sur la période d'agrégation de diffusion. Par exemple, si la période d'agrégation est "par jour", la diffusion n'est repréparée qu'une fois par jour. Si la valeur d'un paramètre de diffusion est modifiée pendant la journée, elle n'est pas mise à jour dans la diffusion, car celle-ci a déjà été préparée une fois.
If you plan on calling the workflow multiple times a day, use the No aggregation option, so that the delivery parameters are updated each time. Pour plus d'informations sur la configuration des diffusions récurrentes, consultez cette section .
Pour personnaliser une diffusion en fonction de variables d'événements, vous devez tout d'abord déclarer dans l'activité de diffusion les variables que vous voulez utiliser :
  1. Sélectionnez l'activité, puis cliquez sur le bouton afin d'accéder aux paramètres.
  2. Select the General tab, then add the events variables that will be available as personalization fields in the delivery.
  3. Cliquez sur le Confirm bouton.
Les variables d'événements déclarées sont à présent disponibles dans la liste des champs de personnalisation. Vous pouvez les utiliser dans la diffusion de façon à réaliser les actions ci-dessous :
  • Définissez le nom du modèle à utiliser pour la diffusion.
    Cette action est disponible uniquement pour les diffusions récurrentes .
  • Personalize the delivery: when selecting a personalization field to configure a delivery, events variables are available in the Workflow parameters element. Vous pouvez les utiliser comme tout autre champ de personnalisation, par exemple pour définir l'objet de la diffusion, l'expéditeur, etc.
    La personnalisation de la diffusion est présentée dans cette section .
Codes segment  : définissez le code segment en fonction des variables d'événements.
This action can be performed from any activity that lets you define a segment code like, for example, Query or Segmentation activities.
Libellé de la diffusion  : définissez le libellé de la diffusion en fonction des variables d'événements.

Utilisation :

Le cas pratique ci-dessous vous présente comment appeler un workflow avec des paramètres au sein de vos workflows.
L'objectif est de déclencher un workflow à partir d'un appel API avec des paramètres externes. Ce workflow chargera des données dans votre base de données à partir d'un fichier et créera une audience associée. Une fois l'audience créée, un deuxième workflow sera déclenché pour envoyer un message personnalisé avec les paramètres externes définis dans l'appel API.
Pour mettre en place ce cas pratique, vous devez réaliser les actions ci-dessous :
  1. Effectuez un appel API pour déclencher le workflow 1 avec des paramètres externes. Voir Etape 1 : configurer l'appel API .
  2. Créez le workflow 1  : le workflow transférera un fichier et le chargera dans la base de données. Il effectuera ensuite un test pour déterminer si les données sont vides et finira par enregistrer les profils dans une audience. Enfin, il déclenchera le workflow 2. Voir Etape 2 : configurer le workflow 1 .
  3. Créez le workflow 2  : le workflow lira l'audience créée dans le workflow 1, puis il enverra un message personnalisé aux profils, avec un code segment personnalisé au moyen des paramètres. Voir Etape 3 : configurer le workflow 2 .

Prérequis

Before configuring the workflows, you need to create Workflow 1 and 2 with an External signal activity in each of them. Ce faisant, vous pourrez cibler ces activités Signal lors de l'appel des workflows.

Etape 1 : configurer l'appel API

Effectuez un appel API pour déclencher le workflow 1 avec des paramètres. Pour plus d'informations sur la syntaxe de l'appel API, consultez la documentation des API REST Campaign Standard .
Dans notre cas, nous souhaitons appeler le workflow avec les paramètres ci-dessous :
  • fileToTarget  : nom du fichier que nous voulons importer dans la base de données.
  • discountDesc  : description que nous voulons afficher dans la diffusion pour la remise.
-X POST https://mc.adobe.io/<ORGANIZATION>/campaign/<TRIGGER_URL>
-H 'Authorization: Bearer <ACCESS_TOKEN>' 
-H 'Cache-Control: no-cache' 
-H 'X-Api-Key: <API_KEY>' 
-H 'Content-Type: application/json;charset=utf-8' 
-H 'Content-Length:79' 
-i
-d {
-d "source:":"API",
-d "parameters":{
-d "fileToTarget":"profile.txt",
-d "discountDesc":"Running shoes"
-d } 

Etape 2 : configurer le workflow 1

Le workflow 1 sera créé tel que ci-dessous :
  • External signal : où les paramètres externes doivent être déclarés pour être utilisés dans le flux de travaux.
  • Transfer file : importe le fichier avec le nom défini dans les paramètres.
  • Load file : charge les données du fichier importé dans la base de données.
  • Update data : insérez ou mettez à jour la base de données avec les données du fichier importé.
  • Test Activité  :  : vérifie si des données sont importées.
  • Save audience : si le fichier contient des données, enregistre le dans un de.
  • End activity : appelle Workflow 2 avec les paramètres que vous souhaitez utiliser.
Suivez les étapes ci-dessous pour configurer le workflow :
  1. Déclarez les paramètres qui ont été définis dans l'appel API. To do this, open the External signal activity, then add the parameters' names and types.
  2. Add a Transfer file activity to import data into the database.To do this, drag and drop the activity, open it, then select the Protocol tab.
  3. Sélectionnez l’ Use a dynamic file path option, puis utilisez le paramètre fileToTarget comme fichier à transférer :
    $(vars/@fileToTarget)
    
    
  4. Chargez les données du fichier dans la base de données.
    To do this, drag and drop a Load file activity into the workflow, then configure it according to your needs.
  5. Insérez les données du fichier importé dans la base de données ou mettez-la à jour avec ces données.
    To do this, drag and drop an Update data activity, then select the Identification tab to add a reconciliation criteria (in our case the email field).
  6. Select the Fields to update tab, then specify the fields to update in the database (in our case the firstname and email fields).
  7. Vérifiez si des données sont récupérées à partir du fichier. To do this, drag and drop a Test activity into the workflow, then click the Add an element button to add a condition.
  8. Nommez et définissez la condition. Dans notre cas, nous voulons tester si la transition sortante contient des données avec la syntaxe ci-dessous :
    $long(vars/@recCount)>0
    
    
  9. Si des données sont récupérées, enregistrez-les dans une audience. To do this, add a Save audience activity to the Target not empty transition, then open it.
  10. Select the Use a dynamic label option, then use the fileToTarget parameter as the label of the audience:
    $(vars/@fileToTarget)
    
    
  11. Drag and drop an End activity that will call Workflow 2 with parameters, then open it.
  12. Select the External signal tab, then specify the workflow to trigger and its associated signal activity.
  13. Définissez les paramètres que vous voulez utiliser au sein du workflow 2 ainsi que leurs valeurs associées.
    Dans notre cas, nous souhaitons transmettre les paramètres initialement définis dans l'appel API ( fileToTarget et discountDesc ), de même qu'un paramètre segmentCode supplémentaire avec une valeur constante ("remise de 20 %").
Le workflow 1 est configuré, et vous pouvez maintenant créer le workflow 2. Voir à ce propos cette section .

Etape 3 : configurer le workflow 2

Le workflow 2 sera créé tel que ci-dessous :
  • External signal : où les paramètres doivent être déclarés pour être utilisés dans le flux de travaux.
  • Read audience : lit le enregistré dans le flux de travail 1.
  • Email delivery : envoie un message récurrent au ciblé , personnalisé avec des paramètres.
Suivez les étapes ci-dessous pour configurer le workflow :
  1. Déclarez les paramètres qui ont été définis dans le workflow 1.
    To do this, open the External signal activity, then add the name and type of each parameter defined in the End activity of Workflow 1.
  2. Utilisez l'audience qui a été enregistrée dans le workflow 1. To do this, drag and drop a Read audience activity into the workflow, then open it.
  3. Select the Use a dynamic audience option, then use the fileToTarget parameter as the name of the audience to read:
    $(vars/@fileToTarget)
    
    
  4. Nommez la transition sortante selon le paramètre segmentCode .
    Pour ce faire, sélectionnez l’ Transition onglet, puis l’ Use a dynamic segment code option.
  5. Utilisez le paramètre segmentCode comme nom de la transition sortante :
    $(vars/@segmentCode)
    
    
  6. Drag and drop an Email delivery activity to send a message to the audience.
  7. Identifiez les paramètres à utiliser dans le message afin de le personnaliser avec le paramètre discountDesc . Pour cela, ouvrez les options avancées de l'activité, puis ajoutez le nom et la valeur du paramètre.
  8. Vous pouvez à présent configurer le message. Ouvrez le , puis sélectionnez Recurring email .
  9. Sélectionnez le modèle à utiliser, puis définissez les propriétés d'email selon vos besoins.
  10. Utilisez le paramètre discountDesc en tant que champ de personnalisation. Pour ce faire, sélectionnez-le dans la liste des champs de personnalisation.
  11. Vous pouvez maintenant terminer la configuration du message et l'envoyer ensuite de manière habituelle.

Exécuter les workflows

Une fois les workflows créés, vous pouvez les exécuter. Assurez-vous que les deux workflows sont démarrés avant d'effectuer l'appel API.