Méthodes de connecteurs KeyValuePair

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 6 minutes de lecture

    • Les méthodes de connecteur de paires de valeurs clés effectuent diverses actions sur les paires clé-valeur. Dans un flux d’automatisation, les méthodes sont connectées à d’autres méthodes et composants. Pour utiliser les méthodes, vous devez d’abord les exposer.

    Ajouter

    Ajoute une paire de valeurs clés.

    Pour fournir des entrées dans les paramètres, reportez-vous à la section Configurer les propriétés des ports.

    Tableau 1. Ajouter des paramètres de méthode
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Clé Nom de la clé. Données dans Chaîne Aucun Oui
    Valeur Valeur de la clé. Données dans Objet Aucun Oui
    Ignorer les doublons Si la valeur est True, la méthode ignore une clé en double. Sinon, si la valeur est False, la méthode renvoie un message d’erreur. Données dans Booléen Aucun Non

    Effacer

    Efface toutes les paires clé-valeur.

    ContainsKey

    Renvoie la valeur Vrai si la clé spécifiée existe, sinon renvoie la valeur Faux.

    Pour fournir des entrées dans les paramètres, reportez-vous à la section Configurer les propriétés des ports.

    Tableau 2. Paramètres de la méthode ContainsKey
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Clé Nom de la clé. Données dans Chaîne Aucun Oui
    Retour Renvoie la valeur Vrai si la clé spécifiée existe, sinon renvoie la valeur Faux. Sortie de données Booléen Non applicable Non applicable

    Contient la valeur

    Renvoie la valeur Vrai si la valeur de clé spécifiée existe, sinon, renvoie la valeur Faux.

    Pour fournir des entrées dans les paramètres, reportez-vous à la section Configurer les propriétés des ports.

    Tableau 3. Paramètres de méthode ContainsValue
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Valeur Nom de la valeur de clé. Données dans Chaîne Aucun Oui
    Retour Renvoie la valeur Vrai si la valeur de clé spécifiée existe, sinon, renvoie la valeur Faux. Sortie de données Booléen Non applicable Non applicable

    Nombre

    Renvoie le nombre total de paires clé-valeur.

    Tableau 4. Paramètres de la méthode de comptage
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Retour Renvoie le nombre total de paires clé-valeur. Sortie de données Entier Non applicable Non applicable

    Supprimer

    Supprime la clé spécifiée.

    Pour fournir des entrées dans les paramètres, reportez-vous à la section Configurer les propriétés des ports.

    Tableau 5. Supprimer les paramètres de la méthode
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Clé Nom de la clé. Données dans Chaîne Aucun Oui

    Obtenir un élément

    Renvoie la valeur de la clé spécifiée.

    Pour fournir des entrées dans les paramètres, reportez-vous à la section Configurer les propriétés des ports.

    Tableau 6. Paramètres de méthode GetItem
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Clé Nom de la clé. Données dans Chaîne Aucun Oui
    Retour Renvoie la valeur de la clé. Sortie de données Objet Non applicable Non applicable

    Obtenir des éléments

    Renvoie les valeurs de plusieurs clés. Vous devez d’abord configurer les clés dans la méthode.

    Pour le configurer, procédez comme suit.
    1. Cliquez sur l’icône des paramètres de méthode (icône des paramètres de méthode).
    2. Cliquez sur l’icône Ajouter des clés (icône Ajouter des clés).
    3. Entrez le nom de la clé.
    4. Mettez à jour le type de données clé à partir de la liste.
    5. Répétez les étapes pour définir plusieurs noms de clés.
    6. Cliquez sur OK.

      Un port de sortie de données est créé avec chaque nom de clé que vous définissez.

    Tableau 7. Paramètres de méthode GetItems
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Clé Renvoie la valeur de la clé. Sortie de données Objet Non applicable Non applicable

    Obtenir des éléments par index

    Renvoie les valeurs de clé en fonction de leur index. Vous devez d’abord configurer les index dans la méthode.

    Pour le configurer, procédez comme suit.
    1. Cliquez sur l’icône des paramètres de méthode (icône des paramètres de méthode).
    2. Cliquez sur l’icône Ajouter des index (icône Ajouter des clés).
    3. Saisissez l’index de clé.
    4. Mettez à jour le type de données clé à partir de la liste.
    5. Répétez les étapes pour définir plusieurs index de clé.
    6. Cliquez sur OK.

      Un port de sortie de données est créé avec chaque index de clé que vous définissez.

    Tableau 8. Paramètres de méthode GetItemsByIndex
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Index de clé Renvoie la valeur de la clé. Sortie de données Objet Non applicable Non applicable

    ParseFromText

    Analyse le texte spécifié en paires de valeurs clés. Il peut créer plusieurs paires clé-valeur.

    Pour fournir des entrées dans les paramètres, reportez-vous à la section Configurer les propriétés des ports.

    Tableau 9. Paramètres de la méthode ParseFromText
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Texte Texte comprenant les clés et les valeurs que la méthode analyse. Données dans Chaîne Aucun Oui
    Séparateur d’élément Séparateur entre deux paires clé-valeur. Données dans Chaîne Aucun Oui
    KeyValueSeparator (Séparateur clé-valeur) Séparateur entre la clé et sa valeur. Données dans Chaîne Aucun Oui
    Effacer avant d’analyser Si la valeur est Vrai, efface toute paire de valeurs clés existante avant l’analyse. Données dans Booléen Aucun Non

    Inverser

    Inverse les index clés.
    Conseil :
    Après l’exécution de la méthode, vous pouvez voir la sortie en exécutant la méthode GetItemsByIndex.

    SetData (en anglais seulement)

    Besoin d’informations.

    Définir l’élément

    Met à jour la valeur d’une clé.

    Pour fournir des entrées dans les paramètres, reportez-vous à la section Configurer les propriétés des ports.

    Tableau 10. Paramètres de méthode SetItem
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Clé Nom de la clé. Données dans Chaîne Aucun Oui
    Valeur Valeur mise à jour de la clé. Données dans Objet Aucun Oui
    Conseil :
    Testez la valeur mise à jour en exécutant la méthode GetItemsByIndex.

    Éléments définis

    Met à jour les valeurs des clés spécifiées. Vous devez d’abord configurer les clés dans la méthode.

    Pour configurer les clés, procédez comme suit.
    1. Cliquez sur l’icône des paramètres de méthode (icône des paramètres de méthode).
    2. Cliquez sur l’icône Ajouter des clés (icône Ajouter des clés).
    3. Entrez le nom de la clé.
    4. Mettez à jour le type de données clé à partir de la liste.
    5. Répétez les étapes pour définir plusieurs noms de clés.
    6. Cliquez sur OK.

      Un port d’entrée de données est créé avec chaque nom de clé que vous définissez.

    Pour fournir des entrées dans les paramètres, reportez-vous à la section Configurer les propriétés des ports.

    Tableau 11. Paramètres de méthode SetItems
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Clé Valeur mise à jour de la clé. Données dans Objet Aucun Oui
    Conseil :
    Testez la valeur mise à jour en exécutant la méthode GetItemsByIndex.

    Définir les éléments par index

    Met à jour les valeurs des clés en fonction des index spécifiés. Vous devez d’abord configurer les index dans la méthode.

    Pour configurer les index, procédez comme suit.
    1. Cliquez sur l’icône des paramètres de méthode (icône des paramètres de méthode).
    2. Cliquez sur l’icône Ajouter des index (icône Ajouter des clés).
    3. Saisissez l’index de clé.
    4. Mettez à jour le type de données clé à partir de la liste.
    5. Répétez les étapes pour définir plusieurs index de clé.
    6. Cliquez sur OK.

      Un port d’entrée de données est créé avec chaque index de clé que vous définissez.

    Tableau 12. Paramètres de la méthode SetItemsByIndex
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Index clé Index de la clé. Données dans Objet Aucun Oui
    Conseil :
    Testez la valeur mise à jour en exécutant la méthode GetItemsByIndex.

    ToJSON

    Affiche les paires de valeurs clés au format JSON.

    ToText (Texte de destination)

    Affiche les paires clé-valeur au format texte.

    Pour fournir des entrées dans les paramètres, reportez-vous à la section Configurer les propriétés des ports.

    Tableau 13. Paramètres de la méthode ToText
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Valeurs uniquement Si la valeur est Vrai, la méthode affiche uniquement les valeurs des clés, sinon la paire de valeurs clés est rendue. Données dans Booléen Aucun Non
    Retour Renvoie la paire keyvalue au format texte. Sortie de données Chaîne Non applicable Non applicable