A propos de l'interface de configuration XML
L'interface de configuration XML fournit une interface de traitement par lots des mises à jour de la configuration du portail. Elle vous permet d'exporter tout ou partie d'une configuration de portail, par exemple des pages spécifiques, vers un fichier XML. Vous pouvez ensuite recréer la configuration exportée à partir de ce fichier sur un autre portail.
Comment accéder à l'interface de configuration XML ?
Vous pouvez accéder à l'interface de configuration XML à l'aide d'un outil de ligne de commande. Ce client de ligne de commande est un petit programme distinct qui se connecte au serveur via une connexion HTTP ou une connexion HTTPS sécurisée via le protocole SSL. Il est par conséquent possible de configurer le portail à distance.
Tâches que vous pouvez effectuer à l'aide de l'interface de configuration XML
- Copier certaines parties d'une configuration, telles que des pages spécifiques, d'un portail vers un autre. Ce scénario d'utilisation comprend le cas où vous essayez une nouvelle configuration de portail sur un portail test à des fins d'évaluation, avant de la transférer vers un portail de production au cours d'une étape distincte à l'aide de l'interface de configuration du portail.
- Installer des ressources supplémentaires sur un portail.
- Effectuer des tâches d'administration récurrentes de manière automatisée et reproductible.
- L'exportation XML complète d'une configuration de portail ne suffit pas pour recréer le portail. Il vous faut également les fichiers WAR correspondant à vos portlets, et éventuellement des ressources de fichier supplémentaires, telles que les fichiers de thème s'ils ne font pas partie de l'installation de portail standard.
- L'interface de configuration XML n'est pas conçue pour traiter efficacement les gros volumes de données. Pour obtenir une solution de sauvegarde et de restauration sur un serveur de production, vous devez compter sur des sauvegardes de base de données et de système de fichiers de niveau inférieur.
Incidents liés à l'accès et à la sécurité
Pour pouvoir utiliser l'interface de configuration XML, vous devez avoir le rôle de gestionnaire de la ressource virtuelle XML_ACCESS et le rôle d'administrateur de sécurité de la ressource virtuelle PORTAL. Cela implique que vous devez être super-administrateur du portail, lequel peut effectuer n'importe quelle action. Dans ces conditions, aucune autre vérification du contrôle d'accès ne restreindra vos actions lorsque vous utiliserez l'interface de configuration XML : vous pourrez voir l'ensemble des ressources du portail et mettre à jour et supprimer toutes les ressources.
Lorsque vous exécutez l'outil de ligne de commande XML, vous devez vous authentifier en spécifiant votre ID d'utilisateur de portail et votre mot de passe. Lorsque vous utilisez une connexion HTTP, l'ID utilisateur et le mot de passe sont envoyés au serveur non cryptés. Par conséquent, vous ne devriez vous connecter à l'interface de configuration XML que depuis un intranet protégé dans lequel vous êtes certain que la connexion HTTP n'est pas compromise. Sur tous les autres réseaux, configurez le protocole SSL et utilisez une connexion sécurisée HTTPS pour vous connecter à l'interface de configuration XML.
Structure globale des entrées et sorties XML
Deux types principaux de requêtes peuvent être envoyés à l'interface de configuration XML :
- Requêtes d'exportation
- Une requête d'exportation déclenche l'exportation de configurations totales ou partielles du portail au format XML. Elle ne modifie pas la configuration du portail. Elle aboutit à un fichier de réponse.
- Requêtes de mise à jour
- Une requête de mise à jour modifie la configuration du portail en fonction des valeurs figurant dans le script XML.
Un troisième type de requête est disponible pour préparer la suppression des données orphelines :
- Requêtes export-orphaned-data
- Une requête export-orphaned-data exporte l'ensemble de la configuration du portail en XML, y compris les données orphelines. Elle aboutit à un fichier de réponse.
Les requêtes adressées à l'interface de configuration XML et les réponses en provenant utilisent le même format XML. Une requête d'exportation génère une réponse XML contenant l'ensemble des données de configuration requises pour recréer la partie de la configuration exportée. Cela signifie que vous pouvez exporter une configuration de portail, enregistrer le fichier XML de sortie puis, sans modification, l'envoyer vers un autre portail pour y recréer la même configuration.
- UNIX™Linux™ :
PortalServer_root/base/wp.xml/shared/app - IBM® i:
PortalServer_root/base/wp.xml/shared/app - z/OS® :
PortalServer_root/base/wp.xml/shared/app - Windows™ :
PortalServer_root\base\wp.xml\shared\app
com/ibm/wps/command/xml/PortalConfig_8.5.0.xsd. Une requête XML contient les éléments suivants :- Une section portail obligatoire ; elle décrit les parties de la configuration du portail qui doivent être exportées ou mises à jour.
- Une section d'état facultative. Dans une réponse XML, cette section indique la réussite ou l'échec de l'opération demandée. Au cours de l'importation de données de configuration, le traitement XML ignore cette section du fichier d'entrée XML.
Représentation d'une configuration de portail en XML
La hiérarchie XML figurant dans la section portal du fichier de requête XML représente la structure d'un portail sous forme d'arborescence XML. Cette arborescence contient les ressources du portail, telles que les portlets ou les pages, ainsi que leurs données de configuration. La hiérarchie XML de l'ensemble des ressources du portail prises en charge apparaît dans le tableau suivant :
| Elément XML | Description |
|---|---|
|
L'élément principal de chaque requête XML |
|
Les paramètres globaux du portail |
|
Les paramètres généraux du portail pour les services de portail |
|
Langues définies dans un portail |
|
Les tâches pouvant être utilisées pour planifier des programmes |
|
Les actions pouvant être utilisées pour créer des ensembles d'actions |
|
Les ensembles d'actions qui peuvent être utilisés pour créer des rôles. Il sont également appelés Types de rôle. |
|
Les ressources virtuelles associées à des paramètres de contrôle d'accès |
|
Les types de ressource que vous pouvez utiliser pour créer des ressources personnalisées. |
|
Une instance de ressource qui est protégée par le contrôle d'accès au portail. |
|
Les utilisateurs définis dans le système de gestion des utilisateurs du portail |
|
Les groupes définis dans le système de gestion des utilisateurs |
|
Les mises à jour qui peuvent être prises en charge par les pages du portail |
|
Les périphériques clients (navigateurs) connus du portail |
|
Informations relatives à la classe d'unités |
|
Les paramètres d'apparence visuelle qui peuvent être appliqués aux éléments de l'interface utilisateur |
|
Les paramètres visuels généraux pouvant être appliqués à l'interface utilisateur |
|
Producteur de services Web tel que défini dans le portail Consommateur |
|
URL du document WSDL du fournisseur |
|
URL de la description de service, du marquage, de l'enregistrement ou de la gestion du portlet du fournisseur |
|
Les modules Web contenant des portlets |
|
Fichier WAR contenant l'application Web |
|
Racine de contexte attribuée à l'application Web de l'application de portlet dans le fichier EAR prédéployé (référence : application.xml) |
|
Nom affecté à l'application dans le fichier EAR prédéployé (référence : application.xml) |
|
Servlets définis dans le module Web |
|
Applications de portlets définies dans le module Web |
|
Les portlets définis dans l'application de portlet |
|
Définition du serveur de fédération. Ce serveur permet d'extraire les noeuds de contenu. |
|
Eléments de l'arborescence de contenu du portail (pages ou balises) |
|
Marquages pris en charge par ce noeud de contenu. |
|
Portlets autorisés sur cette page. |
|
Les composants de la mise en page |
|
Sous-composants structurels de la page. |
|
Les occurrences d'un portlet sur une page avec paramètres personnalisés |
|
Courtier de propriété établissant une connexion entre deux instances de portlet. Remarque : La balise wire est devenue obsolète avec la version 7 d'HCL Portal, car elle prend en charge uniquement une connexion de courtier de propriété entre deux portlets sur la même page. Utilisez la balise cross-page-wire car elle prend en charge une connexion de courtier de propriété entre portlets sur la même page et sur des pages différentes. |
|
Segments permettant de stocker les informations d'identification dans le coffre d'identification |
|
Les logements d'un segment d'identification qui contiennent une identification |
|
Les URL définies par l'utilisateur qui se mappent sur des pages du portail |
|
Permet l'exportation et la suppression de ressources utilisateur spécifiques. |
|
Stratégies définies dans le portail |
|
Ensemble de rôles d'autorisation qui peuvent être affectés à des utilisateurs ou des groupes. |
|
Occurrence personnalisée d'un portlet fournie par WSRP sur un portail Producteur |
|
Ressource personnalisée pouvant être marquée ou validée par les utilisateurs |
|
Catégorie affectée à une ressource personnalisée |
|
Balise appliquée à une ressource par un utilisateur |
|
Classement appliqué à une ressource par un utilisateur |
|
Filtre utilisé pour le prétraitement des données avant leur stockage final. |
Selon le contenu d'une requête XML, ces ressources peuvent être créées, modifiées, supprimées ou exportées. Une requête XML peut contenir de multiples définitions de telles ressources. Elle peut par conséquent créer des centaines de nouvelles ressources en une seule étape ou modifier un seul paramètre de configuration d'une ressource existante.