Utilisation de Microsoft Azure Cosmos DB avec IBM App Connect Enterprise

Microsoft Azure Cosmos DB est un service de base de données multimodèle distribué à l'échelle mondiale proposé par Microsoft, conçu pour offrir une haute disponibilité, une évolutivité et un accès aux données à faible latence pour les applications modernes.

Les étapes suivantes vous expliquent comment vous connecter à un compte Microsoft Azure Cosmos DB et configurer un nœud de requête Microsoft Azure Cosmos DB à l'aide de la fonctionnalité de découverte des connecteurs.

1. Dans la boîte à outils d' IBM App Connect Enterprise, créez un flux contenant un nœud « Microsoft Azure Cosmos DB Request ».
2. Sélectionnez le nœud « Microsoft Azure Cosmos DB Request » dans le flux pour afficher les propriétés du nœud dans l'éditeur.
3. Dans l'onglet Base, cliquez sur Lancer la découverte du connecteur.
   Un panneau s'affiche, dans lequel vous indiquez le nom du projet de stratégie et les détails du coffre-fort à utiliser lors de la découverte des connecteurs.
4. Spécifiez les détails du projet de politique et de l'espace de stockage à utiliser lors de la découverte des connecteurs :
   1. Dans le champ Projet de stratégie, indiquez le projet de stratégie utilisé pour stocker les stratégies créées lors de la découverte des connecteurs.
      Vous pouvez également créer un nouveau projet de politique en cliquant sur Nouveau, puis en spécifiant le nom du nouveau projet de politique. Cliquez ensuite sur Terminer.
   2. Spécifiez le coffre-fort à utiliser lors de la découverte des connecteurs. Par défaut, les informations d'identification utilisées lors de la découverte du connecteur sont stockées dans un coffre-fort de répertoire externe, qui est un coffre-fort App Connect Enterprise pouvant être utilisé par n'importe quel serveur d'intégration. Vous pouvez également stocker les informations d'identification dans un coffre-fort de serveur d'intégration, qui est créé dans le répertoire de travail du serveur d'intégration et ne peut être utilisé que par ce serveur d'intégration spécifique.
      Pour spécifier le coffre-fort à utiliser pour stocker les informations d'identification, suivez les étapes de la section Utilisation de l'assistant de découverte de connecteur de l 'une des rubriques suivantes :

      • Configuration d'un coffre-fort de répertoire externe
      • Configuration d'une chambre forte de serveur d'intégration
   3. Dans le champ Clé du coffre-fort, entrez la clé du coffre-fort utilisée pour accéder aux informations d'identification stockées dans le coffre-fort. La clé de voûte doit comporter au moins 8 caractères.
   4. Facultatif : Par défaut, l'emplacement et la clé du coffre-fort spécifiés sont enregistrés en tant que préférences dans la boîte à outils afin que les valeurs soient prédéfinies lorsque vous lancez Connector Discovery. Si vous ne souhaitez pas que les préférences soient enregistrées, désélectionnez l'option Enregistrer dans les préférences de l'espace de stockage.
