Créer une maquette X ML

Préambule

Ce qui est décrit ci-dessous concerne les versions antérieures à 4 de Kentika qui propose de nouveaux outils

Le paramétrage d’une maquette doit être choisie en fonction d’un contexte et permet de stocker un format d’édition ou d’impression en vue d’une utilisation régulière.

Cependant, dans certains cas (impression ponctuelle d’une liste de documents par exemple) il n’est pas toujours nécessaire de stocker votre maquette et vous pouvez la créer directement depuis l’explorateur plutôt que de la définir dans le menu des préférences.

Les explications ci-dessous permettent de vous donner les base de paramétrage d’une maquette XML définie dans les préférences.

Avant de paramétrer le contenu de votre maquette, il est nécessaire de lui affecter une table et une destination.

Introduction

Les maquettes XML sont uniquement dédiées à l'export et permettent d'exporter des données au format XML (eXtensible Markup Language).

Le langage XML

XML est une recommandation du W3C (World Wide Web Consortium) destinée à faciliter les échanges de données par l’utilisation d’un langage structuré et normalisé.

Le fichier d’export obtenu est donc exploitable par tout autre logiciel disposant d’un parser XML.

Eléments XML

Dans un fichier XML, chaque valeur est encadrée par deux balises : une balise ouvrante et une balise fermante, qui identifient la nature de l’information fournie. Une balise ouvrante se compose du signe < suivi d’une étiquette puis du signe >

Une balise fermante se compose des signes </ suivis d’une étiquette puis du signe >

L’étiquette est le libellé que vous affectez à chaque information traitée, c’est-à-dire à chaque champ que vous souhaitez exporter. Cette étiquette est entièrement libre.

Exemple : la cote d’un document est DRT-0001. Si l’étiquette affectée au champ Cote est "cote", elle

est exportée sous la forme :<cote>DRT-0001</cote>

Chaque champ exporté correspond à un élément XML.

Arborescence

Un document XML a une structure arborescente. Ainsi, un élément peut être contenu dans un autre.

Exemple : l’élément "cote" et l’élément "titre" sont inclus dans l’élément "document" :

<document>

<titre>Titre du document 1</titre>

<cote>Cote du document 1</cote>

</document>

<document>

<titre>Titre du document 2</titre>

<cote>Cote du document 2</cote>

</document>

Composition des fichiers XML

Les règles suivantes sont suivies pour toutes les maquettes XML :

Prologue

Tout fichier XML commence par un prologue qui définit la version de la norme XML utilisée, ainsi que le jeu d’encodage de caractères.

Le prologue d’un fichier d’export généré est :

<?xml version="1.0" encoding="UTF-8" ?>

Déclaration de DTD

Une déclaration de DTD est une référence à un fichier contenant la DTD associée au fichier XML. Elle suit le prologue.

Aucune déclaration de DTD n’est présente dans le fichier d’export.

Elément racine

Tout document XML comporte obligatoirement un élément racine. Il s’agit d’une élément unique (non répété), qui contient tous les autres.

L’élément racine d’un fichier d’export XML généré est Export_XML.

L’ensemble des fiches exportées est donc placé entre une balise <Export_XML> et </Export_XML>.

L’élément racine permet ainsi de délimiter le début et la fin de la liste.

Elément principal

Outre l’élément racine, le fichier d’export contient toujours au moins un élément, qui est répété pour chaque fiche exportée. Cet élément correspond au nom de la table d'appartenance de la fiche exportée. Chaque fiche est donc délimitée par des balises.

Exemple : <document> et </document> pour des fiches documents.

Lors de la composition de la maquette, vous choisissez les éléments que doit contenir cet élément principal, c’est à dire quelles sont les champs que vous souhaitez exporter.

 

Les maquettes crées sont disponibles dans l'explorateur à partir du bouton export (cf. boutons de l'exporateur).

Description de la maquette XML

Une fois que vous avez affecté la destination de votre maquette, vous disposez d’un outil qui vous permet de paramétrer cette maquette :

Fenêtre d'édition d'une maquette XML

Insertion d'un script

1 La zone "Script par enregistrement principal" permet de saisir des instructions qui s'exécutent pour chaque enregistrement. Le remplissage de cette zone est facultatif.

Affichage

2 Cette zone contient les rubriques qui seront affichées lors de l'export.

Par défaut, le libellé affiché est le nom de la rubrique. Pour modifier le libellé d'une rubrique, sélectionnez-là et modifiez son contenu dans le champ de saisie en bas à gauche de la maquette.​

Rubriques

3 Le bouton Champ permet d'accéder aux propriétés de la rubrique sélectionnée.

Il permet de d'éditer une rubrique une fois que celle-ci a été insérée dans la maquette.

Il est également possible de sélectionner une autre rubrique que celle sélectionnée.

​

La modification d'une rubrique existante peut également s'effectuer en cliquant deux fois sur la ligne sélectionnée.

​

Créer un fichier XML par programmation

Dans certains cas de figure, la maquette ne donnera pas le résultat souhaité.

Si vous souhaitez élaborer une mise en forme plus précise des balises xml, vous pouvez créer un fichier xml directement par programmation.