Guide de flux de travail du connecteur de service Web pour un exemple d’API REST

Cet article traite du déploiement d’un exemple d’API REST pour parcourir l’outil de configuration de service Web avec une source de données Web d’API REST.

Prérequis

Les conditions préalables suivantes sont requises pour utiliser l’exemple :

  • L’outil de configuration de service Web est installé.
  • L’exemple de service de source de données REST est déployé. Téléchargez et installez l’exemple à partir de (voir ici).

Notes

Les données JSON doivent contenir un seul objet avec une propriété qui contient un tableau.

{

"EmployeeList":[

{"id":"1","employee_name":"Albano","employee_salary":"22213","employee_age":"37","profile_image":""},{"id":"2","employee_name":"Albano","employee_salary":"22213","employee_age":"37","profile_image":""}

]

}

Configurer la découverte de projets REST dans l’outil de configuration de service Web

Les étapes suivantes vous montrent comment créer un projet pour votre source de données dans l’outil de configuration de service Web.

  1. Ouvrez l’outil de configuration du service Web. Il ouvre un projet SOAP vide.

    Outil de configuration de service Web

  2. sélectionnez fichiernouveauREST Project.

    Créer un nouveau projet REST

  3. sur la gauche, sélectionnez REST Project , puis sélectionnez ajouter.

    Sélectionner le projet REST

  4. Sur la page suivante, renseignez les informations suivantes :

    • Nouveau nom du service Web
    • Address (chemin de l’URL de l’API REST)
    • Espace de noms
    • Mode de sécurité (type d’authentification)

    Service REST

    L’écran suivant montre des exemples pour ces valeurs :

    Exemples de valeurs pour le service REST

    Définissez le mode de sécurité sur aucun. Définissez l' adresse sur l’exemple de serveur JSON hébergé dans Azure.

  5. Sélectionnez OK. Projet REST listé dans l’outil de configuration des services Web.

    Projet REST dans l’outil de configuration des services Web

  6. l’étape suivante consiste à définir l’appel de l’API REST et à traduire l’appel en appels Windows Communication Foundation (WCF).

    1. développez le Project REST et sélectionnez le service RESTSAMPLE .

    2. Sélectionnez Ajouter. Vous êtes invité à ajouter deux valeurs :

      Entrer des valeurs pour le service REST

      1. Entrez le nom. Cette étape est étiquetée 3 dans la capture d’écran.
      2. Entrez l' adresse. Cette étape porte le libellé 4 dans la capture d’écran.
      3. Sélectionnez OK. Une ressource REST est ajoutée à la description du service RESTSAMPLE .
  7. Dans la zone ressources , sélectionnez la ressource REST que vous venez d’ajouter. Ajoutez la méthode suivante :

    Ajouter une méthode REST à la ressource

  8. Sélectionnez la méthode REST. Notez qu’il est possible de créer plusieurs méthodes dans la même ressource et de définir les requêtes transmises pendant l’exécution.

  9. Pour la méthode GETALL, aucune requête n’est requise. Laissez les valeurs de paramètres vides. Lors de l’exportation ou de l’importation de l’API REST, vous devez définir l’exemple de réponse demande/réponse en fonction de la fonction. Copiez et collez le retour JSON lors de la navigation vers cet exemple.

  10. Sélectionnez Enregistrer. Enregistrez le projet dans C:\Program Files\Microsoft Forefront Identity Manager\2010\Synchronization Service\Extensions .

Notes

Une fois le projet enregistré, le fichier WsConfig est généré. Le fichier de configuration contient plusieurs fichiers qui sont définis précédemment dans la vue d’ensemble du service Web.

Configurer des types d’objet dans l’outil de configuration de service Web

