Tâche register-iwidget-definition

Run the portal configuration task register-iwidget-definition to register individual iWidget definitions on HCL Portal.

Identifiez la définition d'iWidget à l'aide d'une adresse URL absolue qui désigne le fichier XML de définition d'iWidget. L'exécution de cette tâche télécharge le fichier XML de définition d'iWidget à partir de l'emplacement spécifié et crée un clone de portlet iWidget Wrapper correspondant. Si un clone de portlet iWidget Wrapper existe déjà pour l'adresse URL d'iWidget indiquée, aucun clone n'est créé, mais le portlet existant est mis à jour avec les informations chargées à partir du fichier XML de définition d'iWidget spécifié.

Syntaxe : appelez cette tâche dans le cadre du fichier script ConfigEngine comme suit :

UNIX™Linux™ : ./ConfigEngine.sh register-iwidget-definition -DIWidgetDefinition=IWidget Definition URL -DIWidgetCatalog=dav:fs-type1/iwidgets/IWidget_name/catalog.xml -DPortalAdminPwd=wpsadmin -DWasPassword=wpsadmin
IBM® i:
- A partir du répertoire UserData : ConfigEngine.sh register-iwidget-definition -DIWidgetDefinition=IWidget Definition URL -DIWidgetCatalog=dav:fs-type1/iwidgets/IWidget_name/catalog.xml -DPortalAdminPwd=wpsadmin -DWasPassword=wpsadmin
Windows™ : ConfigEngine.bat register-iwidget-definition -DIWidgetDefinition=iwidget_Definition_URL -DIWidgetCatalog=dav:fs-type1/iwidgets/IWidget_name/catalog.xml -DPortalAdminPwd=wpsadmin -DWasPassword=wpsadmin

Paramètres obligatoires que vous pouvez spécifier avec la ligne de commande ou dans le fichier wkplc.properties :

WasUserid: ID utilisateur pour WebSphere® Application Server
WasPassword: Mot de passe correspondant à l'ID utilisateur utilisé pour WebSphere® Application Server
PortalAdminId: ID administrateur pour HCL Portal
PortalAdminPwd: Mot de passe correspondant à l'ID administrateur utilisé pour HCL Portal
WPS_SOAP_PORT: Port SOAP utilisé pour relier le serveur de portail aux connexions à distance

Paramètres obligatoires que vous pouvez spécifier avec la ligne de commande uniquement :

IWidgetDefinition: Adresse URL du fichier XML de définition de l'iWidget.

Paramètres facultatifs que vous pouvez spécifier avec la ligne de commande uniquement :

IWidgetCatalog: Adresse URL d'un fichier XML de catalogue IBM® Mashup Center. Si vous spécifiez ce paramètre, la tâche register-iwidget-definition analyse le fichier XML de catalogue référencé afin d'enregistrer des définitions de l'iWidget ou d'actualiser les clones de portlet iWidget Wrapper existants. Si le fichier XML de catalogue analysé contient une entrée comportant un élément de définition qui désigne le même fichier de définition de l'iWidget que le paramètre IWidgetDefinition ou le clone de portlet iWidget Wrapper identifié par le paramètre PortletDefinition, les titres et les descriptions provenant de l'entrée de catalogue correspondante sont pris en compte pour la création ou la mise à jour du clone de portlet iWidget Wrapper. Plus précisément, les titres et les descriptions provenant de l'entrée de catalogue ne sont définis sur le clone de portlet iWidget Wrapper que si la définition de l'iWidget correspondante ne définit pas les titres ou les descriptions dans son objet idescriptor. Lorsque vous exécutez la tâche register-iwidiget-definition et spécifiez le paramètre IWidgetCatalog, mais omettez IWidgetDefinition et PortletDefinition, les clones de portlet IWidget Wrapper pour toutes les définitions de l'iWidget référencées dans le fichier XML de catalogue donné sont créés ou mis à jour.
PortletDefinition: Nom unique ou ID objet sérialisé d'un clone de portlet iWidget Wrapper à actualiser. Si vous spécifiez ce paramètre, la tâche register-iwidgetdefinition actualise le clone de portlet iWidget Wrapper référencé. Cela signifie que la définition d'iWidget référencée par le clone de portlet iWidget Wrapper existant est analysée à nouveau en vue de la mise à jour du portlet.
PortletUniqueName: Si ce paramètre est spécifié, un portlet iWidget Wrapper est créé avec un nom unique, comme spécifié par ce paramètre. Si ce paramètre est spécifié, la tâche crée toujours un clone de portlet iWidget Wrapper indépendant de l'adresse URL IWIdgetDefinition donnée déjà enregistrée sur le portail.
Remarque : Si le nom unique donné est déjà affecté à une autre ressource, la tâche échoue et aucun portlet iWidget Wrapper n'est créé.