5. Cliquez sur « Lancer la détection » pour démarrer l'assistant de détection du connecteur « Microsoft Azure Cosmos DB ».
   La fenêtre de découverte du connecteur s'affiche. Si des connexions (comptes) existantes à Microsoft Azure Cosmos DB sont disponibles, une liste de ces connexions s'affiche. S'il n'y a aucune connexion existante, l'état du connecteur Microsoft Azure Cosmos DB s'affiche comme Not connectedsuit :.
   • Si une ou plusieurs connexions (comptes) Microsoft Azure Cosmos DB sont disponibles, procédez comme suit :
     1. Sélectionnez la connexion (compte) que vous souhaitez utiliser en cliquant dessus.
     2. Cliquez sur le type d'objet requis, puis sélectionnez l'action à effectuer sur l'objet. Par exemple, pour récupérer des éléments à partir de Microsoft AzureCosmos DB, cliquez sur « Éléments », puis sur « Récupérer les éléments ».
   • S'il n'y a pas de connexions existantes (comptes), effectuez les étapes suivantes :
     1. Cliquez sur le type d'objet requis, puis sélectionnez l'action à effectuer sur cet objet. Par exemple, pour récupérer des éléments à partir de Microsoft AzureCosmos DB, cliquez sur « Éléments », puis sur « Récupérer les éléments ».
     2. Cliquez sur Connexion.
        Une fenêtre s'affiche dans laquelle vous devez saisir les informations de connexion de votre compte Microsoft Azure Cosmos DB. Saisissez les informations suivantes dans l'assistant de connexion :

        • URL du serveur : indiquez l'URI créé pour le compte de base de données dans le service Microsoft Azure Cosmos DB.
        • Clé : Indiquez la clé en lecture-écriture ou en lecture seule permettant d'accéder au compte de base de données dans le service Microsoft Azure Cosmos DB.
        • Nom du proxy : sélectionnez ou indiquez le nom du proxy que vous souhaitez qu' App Connect utilise pour acheminer les appels du connecteur. Ce champ n'est obligatoire que si les appels doivent passer par un proxy. Lorsque vous utilisez la boîte à outils « IBM App Connect Enterprise », le nom du proxy doit être indiqué sous la forme suivante : {PolicyProjectName}:HTTPProxyPolicyName
     3. Cliquez sur Connexion.

     Pour plus d'informations sur l'identification de ces informations de connexion, consultez la section « Comment utiliser IBM® App Connect avec Microsoft Azure Cosmos DB » dans la documentation sur la livraison continue (CD) de IBM App Connect in containers.

6. Définissez les propriétés requises du connecteur dans l'assistant.
   Vous pouvez également définir des propriétés qui précisent le nombre maximal d'enregistrements à extraire et l'action à entreprendre si cette limite est dépassée.
7. Lorsque vous avez fini de spécifier les propriétés dans l'assistant de découverte de connecteur, cliquez sur Enregistrer.
   Les informations d'identification utilisées pour se connecter à Microsoft Azure Cosmos DB sont stockées dans le coffre-fort, tandis que les autres détails de connexion sont enregistrés dans la stratégie Microsoft Azure Cosmos DB. Les valeurs des propriétés que vous définissez dans l'assistant sont renvoyées au nœud de requête « Microsoft Azure Cosmos DB » dans le Toolkit IBM App Connect Enterprise.
8. Lorsque vous avez terminé la découverte et enregistré les valeurs des propriétés, quittez l'assistant de découverte de connecteur en cliquant sur le X dans le coin supérieur droit de la fenêtre ou en appuyant sur Alt+F4.
9. Revenir à la modification du Cosmos DBMicrosoft Azure Demande nœud dans le IBM App Connect Enterprise Boîte à outils.
   Les propriétés du connecteur définies dans l'assistant de détection des connecteurs (à l'étape 6 ) sont désormais visibles dans le nœud « Microsoft Azure Cosmos DB Request » de l'éditeur de propriétés. L'onglet Basique affiche les valeurs des propriétés Action et Objet que vous avez définies dans l'assistant. Par exemple, si vous avez sélectionné Éléments > Récupérer les éléments dans l'assistant, les propriétés suivantes s'affichent dans l'onglet « De base » du nœud :

   • Action - getItems
   • Objet - getItems_model

   Les valeurs des propriétés Action et Objet sont affichées en lecture seule. Si vous souhaitez modifier ces valeurs, vous pouvez le faire en cliquant à nouveau sur Lancer la découverte du connecteur et en définissant de nouvelles valeurs dans l'assistant de découverte du connecteur.

   La propriété « Schema base name » spécifie le nom de base des fichiers de schéma qui décrivent le format des messages de requête et de réponse envoyés et reçus par le connecteur Microsoft Azure Cosmos DB. Le nom de base du schéma est défini automatiquement la première fois que vous exécutez la recherche pour le nœud, et il est basé sur le nom du flux et le nom du nœud actuels. Si vous définissez cette propriété manuellement avant de lancer la découverte pour la première fois, c'est la valeur que vous avez définie qui est utilisée. Si vous renommez les schémas après la découverte, vous devez modifier cette propriété afin qu'elle corresponde au nom de base du schéma utilisé par les schémas renommés dans le projet. Si vous modifiez cette propriété après la recherche, vous devez soit renommer les noms des schémas pour qu'ils correspondent, soit relancer la recherche.

   En fonction de l'action sélectionnée lors de la découverte, l'assistant de découverte de connecteur génère soit un schéma de demande et un schéma de réponse, soit un schéma de réponse uniquement. Un schéma de demande n'est généré que si l'action et l'objet sélectionnés nécessitent un message de demande. Le schéma de demande généré est utilisé pour la validation du message de demande. Si l'action était RETRIEVE ou DELETE, seul le schéma de réponse est renvoyé par le connecteur.

   Les fichiers de schéma générés sont ajoutés au projet et peuvent être utilisés par un nœud de mise en correspondance pour transformer les données d'entrée ou de sortie. Le nom de fichier complet du schéma est dérivé du nom de base du schéma (tel que gen/microsoftazurecosmosdb.Microsoft_Azure_Cosmos_DB_Request), suffixé par response.schema.json ou request.schema.json. Vous pouvez ouvrir le schéma en cliquant sur Ouvrir le schéma de demande ou Ouvrir le schéma de réponse.

