7.6 Exportation de documents en Xml

Les documents, hormis les familles, peuvent être exportés en XML. Les fichiers XML produits suivent un schéma de famille imposé par dynacase. Chaque famille de document a son propre schéma XML. L'exportation Xml d'un contenu de dossier ou de recherche peut se faire de deux façons : en générant un fichier par document ou dans un seul fichier xml.

Si vous voulez utiliser le fichier Xml pour une exportation vers un autre contexte, il faut absolument indiquer l'option "sans les identificateurs" , sinon les documents importés sont incohérents et peuvent corrompre le contexte.

Les fichiers produits par l'exportation Xml sont conformes au format d'importation XML.

7.6.1 Archive avec un fichier Xml par document

Dans ce cas une archive (zip) est constituée avec un fichier par document. Chaque fichier est nommé à l'aide du titre et de l'identifiant du document (par exemple : alligator {4567}.xml. Chaque fichier fait référence à un schéma xml issus de la famille. Ce schéma est aussi présent dans l'archive.

7.6.2 Un fichier Xml seul

Dans ce cas, la sortie est un seul fichier xml contenant l'ensemble des documents. La balise racine est dans ce cas documents. La balise documents porte la date de génération et l'auteur.

<documents date="2010-06-07T12:46:45"
author="Default Master"
name="recherche_animal">
    <zoo_animal .> </zoo_animal>
    <zoo_animal .> </zoo_animal>
</documents>

Avec cette option les schémas Xml des familles ne sont pas exportés.

7.6.3 Format du XML de document

Les attributs non structurant sont insérés dans les attributs de structure (tab, frame, array).

<my_tab><!-- Onglet -->
    <my_frame><!-- Cadre -->
        <my_array><!-- Tableau : rangée par rangée -->
            <my_attr_col1>Rangée 1 Colonne 1</my_attr_col1>
            <my_attr_col2>Rangée 1 Colonne 2</my_attr_col2>
        </my_array>
        <my_array>
            <my_attr_col1>Rangée 2 Colonne 1</my_attr_col1>
            <my_attr_col2>Rangée 2 Colonne 2</my_attr_col2>
        </my_array>
 
         <my_attribute1>Valeur</my_attribute1>
         <my_attribute2>Valeur</my_attribute2>
    </my_frame>
</my_tab>

Les valeurs brutes des attributs non structurant sont contenus dans le contenu de la balise.

7.6.3.1 Attributs spécifiques

Les attributs de type "docid" et "file" ont des attributs supplémentaires.

7.6.3.1.1 Attribut XML docid, account, thésaurus

  • id : Identifiant numérique de la relation
  • name : Nom logique de la relation
  • revision : 3.2.21 Contient le numéro de la révision si l'option "docrev=fixed". Contient "state:<état>" si l'option est "docrev=state(<état>)".

7.6.3.1.2 Attribut XML file, image

  • vid: Identifiant du fichier dans le coffre
  • mime : Type mime du fichier
  • href : Url de download du fichier
  • title : Nom du fichier

Le contenu de la balise est le fichier encodé si l'option "Avec les fichiers" a été sélectionnée.

7.6.4 Exemple d'un document exporté

<zoo_animal xsi:noNamespaceSchemaLocation="zoo_animal.xsd" id="3296" name=""
    title="Alli Alligator" revision="0" modification-date="2010-06-02T13:53:33"
    version="" state="">
    <an_tab1>
        <an_identification>
            <an_nom>Alli</an_nom>
            <an_descr xsi:nil="true"/>
            <an_tatouage xsi:nil="true"/>
            <an_espece_title>Alligator</an_espece_title>
            <an_espece id="1127">Alligator</an_espece>
            <an_ordre>Crocodiliens</an_ordre>
            <an_classe id="1123" name="Reptilia">Reptilia</an_classe>
            <an_sexe>M</an_sexe>
            <an_photo xsi:nil="true"/>
            <an_photo vid="27" mime="image/png" href="http://localhost:8080/dev/file/3296/743/an_photo/-1/Gator.png?cache=no&amp;inline=no" title="alligator.png"/>
            <an_naissance>2010-05-12</an_naissance>
            <an_entree>2010-05-18</an_entree>
            <an_pere id="1289">Viel Ali Alligator</an_pere>
        </an_identification>
    </an_tab1>
</zoo_animal>

7.6.5 Exportation Xml avec fichier

Si vous cochez l'option avec les fichiers ceux-ci seront importés "inline" dans les fichiers xml. La balise de l'attribut contiendra dans ce cas le fichier encodé en base 64.

<an_photo vid="27" mime="image/png" title="alligator.png">
iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAYAAABccqhmAAAACXBIWXMAAAsTAAALEwEAmpwYAAAABGdBTUE
AALGOfPtRkwAAACBjSFJNAAB6JQAAgIMAAPn/AACA6QAAdTAAAOpgAAA6mAAAF2+SX8VGAAEoA0lEQVR42m
L8//8/wwgE==</an_photo>

7.6.6 Exportation Xml par ligne de commande

L'exportation en ligne de commande est :

./wsh.php --app=FDL --action=EXPORTXMLFLD --id=[folderid] --eformat=[X|Y] --wfile=[N|Y]

Les paramètres sont :

id
Identifiant d'un dossier ou d'une recherche
eformat

Format d'export :

  • X : Archive XML
  • Y : Xml simple
wfile

Avec ou sans les fichiers :

  • Y : Avec fichiers
  • N : Sans fichier
flat

Export à plat

  • Y : Les balises de structure de type "tab" et "frame" ne sont pas représentées. Seule la structure concernant les tableaux est maintenue.

    Ce type d'exportation ne permet pas une réimportation.

  • N : Export normal

log

Générer un fichier de log

Cette option permet de connaître le nombre de documents exportées ainsi que leur liste.

./wsh.php --app=FDL --action=EXPORTXMLFLD --id=1180 --eformat=Y --log=/var/tmp/log.txt > t.xml
$ more /var/tmp/log.txt
EXPORT BEGIN OK : 02/07/2010 15:49:47
EXPORT OPTION FLAT : no
EXPORT OPTION WFILE : yes
EXPORT OPTION CONFIG : yes
EXPORT OPTION ID : ANIMAUX <Les animaux>
EXPORT DOC OK : <a Agouti> [3300]
EXPORT DOC OK : <Albert baleine blanche> [3266]
EXPORT DOC OK : <Alli Baleine à bosse ou jubarte> [3248]
EXPORT DOC OK : <Zoé Antilope> [3317]
EXPORT COUNT OK : 3
EXPORT END OK : 02/07/2010 15:49:47
config

Spécifie une liste de paramètres à exporter

Cela est paramétrable à l'aide d'un fichier de configuration au format xml

Exemple :

configexport.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <family name="ZOO_ANIMAL">
        <attribute name="AN_NOM"/>
        <attribute name="AN_ESPECE"/>
        <attribute name="AN_ENFANT"/>
    </family>
        <family name="ZOO_ENCLOS">
        <attribute name="EN_NOM"/>
        <attribute name="EN_SURFACE"/>
    </family>
</configuration>
./wsh.php --app=FDL --action=EXPORTXMLFLD --id=ANIMAUX --eformat=Y --config=configexport.xml > animaux.xml

Chaque balise family définit les attributs à exporter pour cette famille. Seuls les attributs feuille non structurants sont pris en compte.

Les attributs name désignent les identifiants de familles et d'attributs.

Si on exporte un document d'une famille qui n'est pas dans le fichier de configuration, l'ensemble de ses attributs est exporté.

Source : importation_exportation_documents/exportationsxml.md Dynacase Platform 3.2 | Core Manuel de référence, version 3.2 édition 13, © Anakeen Labs <labs@anakeen.com>
×
Publié sous licence CC (http://creativecommons.org/licenses/by-nc-sa/2.0/fr/) par Anakeen [www.anakeen.com]
Attribution Vous devez créditer l'Oeuvre, intégrer un lien vers la licence et indiquer si des modifications ont été effectuées à l'Oeuvre. Vous devez indiquer ces informations par tous les moyens possibles mais vous ne pouvez pas suggérer que l'Offrant vous soutient ou soutient la façon dont vous avez utilisé son Oeuvre.
Pas d’Utilisation Commerciale Vous n'êtes pas autoriser à faire un usage commercial de cette Oeuvre, tout ou partie du matériel la composant.
Partage dans les Mêmes Conditions Dans le cas où vous effectuez un remix, que vous transformez, ou créez à partir du matériel composant l'Oeuvre originale, vous devez diffuser l'Oeuvre modifiée dans les même conditions, c'est à dire avec la même licence avec laquelle l'Oeuvre originale a été diffusée.