Contexte de rendu de liste

Dans HCL Digital Data Connector (DDC) for HCL Portal, le contexte de rendu de liste représente un objet de données agrégées. Les plug-ins DDC peuvent utiliser l'objet de données afin de déterminer les données à charge et comment filtrer et trier les données. Vous pouvez créer un contexte de rendu de liste en ajoutant une balise [Plugin:ListRenderingContext] à vos conceptions Web Content Manager. Des parties du contenu de contexte sont automatiquement traitées par le framework DDC. Ces parties incluent la demande et la réponse du portlet actuel et les paramètres de rendu Digital Data Connector publics. D'autres parties doivent être indiquées via des paramètres de la balise Plugin:ListRenderingContext. La syntaxe générale de la balise est la suivante :

[Plugin:ListRenderingContext action=”” extension-id=”” profile=””attribute=”” 
                             key=”” format=”” separator=”” escape=”” prefix]

Les paramètres sont décrits dans la liste suivante :

action

Ce paramètre est obligatoire. Ce paramètre permet d'identifier l'action à exécuter. Les valeurs prises en charge sont les suivantes :

set

Utilisez cette valeur en vue d'établir un nouveau contexte de rendu de liste. Vous pouvez également imbriquer des contextes de rendu de liste. Si vous indiquez cette valeur, vous devez également définir le paramètre extension-id.

supprimer

Cette valeur permet de supprimer le contexte de rendu de liste. Si ce contexte de rendu de liste était imbriqué, le contexte de rendu de liste le plus externe redevient actif.

getListProperty

Cette valeur permet d'extraire des propriétés de la liste de beans qui a été chargée pour le contexte de rendu de liste courant.

getAttribute

Cette valeur permet d'extraire des attributs particuliers que vous avez indiqués lorsque vous avez créé le contexte de rendu de liste courant.

getFilter

Cette valeur permet d'extraire la valeur d'un paramètre de rendu public de filtre DDC spécifique.

reloadProfiles

Cette valeur permet d'effacer tous les caches associés à DDC et de recharger tous les profils de rendu de liste. Ce paramètre peut s'avérer utile dans les environnements de développement pour activer des modifications dans des profils de rendu de liste déployés.

clearCaches

Cette valeur permet d'effacer tous les caches associés à DDC. Ce paramètre peut s'avérer utile dans les environnements de développement pour analyser les problèmes liés à la mise en cache.

exceptionOccured

Cette valeur permet de vérifier si une exception s'est produite pendant le calcul d'une liste de beans. Le portlet d'afficheur de contenu Web affiche le contenu de la balise de plug-in ListRenderingContext avec cette action uniquement si une exception s'est produite au cours du traitement du contexte de rendu de liste en cours.

getExceptionMessage

Cette valeur permet d'extraire le message d'une exception qui s'est produite pendant le calcul d'une liste de beans.

extension-id

Ce paramètre permet d'identifier le plug-in DDC particulier que vous souhaitez pour gérer ce contexte. Ce paramètre est obligatoire avec le paramètre action="set". Pour traiter le plug-in DDC XML générique, indiquez la valeur ibm.portal.ddc.xml.

profil

Ce paramètre permet d'identifier le profil de rendu de liste que vous voulez utiliser. Ce paramètre devient effectif uniquement associé au paramètre action="set". Ce paramètre est obligatoire lorsque vous traitez le plug-in DDC XML générique dans le paramètre extension-id.

attribut

Ce paramètre peut être utilisé comme attribut à valeurs multiples en vue d'ajouter des informations supplémentaires au contexte de rendu de liste. Ce paramètre est applicable uniquement pour action="set". Le plug-in DDC XML générique prend en charge un ensemble d'attributs. Pour plus d'informations sur ces attributs, voir Plug-in Digital Data Connector XML générique.

key

Ce paramètre permet d'identifier l'attribut particulier de propriété de liste que vous voulez écrire dans le marquage. Ce paramètre est applicable uniquement pour action="getListProperty" et action="getAttribute".

format

Ce paramètre permet d'indiquer le formatage à utiliser lorsque le plug-in écrit des propriétés de liste de type Date dans le marquage. Ce paramètre est applicable uniquement pour action="getListProperty".

séparateur

Ce paramètre permet d'indiquer le fragment du marquage particulier qui doit être écrit dans le marquage entre les éléments d'une propriété de liste à valeurs multiples. La valeur par défaut est une virgule ( , ). This parameter is relevant for the settingaction="getListProperty" only.

Echap

Ce paramètre permet d'indiquer la séquence d'échappement que vous voulez appliquer au marquage généré par le plug-in. Les valeurs prises en charge sont les suivantes : xml, json, javascript et none. La valeur par défaut est none. Ce paramètre est applicable uniquement pour action="getListProperty", action="getAttribute", action="getFilter" et action="getExceptionMessage".

préfixe

Ce paramètre permet d'indiquer le préfixe pour le paramètre de rendu public de filtre DDC à extraire. Ce paramètre est applicable uniquement pour action="getFilter".

Le tableau suivant répertorie les actions prises en charge par les paramètres et indique s'ils sont obligatoires.

Tableau 1. Paramètres obligatoires et actions qu'ils prennent en charge

Paramètres de contexte de rendu de liste qui sont obligatoires et actions prises en charge par ces derniers

Paramètre	Le paramètre est approprié pour ces actions	Le paramètre est obligatoire pour les actions de la colonne précédente
action	S/O	S/O
extension-id	set	oui
profile	set	Le caractère obligatoire du paramètre profile dépend de la valeur du paramètre extension-id. Si vous traitez le plug-in DDC XML générique, le paramètre profile est obligatoire.
attribute	set	non
key	getListProperty, getAttribute	oui
format	getListProperty	non
separator	getListProperty, getFilter	non
escape	getListProperty, getAttribute, getFilter	non

Vous trouvez des exemples sur le mode de définition du contexte de rendu de liste dans les rubriques suivantes.