Assumptions/Prerequisites : HCL est en cours d'exécution. Si HCL n'est pas en cours d'exécution, la tâche le démarre.

Error Conditions : Aucun

Task dependencies : Aucun

Tasks invoked : Aucun

Examples : Vous pouvez enregistrer le fichier XML de définition de l'iWidget situé à l'adresse http://server_name:port_number/someWidget/someWidget/someWidget.xml comme suit :

./ConfigEngine.sh register-iwidget-definition
   -DPortletUniqueName="someWidget"
   -DIWidgetDefinition=http://server_name:port_number/someWidget/someWidget/someWidget.xml  
   -DPortalAdminPwd=wpsadmin -DWasPassword=wpsadmin

Vous pouvez actualiser le clone de portlet iWidget Wrapper avec le nom unique someWidget :

./ConfigEngine.sh register-iwidget-definition -DPortletDefinition="someWidget"
   -DPortalAdminPwd=wpsadmin -DWasPassword=wpsadmin

Vous pouvez enregistrer le fichier XML de définition de l'iWidget situé à l'adresse http://server_name:port_number/someWidget/someWidget/someWidget.xml en prenant en compte les titres et les descriptions provenant du fichier XML du catalogue Mashup Center situé à l'adresse http://server_name:port_number/someWidget/someWidget/catalog.xml :

./ConfigEngine.sh register-iwidget-definition
   -DIWidgetDefinition=http://server_name:port_number/someWidget/someWidget/someWidget.xml
   -DIWidgetCatalog=http://server_name:port_number/someWidget/someWidget/catalog.xml  
   -DPortalAdminPwd=wpsadmin -DWasPassword=wpsadmin

Vous pouvez actualiser le clone de portlet iWidget Wrapper avec le nom unique someWidget, en prenant en compte les titres et les descriptions provenant du fichier XML du catalogue Mashup Center situé à l'adresse http://server_name:port_number/someWidget/someWidget/catalog.xml :

./ConfigEngine.sh register-iwidget-definition
   -DPortletDefinition="someWidget"
   -DIWidgetCatalog=http://server_name:port_number/someWidget/someWidget/catalog.xml
   -DPortalAdminPwd=wpsadmin -DWasPassword=wpsadmin

Vous pouvez procéder à un enregistrement par lots des fichiers XML de définition d'iWidget ou à une actualisation des clones de portlet iWidget Wrapper en utilisant un fichier XML du catalogue Mashup Center :

./ConfigEngine.sh register-iwidget-definition
   -DIWidgetCatalog=http://server_name:port_number/catalog.xml
   -DPortalAdminPwd=wpsadmin -DWasPassword=wpsadmin

Notes :

L'URL peut désigner le serveur de portail ou un serveur externe. Configurez le proxy AJAX du portail pour autoriser l'accès à ce serveur. Pour plus de détails, reportez-vous à la section suivante.
Si l'élément de définition d'une entrée dans le fichier XML du catalogue Mashup Center contient une adresse URL relative, celle-ci est résolue sous forme absolue à l'aide de l'adresse URL spécifiée par le paramètre IWidgetCatalog comme adresse URL de base. Seule l'adresse URL absolue est utilisée pour les traitements ultérieurs, par exemple pour accéder au fichier XML de la définition d'iWidget. L'adresse URL absolue est également comparée à la valeur du paramètre IWidgetDefinition ou à l'URL de la définition de l'iWidget du clone du portlet iWidget Wrapper identifiée par le paramètre PortletDefinition afin de déterminer s'il faut ou non utiliser les titres et les descriptions de l'entrée de fichier XML du catalogue au moment de l'analyse syntaxique, de la création ou de la mise à jour du clone du portlet iWidget Wrapper.
La tâche register-iwidget-definition actualise les titres et les descriptions d'un clone du portlet iWidget Wrapper uniquement si vous affectez la valeur true aux préférences de portlet suivantes : com.ibm.portal.replace.titles et com.ibm.portal.replace.descriptions.
Lorsque les titres et les descriptions d'un clone de portlet IWidgetWrapper sont définis avec les valeurs d'un fichier XML de catalogue HCL Mashup Center, les préférences de portlet com.ibm.portal.replace.titles (valeur par défaut : true) et com.ibm.portal.replace.descriptions prennent la valeur false sur le clone de portlet IWidget Wrapper. Ces préférences de portlet empêchent que les titres et les descriptions du clone du portlet iWidget Wrapper soient remplacés lors des mises à jour ultérieures. Cela s'avère particulièrement utile lors de l'exécution de la tâche register-iwidget-definition pour mettre à jour toutes les définitions de l'iWidget enregistrées dans HCL Portal. Cette tâche ne prend en compte que les définitions d'iWidget conformes à la spécification d'iWidget et ne traite pas les fichiers XML du catalogue IBM Mashup Center.
Lorsque vous actualisez des clones de portlet iWidget Wrapper, les valeurs des attributs d'iWidget (objets de l'ensemble d'objets d'attributs de l'iWidget) ne sont modifiées que lorsque ces attributs sont marqués comme étant accessibles en lecture seule dans le fichier XML de définition d'iWidget. Pour cette raison, les valeurs des attributs d'iWidget personnalisées après l'enregistrement de l'iWidget dans HCL Portal ne sont jamais perdues lors de la régénération.

