Configuration des actions externes

Les actions externes permettent aux parcours de compte dans Journey Optimizer B2B edition de se connecter à des systèmes externes directement à partir de la zone de travail de parcours. Lorsqu’une audience de compte atteint un nœud d’action externe, le système effectue un appel sortant asynchrone vers un service externe configuré, en transmettant les données d’attribut d’audience pour les comptes, les personnes ou les deux. Le service externe traite les données et répond à l’aide d’un rappel , renvoyant les données et métadonnées de l’audience qui peuvent être utilisées pour guider l’exécution du parcours.

Cette fonctionnalité prend en charge deux types de nœuds de parcours :

  • Action externe - Appelle un service externe et continue le long d’un seul chemin sortant. Idéal pour les intégrations à déclenchement et à oubli telles que la mise à jour d’un enregistrement CRM ou le déclenchement d’une notification en aval.
  • Chemins de partage externes - Appelle un service externe et évalue la réponse pour acheminer les comptes le long de l’un des chemins définis.
NOTE
Les services d’action externe sont pris en charge uniquement pour les parcours de compte. Ces types de nœuds ne sont pas disponibles pour les parcours de personnes.

Présentation de l’implémentation

La configuration des actions externes nécessite une coordination entre trois rôles successifs :

Implémenter le service externe implement-service

Le développeur doit créer et publier un service web public conforme à l’interface du fournisseur de services d’actions externes de Adobe Journey Optimizer B2B edition 🔗.

NOTE
La fonction de rappel nécessite un jeton porteur. Récupérez-le en configurant les informations d’identification de serveur à serveur OAuth) dans Adobe Developer Console pour votre organisation IMS.

Une fois le service actif, fournissez l’URL de la spécification OpenAPI et les informations d’authentification à l’administrateur de produit chargé de configurer l’action.

Configurer l’action configure-action

Une action doit être configurée et activée avant que les marketeurs puissent l’utiliser dans un parcours. Les actions sont créées à l’état Brouillon et vos modifications sont enregistrées automatiquement. Il reste en tant que brouillon jusqu’à ce que vous l’activiez.

PREREQUISITES
Obtenez l’URL vers la spécification OpenAPI et les informations d’authentification du développeur avant d’ajouter la configuration.
Pour définir et activer une action externe, vous devez disposer de l’autorisation Gérer les configurations d’administration B2B produit.
  1. Accédez à Administration > Configurations.

  2. Cliquez sur Actions externes dans le panneau intermédiaire.

    Accéder à l'espace de configuration des Actions externes {width="800" modal="regular"}

  3. Cliquez sur Créer une action en haut à droite.

  4. Saisissez l’URL de la spécification OpenAPI pour votre service externe et cliquez sur Créer.

    Saisir l’URL du service {width="500"}

    Le service externe doit être actif et accessible pour que cette étape réussisse. En cas d’erreur de validation, la boîte de dialogue affiche un message pour décrire l’erreur et une suggestion pour la résoudre. Pour plus d’informations, voir Dépannage.

  5. Une fois l’URL résolue, passez en revue les Détails du service.

    Les détails du service sont lus directement à partir de la spécification OpenAPI lors de la création de l’action. Vous ne pouvez pas modifier ces propriétés dans la configuration après leur création.

    table 0-row-3 1-row-3 2-row-3 3-row-3
    Propriété Description Propriété de spécification OpenAPI
    Nom Nom de l’action info.title
    Description Description de l’action info.description
    URL URL vers la spécification OpenAPI qui définit le service externe servers.url
  6. Saisissez les informations d’identification Authentification pour le service externe (components.securitySchemes).

    note
    NOTE
    Les champs d’identification affichés dépendent du mécanisme d’authentification défini dans le service externe. Les types pris en charge sont les suivants : clé API, OAuth2 et authentification de base HTTP.

    Ajoutez les informations d’authentification {width="600" modal="regular"}

    Vous pouvez modifier les informations d’identification selon vos besoins lorsque l’action configurée a le statut Brouillon ou Actif.

  7. Cliquez sur Suivant.

  8. Définissez les propriétés Configurations pour définir la manière dont l’action échange des données avec le service externe.

    note
    NOTE
    Les propriétés marquées comme Statiques ne peuvent pas être mises à jour au moment de la configuration et sont basées sur la définition de service.
    • Type d’action (statique) - Le type de nœud de parcours pris en charge :

      • Action externe (enableSplitPath = false)
      • Chemin de partage de l’action externe (enableSplitPath = true)

      Vous ne pouvez pas modifier le type d’action après avoir créé la configuration d’action.

    • Accessoires (Statique) - (Chemin de division d’action externe uniquement) Les variables renvoyées par le service externe pour être disponibles en tant que conditions de chemin dans un nœud de chemin de division externe. (invocationPayloadDef.accessorsMetadata)

    • Contexte du Parcours (Statique) - Portée des données d’audience envoyées dans la requête (supportedEntityType) :

      • Compte - Envoie uniquement les comptes

      • Personnes - Envoie uniquement des personnes

      • Personnes sur le compte - Envoie les comptes et les personnes associées au compte

    • Champs sortants - Mappez chaque champ de la table à un champ XDM. Ces champs sont envoyés au service externe dans le corps de la requête. Propriétés de définition de service : invocationPayloadDef.accountFields, invocationPayloadDef.fields.

      Mapper les champs sortants d’action externe {width="600" modal="regular"}

    • Champs entrants - Mappez chaque champ de la table à un champ XDM modifiable. Ces champs sont renseignés à partir de la réponse du service externe. Propriétés de définition de service : callbackPayloadDef.accountFields, callbackPayloadDef.fields. Modifiable après la création.

    • Paramètres d’en-tête - Saisissez une valeur pour chaque ligne à transmettre en tant qu’en-tête HTTP dans la requête. Propriété de définition du service : invocationPayloadDef.headers.

    • Délai d’expiration - Saisissez le nombre de minutes à attendre pour que le service externe appelle le rappel avant que la demande ne soit considérée comme ayant échoué. Propriété de définition du service : timeout.

    • Attributs globaux - Saisissez une valeur pour chaque ligne à inclure en tant que champ statique dans le corps de la requête. Propriété de définition du service : invocationPayloadDef.globalAttributes.

      Paramètres d’en-tête d’action externe, délai d’expiration et attributs globaux {width="600" modal="regular"}

  9. Cliquez sur la flèche Précédent pour revenir à la liste et conserver l’action à l’état Brouillon.

    Ou cliquez sur Activer pour définir la configuration de l’action sur l’état Actif. L’action externe configurée doit être active pour pouvoir être utilisée dans les parcours de compte.