Les étapes suivantes vous montrent comment configurer des types d’objet pour votre source de données dans l’outil de configuration de service Web.

  1. L’étape suivante consiste à définir le schéma d’espace de connecteur. Pour ce faire, vous devez créer le type d’objet et définir leurs types d’objets. Dans le volet gauche, cliquez sur types d’objets , puis cliquez sur le bouton Ajouter . Cette opération s’ouvre en dessous de l’écran. Ajoutez un nouveau type d’objet et fournissez un nom. Cliquez sur le bouton OK .

  2. L’ajout d’un type d’objet fournit un écran ci-dessous.

  3. Le volet droit correspondant au type d’objet vous permet de conserver les attributs et leurs propriétés pour le type d’objet sélectionné. Cliquez sur le bouton Ajouter pour ajouter des attributs à l’écran ci-dessous.

  4. L’écran ci-dessous s’affiche après l’ajout de tous les attributs requis.

  5. les attributs et le type d’objet une fois créés, fournissent des flux de travail vides qui répondent aux opérations effectuées dans Microsoft Identity Manager (MIM).

Configurer des flux de travail dans l’outil de configuration de service Web

L’étape suivante consiste à configurer les flux de travail pour votre type d’objet. Les fichiers de flux de travail sont une série d’activités utilisées par le connecteur de services Web au moment de l’exécution. les flux de travail sont utilisés pour implémenter l’opération de MIM appropriée. L’outil de configuration de service Web vous aide à créer quatre workflows différents :

  • Importation : importez des données à partir d’une source de données pour les deux types de flux de travail suivants :

    • Importation complète : importation complète qui peut être configurée.
    • Importation différentielle : non prise en charge par l’outil de configuration de service Web.
  • exportation : exportez des données à partir de MIM vers une source de données connectée. Les trois actions suivantes sont prises en charge pour l’opération. Vous pouvez configurer ces actions en fonction de vos besoins.

    • Ajouter
    • Supprimer
    • Replace
  • Mot de passe : effectuer la gestion des mots de passe pour l’utilisateur (type d’objet). Deux actions sont disponibles pour cette opération :

    • Définition du mot de passe
    • Modifier le mot de passe
  • Tester la connexion : configurez un flux de travail pour vérifier si la connexion avec le serveur de source de données a été établie.

Notes

Vous pouvez configurer ces flux de travail pour votre projet ou télécharger le projet par défaut à partir du Centre de téléchargement Microsoft.

Concepteur de flux de travail

Le Concepteur de flux de travail ouvre la zone de travail pour configurer le flux de travail conformément à la spécification. Pour chaque type d’objet (New/existing), l’outil de configuration fournit les nœuds pour les flux de travail pris en charge par l’outil.

Concepteur de flux de travail

La Concepteur de flux de travail est composée des éléments d’interface utilisateur suivants :

  • Nœuds dans le volet gauche: ils vous aident à sélectionner le flux de travail à utiliser pour la conception.

  • Concepteur de flux de travail centrale: vous pouvez ici supprimer les activités de configuration des flux de travail. pour effectuer diverses opérations de MIM (exportation, importation, gestion des mots de passe), vous pouvez utiliser les activités de flux de travail standard et personnalisées de .net workflow Framework 4. L’outil de configuration de service Web utilise des activités de flux de travail standard et personnalisées. Pour plus d’informations sur les activités standard, consultez utilisation des concepteurs d’activités.

    • Dans le Concepteur de flux de travail central, un cercle rouge avec un point d’exclamation à côté d’une activité indique que l’opération a été supprimée et qu’elle n’est pas définie correctement et complètement. Pointez sur le cercle rouge pour trouver l’erreur exacte. Une fois l’activité définie correctement, le cercle rouge passe à la marque d’information jaune.

    • Dans le Concepteur de flux de travail central, une marque d’information de triangle jaune en regard de toute activité indique que l’activité est définie, mais il existe d’autres opérations que vous pouvez effectuer pour terminer l’activité. Pointez sur le triangle jaune pour afficher plus d’informations.

  • Boîte à outils: empaquette tous les outils, y compris les activités système et personnalisées, ainsi que des instructions prédéfinies pour concevoir le flux de travail. Pour plus d'informations, consultez Boîte à outils.

  • Sections de la boîte à outils: la boîte à outils contient les sections et les catégories suivantes :

    • Description: l’en-tête de la boîte à outils. Un onglet accède à la boîte à outils et aux propriétés de l’activité de workflow sélectionnée.

    • Importer un flux de travail: activités personnalisées pour configurer des flux de travail d’importation.

    • Exporter le flux de travail: activités personnalisées pour configurer des flux de travail d’exportation.

    • Commun: activités personnalisées pour configurer un flux de travail.

    • Débogage: activités de flux de travail système pour le débogage défini dans Workflow 4. Ces activités permettent le suivi des problèmes pour un flux de travail.

    • Instructions: activités de flux de travail système définies dans le workflow 4. Pour plus d’informations, consultez utilisation des concepteurs d’activités.

  • Propriétés: l’onglet Propriétés affiche les propriétés d’une activité de workflow particulière qui est supprimée dans la zone du concepteur et sélectionnée. La figure à gauche montre les propriétés de l’activité Assign . Pour chaque activité, les propriétés diffèrent et sont utilisées lors de la configuration du flux de travail personnalisé. Cet onglet vous permet de définir les attributs de l’outil sélectionné qui a été déposé dans le concepteur de flux de travail central. Pour plus d'informations, consultez Propriétés.

  • Barre des tâches : La barre des tâches comprend trois éléments : variables, argumentset importations. Ces éléments sont utilisés avec les activités de flux de travail. pour plus d’informations, consultez la page présentation d’Windows Workflow Foundation (WF) du développeur dans .net 4.