Enregistrement d'un iWidget hébergé sur un serveur de portail

Si vous voulez enregistrer les iWidgets déployés en tant que fichiers WAR ou EAR directement sur votre serveur de portail, vous pouvez utiliser les URL de serveur désignant les fichiers XML de définition d'iWidget correspondants ; par exemple :

./ConfigEngine.sh register-iwidget-definition 
     -DIWidgetDefinition=/someWidget/someWidget/someWidget.xml
     -DPortalAdminPwd=wpsadmin -DWasPassword=wpsadmin

A faire : N'oubliez pas la barre oblique "/" dans votre URL de définition d'iWidget.

Enregistrement d'un iWidget hébergé sur un serveur externe

Si vous utilisez une URL de définition d'iWidget qui désigne un serveur autre que votre serveur de portail, vous devez vous assurer que votre configuration de proxy AJAX en cours autorise l'accès à ce serveur. Pour plus d'informations, reportez-vous à la rubrique sur la configuration de proxy AJAX. Vous pouvez réaliser cette configuration en vous assurant que l'URL du fichier XML de définition d'iWidget est mappée sur la règle default_policy dynamique dans le fichier de configuration de proxy AJAX. Vous pouvez mapper une URL donnée, par exemple, http://server_name:port_number/someWidget/someWidget/someWidget.xml, à cette règle en ajoutant une propriété personnalisée, telle que celle mentionnée ci-dessous, au fournisseur d'environnement de ressources WP ConfigService dans la console d'administration de WebSphere® Application Server :

wp.proxy.config.urlreplacement.default_policy.someID=http://some.server.com:10039/*

Notes :

La règle mise à jour n'est appliquée qu'au redémarrage du serveur de portail ou de l'application d'entreprise de configuration de proxy AJAX en cours d'exécution sur le serveur de portail.
Si vous utilisez un préfixe d'URL, n'oubliez pas l'astérisque ( * ).

Enregistrement des iWidgets simplifiés stockés dans le magasin de fichiers WebDAV

Outre les URL de définition d'iWidget HTTP ou HTTPS, vous pouvez utiliser les URI de magasin de fichiers WebDAV désignant les fichiers XML de définition d'iWidget se trouvant dans le magasin de fichiers WebDAV. Le format de ces URI est le suivant :

dav:fs-type1/path_to_your_IWidget_definition_XML_file

Par exemple, vous pouvez avoir un fichier d'archive ou un fichier compressé avec un iWidget simplifié qui contient un fichier XML de définition d'iWidget appelé someWidget.xml dans le dossier principal du fichier d'archive ou du fichier compressé. Dans ce cas, vous devez d'abord copier le fichier d'archive ou le fichier compressé dans le magasin de fichiers WebDAV à l'aide d'un client WebDAV générique ou à l'aide de la tâche de configuration webdav-deploy-zip-file comme suit :

./ConfigEngine.sh webdav-deploy-zip-file 
     -DZipFilePath=/tmp/SomeWidgetPackage.zip 
     -DTargetURI=dav:fs-type1/iwidgets/SomeWidget/
     -DPortalAdminPwd=wpsadmin -DWasPassword=wpsadmin

Ceci extrait votre module iWidget simplifié représenté par le fichier /tmp/SomeWidgetPackage.zip dans le dossier /iwidgets/SomeWidget du magasin de fichiers WebDAV. Prenez soin d'ajouter la barre oblique de fin (/) dans le paramètre TargetURI. Une fois l'extraction terminée, vous pouvez enregistrer le fichier XML de définition de l'iWidget someWidget.xml comme suit :

./ConfigEngine.sh register-iwidget-definition 
     -DIWidgetDefinition=dav:fs-type1/iwidgets/SomeWidget/someWidget.xml 
     -DPortalAdminPwd=wpsadmin -DWasPassword=wpsadmin