Utilisation de l'activité Sage CRM Demander objets

Utilisez l'activité Demander objets pour exécuter, à partir de Sage CRM, une requête SData sur un type d'objet spécifié.

Pourquoi et quand exécuter cette tâche

Cette tâche permet d'exécuter une requête SData sur un type d'objet spécifié dans l'instance Sage CRM. L'appel de cette activité est un appel synchrone lorsque les données entrées sont envoyées à l'activité pour traitement et que la réponse est renvoyée à l'orchestration.

Procédure

  1. Cliquez avec le bouton droit sur la section Orchestrations et sélectionnez une nouvelle orchestration.
  2. Faites glisser le nouveau noeud final Sage CRM vers l'orchestration et sélectionnez l'activité Demander objets.
  3. L'activité Demander objets s'ajoute à l'orchestration. Sélectionnez l'activité. La liste de contrôle de l'activité Sage CRM Demander objets s'affiche.
  4. Dans la liste de contrôle, cliquez sur Configurer.
  5. Entrez les paramètres de requête valides en indiquant ‘?’ pour la valeur. Pour configure plusieurs paramètres de requête, séparez chaque paramètre de requête à l'aide d'un ‘&’. Voici quelques exemples de requête :
    select=?&where=?
    startIndex=?&count=?
    orderBy=?
    select=?&where=?orderBy=?
      where=Lead_UpdatedDate lt @2016-01-10@

    Il est à noter que la chaîne de requête ne doit pas commencer par un ‘?’.

  6. Cliquez sur Parcourir pour sélectionner le type d'objet. La fenêtre Parcourir Sage CRM s'affiche.
  7. Dans la fenêtre Parcourir Sage CRM, vous pouvez sélectionner le type d'objet dans la liste des types d'objet. Cliquez sur OK.
  8. Sélectionnez Mapper les entrées dans la Liste de contrôle. Les schémas XML générés à partir de l'objet sélectionné de l'activité Demander objets s'affichent sous forme de noeuds sous le paramètre d'entrée de demande dans le panneau Vers l'activité.
  9. Dans la Liste de contrôle, sélectionnez Réessayer. Passez en revue les paramètres par défaut et procédez aux modifications requises.
  10. Créez une mappe entre les variables d'orchestration et le paramètre d'entrée de l'activité.
    Remarque : Des valeurs doivent être fournies lors de l'exécution pour les éléments obligatoires de la structure d'entrée. Une valeur peut être indiquée en spécifiant une valeur par défaut pour l'élément ou en reliant l'élément avec un noeud d'entrée. A l'exécution, si aucune valeur n'est fournie pour un élément obligatoire, l'activité émet une exception qui est signalée par la console de gestion Web. Si aucune valeur n'est fournie au moment de l'exécution pour un paramètre d'entrée facultatif, aucune exception n'est émise lors de l'exécution.
  11. Sélectionnez Mapper les sorties dans la Liste de contrôle. Le schéma XML généré pour contenir la réponse de l'activité s'affiche sous forme de noeuds sous le paramètre de sortie de réponse dans le panneau Depuis l'activité.
  12. Créez une mappe entre les paramètres de sortie et les variables d'orchestration.

    Paramètre de requête :

    Tableau 1. Paramètres de requête communs pour l'activité Demander objets
    Nom de zone Description
    startIndex Index de début de l'enregistrement à partir duquel le résultat de l'appel d'API doit commencer.
    count Nombre d'objets à afficher dans la réponse.
    where Spécifie un critère de filtrage. Seules les ressources correspondant aux critères spécifiés dans le paramètre where sont renvoyées.
    orderBy Spécifie un critère de tri. La collection est triée par ordre croissant ou décroissant des noms d'attribut spécifiés dans ce paramètre.
    select Sélectionne les propriétés qui seront renvoyées dans la charge. Ce paramètre permet à un client de demander qu'une liste spécifique de propriétés soit renvoyée dans la charge. Il offre un contrôle précis sur l'étendue et l'importance des informations renvoyées.

    Au moins un des paramètres de requête ci-dessus doit comporter une valeur mappée/par défaut pour que l'activité soit exécutée correctement.

Résultats

Vous venez de configurer l'activité Sage CRM Demander objets.
Remarque :

Cette activité porte sur l'extraction de plusieurs enregistrements d'un type donné. A ce titre, la réponse en entrée est unique, ce qui est applicable à une seule API d'extraction globale permettant d'extraire plusieurs objets.