Configurer un flux de travail d’importation complet dans l’outil de configuration de service Web

Les étapes suivantes montrent comment configurer des flux de travail d’importation complets pour l’API REST à l’aide de l’outil de configuration de service Web.

Avertissement

Cet exemple crée uniquement un flux de travail. Les modifications apportées au flux de travail, telles que l’utilisation d’une logique personnalisée dans l’API, peuvent être nécessaires.

  1. Sélectionnez le flux de travail d’importation complet à configurer. Les arguments et les importations sont déjà définis et sont spécifiques aux activités. Pour plus d’informations, consultez les écrans suivants.

    Arguments du flux de travail d’importation complète

    Espaces de noms importés

    Après la reconfiguration des appels, vous devez modifier les noms des attributs qui changent ou ajouter l’espace de noms aux variables qui font référence à la structure de retour de l’API et les types d’objets qui font référence à l’ancien espace de noms. La boîte à outils dans le volet droit contient toutes les activités personnalisées spécifiques au flux de travail dont vous avez besoin pour la configuration. Affectez les valeurs aux variables que vous allez utiliser pour votre logique. Accédez à la section inférieure du concepteur de flux de travail central et déclarez les variables. Les variables sont déclarées à l’étape suivante.

  2. Ajoutez une activité Sequence. faites glisser le concepteur d’activités Sequence de la boîte à outils et déposez-le sur la surface de Concepteur de flux de travail Windows. Reportez-vous aux écrans suivants. L’activité Sequence contient une collection ordonnée d’activités enfants qu’elle exécute dans l’ordre.

    Activité de séquence

  3. Pour ajouter une variable, recherchez créer une variable. Tapez wsResponse pour le nom, sélectionnez la liste déroulante type de variable , puis sélectionnez Parcourir les types. Une boîte de dialogue s’affiche. Sélectionnez la réponse de GetAllgénérée . Conservez la sélection de l' étendue et des valeurs par défaut . Vous pouvez également définir ces valeurs à l’aide de la vue Propriétés .

    Réponse par défaut

  4. Faites glisser un autre concepteur d’activités Sequence de la boîte à outils au sein de l’activité Sequence déjà ajoutée.

  5. Faites glisser un WebServiceCallActivity présenté sous Common. Cette activité est utilisée pour appeler l’opération de service Web disponible après la découverte. Il s’agit d’une activité personnalisée qui est courante dans différents scénarios d’opération.

    Opération de nom de service

    Pour utiliser l’opération de service Web, définissez les propriétés suivantes :

    • Nom du service: entrez un nom pour le service Web.

    • Nom du point de terminaison: spécifiez un nom de point de terminaison pour le service sélectionné.

    • Nomde l’opération : spécifiez l’opération correspondante pour le service.

    • Argument: sélectionnez arguments. Dans la boîte de dialogue suivante, assignez les valeurs d’argument, comme illustré dans la figure suivante :

      Affecter des arguments

      Important

      Ne modifiez pas le nom, la directionou le type d’un argument à l’aide de cette boîte de dialogue. Si l’une de ces valeurs est modifiée, l’activité devient non valide. Définissez uniquement la valeur de l’argument. Comme illustré dans cette figure, la valeur wsResponse est définie.

  6. Ajoutez une activité foreach juste en dessous de WebServiceCallActivity. Cette activité est utilisée pour effectuer une itération sur tous les attributs (ancres et non-ancres) du type d’objet. Tout en faisant glisser cette activité dans la surface de Concepteur de flux de travail, elle énumère automatiquement tous les noms d’attribut de votre objet. Définissez les valeurs requises en fonction de l’écran suivant :

    Activité d’appel du service Web

  7. Dans certains cas, vous devrez peut-être ouvrir le generated.dll qui se trouve dans le fichier WsConfig. Copiez ce fichier WsConfig et renommez-le avec l’extension .zip. Ouvrez et extrayez le generated.dll à l’aide de votre outil .NET Reflector préféré.

    Fichier de configuration

  8. Identifiez l’espace de noms public pour ListeEmployés:

    Code de liste des employés

    Ensuite, ajoutez ce retour au flux de travail foreach:

    Ajouter une liste d’employés au flux de travail ForEach

  9. Faites glisser une activité CreateCSEntryChangeScope dans le corps foreach . Cette activité est utilisée pour créer une instance de l’objet CSEntryChange dans le domaine de workflow pour chaque enregistrement respectif lors de la récupération des données à partir de la source de données cible. Si vous faites glisser cette activité, l’écran ci-dessous s’affiche. Les activités CreateAnchorAttribute sont héritées automatiquement. Mettez à jour la valeur DN avec le nom de domaine de votre choix.

    Créer une activité d’étendue de modification d’entrée CS

    Notes

    Les valeurs d’ancrage et les noms d’objets varient en fonction du service Web exposé. L’illustration montre un exemple.

  10. Faites glisser une activité CreateAttributeChange sous l’activité CreateAnchorAttribute . Le nombre d’activités à faire glisser est égal au nombre d’attributs sans ancrage. Consultez la figure suivante pour référence.

    Créer un point d’ancrage

    Notes

    Pour utiliser cette activité, choisissez et assignez les champs correspondants à partir de la liste déroulante et assignez les valeurs. Pour les attributs à valeurs multiples, supprimez plusieurs activités CreateValueChangeActivity dans une activité CreateAttributeChangeActivity .

  11. Enregistrez ce projet à l’emplacement %FIM_INSTALL_FOLDER%\Synchronization Service\Extensions . Configurez ensuite l’agent de gestion comme décrit dans Configuration de l’agent de gestion du service Web.

    Enregistrer le projet REST

    Les projets par défaut doivent être téléchargés et enregistrés à l’emplacement %FIM_INSTALL_DIR\2010\Synchronization Service\Extensions sur le système cible. Les projets sont ensuite visibles dans l’Assistant connecteur de service Web.

    Lorsque vous exécutez le fichier exécutable, vous êtes invité à spécifier l’emplacement de l’installation. Entrez l’emplacement d’enregistrement.

    Important

    Le fichier projet peut être enregistré et ouvert à partir de n’importe quel emplacement (avec les privilèges d’accès appropriés de son exécuteur). seuls les fichiers projet enregistrés dans le Synchronization Service\Extension dossier peuvent être sélectionnés dans l’assistant connecteur de Service Web accessible via l’interface utilisateur de synchronisation MIM.

    L’utilisateur qui exécute l’outil de configuration de service Web requiert les privilèges suivants :

    • Contrôle total du dossier d’extension du service de synchronisation.
    • Accès en lecture à la clé de Registre HKLM\System\CurrentControlSet\Services\FIMSynchronizationService\Parameters via laquelle se trouve le chemin d’accès au dossier d’extension.

Étapes suivantes