Structure de fichier script d'entrée XML

Lorsque vous utilisez le client de ligne de commande de l'interface de configuration XML, le script XML que vous utilisez spécifie l'élément racine, le schéma XML, les ressources de portail et les actions à effectuer.

La structure de niveau principal d'une requête ou d'une réponse XML se présente toujours comme suit :


<?xml version="1.0" encoding="UTF-8"?>
   <request
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation="PortalConfig_8.5.0.xsd"
    type="export|update"> 
      <portal . . . >
      definition of configuration parts to be exported or updated
      </portal>
      <status . . . >
      success or failure indication for the processing
      </status>
   </request>
Le principal élément de la requête spécifie le schéma XML utilisé par l'interface de configuration XML. Vous devez toujours utiliser la référence de schéma indiquée dans l'exemple, à savoir une référence ne contenant pas d'espace de nom pour le schéma PortalConfig_8.5.0.xsd. Toutes les requêtes XML doivent respecter ce schéma. Pour référence, vous pouvez consulter la déclaration de schéma dans le fichier JAR wp.xml.jar sous l'emplacement com/ibm/wps/command/xml/PortalConfig_8.5.0.xsd. Le fichier JAR wp.xml.jar se trouve dans le répertoire suivant :Tous les autres fichiers modèles XML se trouvent dans le répertoire suivant : Avant d'envoyer des requêtes au portail, vous pouvez les vérifier par rapport à ce schéma à l'aide d'un éditeur ou d'un analyseur syntaxique pour vous assurer que la syntaxe est correcte. Le schéma contient également des annotations donnant des informations détaillées sur la signification et les valeurs possibles de toutes les entrées de configuration.

L'attribut type indique si la requête XML contient des spécifications relatives à l'exportation ou à la mise à jour des ressources du portail.

La section portail décrit les éléments de la configuration du portail qui doivent être exportés ou mis à jour. Le contenu de la hiérarchie utilisée est décrit plus en détails dans les sections suivantes.

La section état est facultative ; dans une réponse XML, elle indique la réussite ou l'échec de l'opération demandée. Si un élément d'état est présent dans une requête XML, le serveur l'ignore.

La requête la plus simple que vous pouvez envoyer à un serveur est la suivante :

   <?xml version="1.0" encoding="UTF-8"?>
      <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
         xsi:noNamespaceSchemaLocation="PortalConfig_8.5.0.xsd"
            type="export"> 
         <portal action="export"/>
      </request>

Cette requête exporte l'intégralité de la configuration de portail. Vous pouvez examiner le contenu de la réponse pour savoir comment la configuration des ressources individuelles du portail, telles que les portlets ou les pages, est représentée dans les éléments et attributs XML.

Outre les types de demande export et update, un troisième type de demande export-orphaned-data est disponible pour le scénario particulier relatif à la préparation de la suppression des données orphelines.