Extraction de valeurs de propriété à partir de fichiers externes

Vous pouvez indiquer qu'une propriété doit recevoir une valeur d'un fichier XML ou JSON via HTTP. Ensuite, lorsque vous exécutez le processus, le serveur vous propose une liste de valeurs issues de ce fichier.

Avant de commencer

Sur un serveur accessible depuis IBM® UrbanCode Deploy, hébergez un fichier XML ou JSON contenant les valeurs de la propriété. Vous pouvez mettre en forme ce fichier de différentes manières. Vous devez également identifier le chemin d'accès des valeurs via trois paramètres. Des exemples de ces paramètres de chemin sont inclus avec les échantillons de fichiers.
La mise en forme la plus simple du fichier consiste à fournir une simple liste de valeurs pour la propriété, comme dans les exemples suivants :
<company>
  <employee>Alice</employee>
  <employee>Bob</employee>
  <employee>Chris</employee>
<company>
Pour les fichiers XML, utilisez XPath pour définir le chemin d'accès des valeurs. Dans le fichier XML précédent, le paramètre Chemin de base est l'expression XPath //company/employee et les paramètres Chemin de la valeur et Chemin du libellé sont vides.
L'exemple suivant illustre le fichier équivalent dans JSON :
{
  company: {
    employee: [
      "Alice",
      "Bob",
      "Chris"
    ]
  }
}
Dans le fichier JSON précédent, le paramètre Chemin de base est company.employee et les paramètres Chemin de la valeur et Chemin du libellé sont vides.
Vous pouvez inclure des informations de libellé et de valeur séparées dans le fichier. Par exemple, le fichier XML suivant inclut des noms et des numéros d'ID.
<company>
  <employee>
    <name>Alice</name>
    <id>1</id>
  </employee>
  <employee>
    <name>Bob</name>
    <id>2</id>
  </employee>
  <employee>
    <name>Chris</name>
    <id>3</id>
  </employee>
</company>
Dans ce cas, le paramètre Chemin de base est l'expression XPath //company/employee. Le paramètre Chemin de la valeur est une expression XPath qui indique le chemin relatif de la valeur par rapport au chemin des base ; dans ce cas, l'expression est ./id. A l'instar, le paramètre Chemin du libellé est une expression XPath qui indique le chemin relatif du libellé par rapport au chemin de base ; dans ce cas, l'expression est ./name.
Le fichier JSON suivant est équivalent au fichier XML précédent :
{
  company: {
    employees: [
      { name: "Alice", employee.id: 1 },
      { name: "Bob", employee.id: 2 },
      { name: "Chris", employee.id: 3}
    ]
  }
} 
Dans ce cas, le paramètre Chemin de base est l'expression XPath companycompany/employee. Le paramètre Chemin de la valeur est employee\.id et le paramètre Chemin du libellé est name.
Remarque : Lorsque vous spécifiez le chemin d'un fichier JSON, accompagnez les points dans les noms d'attributs par le caractère d'échappement \ (barre oblique inversée), comme dans le paramètre Chemin de la valeur de l'exemple précédent.
Lorsque vous utilisez des attributs dans un fichier XML, utilisez le caractère @ pour spécifier un attribut dans l'expression XPath. Par exemple, le fichier XML suivant comporte des valeurs dans les attributs :
<company>
  <employee id="1">Alice</employee>
  <employee id="2">Bob</employee>
  <employee id="3">Chris</employee>
<company>
Dans ce cas, le paramètre Chemin de base est l'expression XPath //company/employee. Le paramètre Chemin de la valeur est ./@id et le paramètre Chemin du libellé Label est un point (.).

Pourquoi et quand exécuter cette tâche

Vous pouvez utiliser ces valeurs de propriété distante dans les définitions de propriété, telles que les propriétés d'environnement du composant, mais pas dans les propriétés générales, telles que les propriétés système, les propriétés d'application, ou les propriétés de composant.

Procédure

  1. Créez une définition de propriété. Par exemple, cliquez sur un composant, accédez à l'onglet Configuration, cliquez sur Définitions des propriétés d'environnement, puis sur Ajouter une propriété.
  2. Renseignez les zones Nom, Description, Libellé, Pattern et Requis comme à l'accoutumée.
  3. Dans la liste Type, sélectionnez HTTP Select pour une valeur de propriété unique ou HTTP Multi Select pour autoriser plusieurs valeurs de propriété. Plusieurs nouvelles zones apparaissent.
  4. Renseignez les zones suivantes. Ces zones sont spécifiques aux paramètres de fichiers externes.
    URL
    Spécifiez l'URL du fichier XML ou JSON externe.
    Nom d'utilisateur
    Si l'URL requiert un nom d'utilisateur, indiquez-le ici.
    Mot de passe
    Si l'URL requiert un mot de passe, indiquez-le ici.
    Format de données
    Indiquez le type de fichier : JSON ou XML.
    Chemin de base
    Pour les fichiers XML, spécifiez une expression XPath pour les données. Pour les fichiers JSON, spécifiez le chemin via les attributs JSON aux données, en séparant les chemins par des points (.). Reportez-vous aux exemples en haut de cette page.
    Chemin de la valeur
    Indiquez le chemin relatif des valeurs de paramètre par rapport au paramètre Chemin de base.
    Chemin du libellé
    Indiquez le chemin relatif des libellés de paramètre par rapport au paramètre Chemin de base.
    Valeur par défaut
    Spécifiez la valeur par défaut du paramètre.
  5. Cliquez sur Sauvegarder.

Résultats

Maintenant, lorsque vous exécutez le processus, la fenêtre Exécuter le processus inclut un paramètre qui extrait des valeurs depuis un fichier externe.

Vos commentaires