10. Vérifiez que les paramètres de propriété du nœud de requête « Microsoft Azure Cosmos DB » sont corrects, puis enregistrez le flux de messages.
11. Dans l'onglet Connexion du nœud Requête Microsoft Azure Cosmos DB, la propriété Stratégie affiche le nom de la stratégie contenant les détails de l'identité de sécurité à utiliser pour la connexion. La police a un type de Microsoft Azure Cosmos DB.
    Pour plus d'informations, consultez la page Microsoft AzureCosmos DB policy.
12. Facultatif : définissez la propriété « Timeout » dans l'onglet « Connection » pour spécifier le délai (en secondes) pendant lequel le nœud attend que Microsoft Azure Cosmos DB traite l'opération.
13. L'onglet « Filter » du nœud « Request » de l' Microsoft Azure Cosmos DB contient des propriétés qui déterminent la manière dont le flux de messages sélectionne les données. Les valeurs initiales de ces propriétés sont reprises des valeurs définies pour le connecteur « Microsoft Azure Cosmos DB » dans l'assistant de détection des connecteurs, y compris les propriétés des options de filtrage et toutes les conditions spécifiées (comme décrit à l'étape 6 ). Ensuite, si vous revenez à l'assistant de découverte de connecteur et que vous modifiez les valeurs des propriétés (en ajoutant de nouvelles conditions, par exemple), ces mises à jour se reflètent dans les propriétés définies pour le nœud.

    Les propriétés « Options de filtrage » déterminent les objets sur lesquels l'opération doit porter lors de l'exécution du nœud « Microsoft Azure Cosmos DB Request ». Les propriétés Limite du filtre contrôlent le nombre maximum d'éléments à extraire et l'action à entreprendre si la limite est dépassée.

    Vous pouvez modifier les valeurs en cliquant sur Modifier à côté de la valeur que vous souhaitez modifier dans la section Options du filtre, et en changeant les valeurs des propriétés qui ont été définies dans la section Limite du filtre.

    Les valeurs des propriétés peuvent être soit des valeurs textuelles, soit des expressions ESQL ou XPATH qui sont résolues à partir du contenu du message transmis au nœud de requête « Microsoft Azure Cosmos DB » lors de son exécution.

14. Dans l'onglet « Request », définissez la propriété « Data location » afin de spécifier l'emplacement, dans l'arborescence des messages entrants, qui contient les données de l'objet à créer dans Microsoft Azure Cosmos DB. Ces données constituent la requête envoyée depuis le nœud de requête Microsoft Azure Cosmos DB vers le système Microsoft Azure Cosmos DB.
15. Dans l'onglet Résultat, définissez la propriété Emplacement des données de sortie afin de spécifier l'emplacement dans l'arborescence des messages de sortie où seront placées les données de l'enregistrement créé dans Microsoft Azure Cosmos DB.
16. Par défaut, les messages de demande sont validés par rapport au schéma de demande généré lors de la découverte du connecteur. Vous pouvez désactiver la validation des requêtes ou modifier les paramètres de validation à l'aide des propriétés de validation du nœud Request de l' Microsoft Azure Cosmos DB.
17. Sauvegarder le flux de messages.