Dépannage troubleshooting

Lorsque vous saisissez l’URL de la spécification OpenAPI pour votre service externe et cliquez sur Créer, le système effectue la validation du service. Lorsqu’elle rencontre une erreur, la boîte de dialogue affiche un message pour décrire l’erreur.

​ Message d’erreur de validation du service d’URL d’action externe ​ {width="600" modal="regular"}

NOTE
La plupart des erreurs suivantes nécessitent que vous collaboriez avec le développeur ou la développeuse qui a créé et publié le service web public pour les résoudre.

Détails de l’erreur de validation

Erreur affichée
Pourquoi cela s’est produit
Que faire
This URL is already used by another external action
Cette URL de spécification est déjà enregistrée dans une autre action de votre organisation.
Utilisez une autre URL de spécification ou supprimez l’action existante qui l’utilise déjà.
An action with this name already exists
La info.title de votre spécification correspond à une action qui existe déjà
Remplacez le titre du champ info.title de votre spécification par quelque chose d’unique.
Duplicate operation ID found in the specification
Plusieurs opérations de votre spécification partagent la même operationId.
Attribuez un operationId unique à chaque opération.
Field in the specification exceeds the maximum allowed length
Un champ de texte de votre spécification (tel qu’un titre ou une description) est trop long.
Raccourcissez le champ marqué.
The entity type value is invalid
Une extension x- spécifique à Adobe pour le type d’entité a une valeur non reconnue
Corrigez le type d’entité sur une valeur prise en charge. Consultez la documentation pour les développeurs pour connaître les options valides.
The provided document is not a valid OpenAPI specification
La spécification ne peut pas être analysée structurellement.
Validez votre spécification par rapport au schéma OpenAPI 3.0 et corrigez les problèmes.
Required OpenAPI field is missing
Il n’y a pas de champ obligatoire OpenAPI standard (info ou paths, par exemple).
Ajoutez le champ manquant.
Required endpoint is missing from the specification
Un point d’entrée requis par Adobe Journey Optimizer B2B edition n’est pas défini dans votre spécification.
Ajoutez le point d’entrée requis. Pour connaître les points d’entrée nécessaires🔗 consultez la documentation pour les développeurs et développeuses .
Required extension field is missing
Un champ d’extension Adobe x- obligatoire est absent de votre spécification.
Ajoutez le champ d’extension manquant comme décrit dans la documentation.
Security schemes are missing from the specification
Aucune spécification n’a securitySchemes définie sous components.
Définissez au moins un schéma de sécurité.
Multiple authentication types are not supported
Votre spécification définit plusieurs schémas d’authentification.
Mettez à jour votre spécification pour utiliser un seul type d’authentification.
The authentication type is not supported
Le type de schéma de sécurité que vous avez utilisé (oauth2 ou openIdConnect, par exemple) n’est pas pris en charge.
Basculez vers un type d’authentification pris en charge. Consultez la documentation destinée aux développeurs pour connaître les options prises en charge.
The OpenAPI version is not supported
Incompatibilité de version au niveau de la spécification
Mettez à jour votre spécification pour utiliser OpenAPI 3.0.x.
An unexpected error occurred
Un problème non classé a été détecté dans votre spécification.
Vérifiez votre spécification pour tout élément inhabituel et réessayez. Si l’erreur persiste, contactez l’assistance.

Ajouter un nœud externe à un parcours add-journey-node

Une fois qu’une action est activée, les spécialistes marketing peuvent ajouter un nœud Action externe ou Chemin de partage externe à n’importe quel parcours de compte. Pour plus d’informations sur l’ajout et l’utilisation de ces nœuds dans la zone de travail du parcours de compte, voir Nœuds externes.

recommendation-more-help
journey-optimizer-b2b-help-user