Recherche

Base de connaissances d’InterAction® Administrator

Aperçu de l'édition des fichiers XML

  • Mise à jour

Pour comprendre les fichiers de déclaration utilisés par le serveur d'application InterAction et le Web Client, vous devez comprendre les bases du langage de balisage extensible (XML).

XML est un langage de balisage similaire à HTML. La principale différence est que XML est plus structuré et extensible – un document XML peut utiliser un ensemble personnalisé de balises de balisage.

Cette section couvre les sujets suivants :

Ce guide fournit un aperçu très bref des fichiers XML dans le but de personnaliser le Web Client. Pour un aperçu plus complet de XML, consultez d'autres ressources, suggérées dans Plus de Ressources XML.

Déclaration XML

La première ligne d'un document XML est toujours la déclaration XML :

<?xml version="1.0" standalone="yes"?>

Cela fournit des informations sur la version XML et si le document utilise une définition de type de document (DTD). Les fichiers XML que vous devez éditer pour le serveur d'application sont considérés comme des documents autonomes – cela signifie qu'il n'y a pas de DTD correspondant pour ces fichiers.

Éléments et Balises

XML est similaire à HTML en ce qu'il est composé d'éléments. Un élément peut baliser du texte, ou il peut simplement fournir des informations utilisées par le serveur d'application. Par exemple, un élément “menuItemDeclarations” balise du texte pour être défini comme éléments de menu.

Vous spécifiez des éléments dans un document XML en les plaçant dans des balises. Une balise est encadrée par des signes inférieur à (<) et supérieur à (>) et contient le nom de l'élément, comme suit :

<profileDeclarations>

Ceci est un exemple de balise ouvrante pour l'élément. Toutes les balises ouvrantes doivent être fermées par une balise fermante. Une balise fermante est identique à la balise ouvrante, sauf qu'elle a une barre oblique (/) avant le nom de l'élément :

</profileDeclarations>

Tout ce qui se trouve entre les balises ouvrantes et fermantes est considéré comme faisant partie de l'élément. L'élément peut contenir du texte, d'autres balises XML, ou il peut être vide.

Un élément peut avoir des exigences spécifiques quant à ce qui peut être contenu entre les balises ouvrantes et fermantes. Par exemple, un élément peut n'autoriser que des informations textuelles. Un autre élément peut n'autoriser que d'autres éléments.

Contrairement à HTML, chaque balise ouvrante doit avoir une balise fermante correspondante. S'il n'y a pas de texte ou d'autres balises entre les balises ouvrantes et fermantes, vous pouvez les condenser en une seule en plaçant la barre oblique avant le signe supérieur fermant. Par exemple, notez la différence ci-dessous.

Éléments XML Vides

<formControl type="label">

<controlLabel>Nom :</controlLabel>

</formControl>

Cet élément contient d'autres éléments.

Notez les balises sèparées ouvrantes et fermantes (<formControl> et </formControl>) qui entourent l'information.

<field id="2/-10401">

</field>

Cet élément ne contient aucun texte ou autre élément – il n'y a rien entre les balises <field> et </field>.

Par conséquent, les balises ouvrantes et fermantes peuvent être condensées en une seule balise.

<field id="2/-10401" />

Les balises XML peuvent être imbriquées les unes dans les autres. Les balises imbriquées doivent être ouvertes et fermées au même niveau.

Les éléments disponibles pour la configuration du Web Client dépendent du type de fichier XML que vous éditez. Pour une référence aux éléments utilisés pour le Web Client, voir les sections suivantes :

Attributs et Valeurs

Un élément peut également avoir des attributs. Un attribut fournit des informations supplémentaires sur l'élément.

Vous spécifiez des attributs dans la balise de début d'un élément, selon la syntaxe nom_attribut = "valeur". Par exemple, l'élément field a les deux attributs suivants :

  • label défini sur la valeur “Clients”
  • labelClass défini sur la valeur “headline”

Les valeurs des attributs doivent être encadrées par des guillemets simples ou doubles. Peu importe lesquels vous utilisez.

Les attributs et valeurs autorisés pour un élément particulier dépendent de l'élément. Pour une référence aux attributs autorisés par les éléments utilisés pour le Web Client, voir les sections suivantes :

Commentaires

Un fichier XML peut contenir des commentaires. Ceux-ci sont ignorés lors du traitement du fichier. Les commentaires sont utiles pour inclure des notes sur la signification des différentes balises.

Les commentaires utilisent la même syntaxe que HTML – tout texte entre <!-- et --> est un commentaire, par exemple :

<!-- Ceci est un commentaire -->

Les commentaires ne peuvent pas être inclus dans une balise. De plus, un commentaire ne peut pas contenir de doubles tirets (--).

Les fichiers XML installés avec le serveur d'application InterAction incluent des commentaires.

Rendre un Document XML Bien Formé

Un fichier XML est considéré comme bien formé s'il respecte un certain ensemble de règles. Ces règles incluent les suivantes :

  • Le fichier commence par la déclaration XML.
  • Toutes les valeurs d'attributs sont entourées de guillemets. Il peut s'agir de guillemets simples ou doubles.
  • Toutes les balises d'ouverture d'élément ont des balises de fermeture correspondantes.
  • Toutes les balises d'élément sont correctement imbriquées.

Pour plus d'informations sur les fichiers XML bien formés, consultez l'une des ressources XML listées dans Plus de ressources XML.

Un fichier XML est considéré comme valide si le fichier est à la fois bien formé et conforme à une définition de type de document (DTD). Une DTD est un ensemble de règles qui définissent la structure autorisée pour un document XML. Les fichiers XML que vous devez modifier pour le serveur d'applications InterAction sont considérés comme des documents autonomes – cela signifie qu'il n'y a pas de DTD correspondante pour ces fichiers.

Le serveur d'applications ne peut traiter que des fichiers XML bien formés. Utiliser un éditeur XML est un bon moyen de s'assurer que vos documents sont bien formés.

Utilisation d'un éditeur XML

Bien que vous puissiez modifier les fichiers XML du serveur d'applications InterAction avec un éditeur de texte, il est fortement recommandé d'utiliser un éditeur XML validant. En effet, le serveur d'applications ne peut traiter que des fichiers XML bien formés. Un éditeur XML validant peut confirmer que le fichier est bien formé avant que vous n'enregistriez les modifications. L'éditeur devrait également inclure des fonctionnalités pour vous aider à trouver des erreurs telles que des balises qui n'ont pas été correctement fermées.

Certains éditeurs XML utilisent également différentes couleurs pour les balises, ce qui peut vous aider à trouver les informations à modifier lors du changement du document.

Consultez la documentation de votre éditeur XML pour des détails sur son utilisation et sur la validation des documents XML.

Il existe plusieurs éditeurs XML gratuits, shareware et commerciaux disponibles.

"Cet article d'aide a été traduit à l'aide de l'IA et peut contenir des inexactitudes. Si vous avez des doutes sur une information, veuillez vous référer à la version originale en anglais."