Personnalisation avancée > Utilisation de composants réutilisables > Composants réutilisables disponibles > Liste des éléments
  
Liste des éléments
Définition et mode d'utilisation
Le composant réutilisable Liste des éléments est une application composite contenue qui vous permet d'afficher une liste des éléments d'un ensemble de données, dans une vue de grille. Il permet également à l'utilisateur de rechercher, de trier et de filtrer la liste, ainsi que d'exécuter des actions sur l'ensemble de la liste ou sur des éléments de liste spécifiques.
Vous pouvez configurer le composant réutilisable Liste des éléments de l'une des manières suivantes :
• Définir l'objet de modèle qui fournit des entrées à la liste
• Activer ou désactiver la recherche et le filtrage
• Définir les options de filtrage et de tri initiales
• Définir le nombre maximal de lignes dans la grille
• Définir le type de sélection de la liste
• Configurer les actions disponibles dans la barre d'actions intégrée (pour plus d'informations, consultez la barre d'actions)
Vous pouvez filtrer ou rechercher des éléments dans la liste des éléments en utilisant le menu déroulant Filtre ou la zone de recherche. Toutefois, si le menu déroulant Filtre et la zone de recherche ne sont pas activés dans le fichier de configuration JSON, le filtrage et la recherche ne sont pas disponibles. Vous pouvez cliquer sur un nom d'attribut pour trier la liste par attribut. Pour inverser l'ordre de tri, cliquez de nouveau sur le nom de l'attribut.
Le composant réutilisable Liste des éléments contient également un composant réutilisable Barre d'actions intégré. En configurant ce dernier, vous pouvez activer des fonctionnalités supplémentaires, telles que l'exécution d'une action sur un ou plusieurs éléments de la liste. Pour en savoir plus, consultez la section relative au composant Barre d'actions. Par défaut, la barre d'actions de la liste des éléments contient une action Exporter, qui exporte toutes les valeurs d'attribut correspondant aux critères de filtrage vers un fichier CSV.
Le composant Liste des éléments inclut également un bouton Restaurer les valeurs par défaut. Le bouton Restaurer les valeurs par défaut restaure les paramètres par défaut relatifs au filtrage, à la recherche et aux opérations au niveau de la grille (tri, échange et affichage ou masquage des colonnes).
La capture d'écran suivante donne une vue du format du composant réutilisable Liste des éléments :
Quatre configurations prédéfinies sont disponibles pour le composant réutilisable Liste des éléments : Liste des tâches, liste Pièces jointes, liste Eléments affectés et liste Activité. Pour en savoir plus sur une configuration prédéfinie spécifique, consultez la page de rubrique correspondante.
Propriétés de liaison
Le composant Liste des éléments propose quatre propriétés disponibles pour la liaison :
• input : JSON qui fournit l'ID d'entrée pour lequel les données doivent être récupérées à partir du système principal. Ces informations sont fournies dans un format CCO (Common Communication Object). Les clés incluses dans ce fichier JSON dépendent des données que la liste des éléments doit recevoir en tant qu'entrée. Par exemple, la liste Pièces jointes nécessite une entrée différente de la liste Eléments affectés.
• tailoringName : chaîne correspondant au nom d'instance du composant. Il est étroitement lié à la personnalisation. Le paramètre tailoringName permet de récupérer les informations de personnalisation enregistrées pour chaque composant.
• totalItemsNumber : entier correspondant au nombre total d'éléments de liste qui répondent aux critères de recherche et de filtrage.
• selectedItems : JSON comportant la liste des éléments sélectionnés dans la grille. Voici un exemple :
{
"timeStamp":"2019-08-25 18:53:33.476",
"data":[
{
"itemListsData":[
{
"items":[
{
"workItem":{
"value":"OR:wt.workflow.work.WorkItem:143921"
}
},
{
"workItem":{
"value":"OR:wt.workflow.work.WorkItem:143928"
}
}
],
"objectType":"PTC.Workflow.WorkItem"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
],
"version":"1.0.0",
"statusMessage":"OK",
"status":"200"
}
Champs de configuration
Les tableaux ci-après présentent les champs JSON utilisés pour configurer ce composant.
Nom de la propriété
Description
Type
Valeur par défaut
Obligatoire ou facultatif ?
maxNumberOfRowsInGrid
Nombre maximal de lignes à afficher dans la zone de grille. Il est recommandé de spécifier une valeur non supérieure à 10 000.
Integer
50
Facultatif
modelThingName
Nom de l'objet de modèle qui obtient les données.
String
PTC.ItemListModelThing.
Obligatoire
label
Titre de la liste des éléments.
String
[[PTC.ItemList]]
Facultatif
selectionType
Détermine le nombre d'éléments de la grille que vous pouvez sélectionner simultanément. Options disponibles : none, single ou multi.
String
multi
Facultatif
waitForInput
Indique s'il faut attendre qu'une valeur soit transmise au paramètre d'application composite d'entrée de la liste des éléments, au moment de l'exécution, pour déclencher la récupération des éléments qui remplissent la grille. Options disponibles : true, false.
Boolean
false
Facultatif
filterFieldID
ID du champ du système principal selon lequel effectuer le filtrage. Lorsque ce paramètre est vide, cela signifie qu'il n'y a aucune option de filtrage.
MultiValueSelector
N/A
Facultatif
filterLabelOverride
Etiquette du filtre qui remplace la valeur affichée renvoyée par le modèle.
String
N/A
Facultatif
defaultSelectedFilterValue
Valeur ou valeurs de sélection initiales à appliquer pour le filtrage. Lorsque ce paramètre est vide, cela signifie qu'il n'y a pas de filtrage par défaut.
String
N/A
Facultatif
defaultSortField
Colonne de tri initiale. Lorsque ce paramètre est vide, cela signifie que la liste des éléments est triée d'après la première colonne.
MultiValueSelector
N/A
Facultatif
defaultSortDirection
Direction de tri par défaut, le cas échéant. Options disponibles : asc, qui indique que le tri doit être croissant, et dsc, qui indique l'ordre décroissant. Si ce champ n'est pas renseigné, le tri est d'ordre croissant.
String
asc
Facultatif
enableSearch
Indique s'il faut présenter le champ de recherche. Options : true, false.
Boolean
true
Facultatif
findHintText
Texte d'information affiché dans la zone de recherche.
String
"[[PTC.ItemListFindHintText]]"
Facultatif
attributes
Attributs à afficher dans la grille. Pour en savoir plus, consultez la documentation relative au paramètre MultiValueSelector. Consultez une sous-propriété supplémentaire :
MultiValueSelector
N/A
Obligatoire
fieldTitleOverride
Nom d'affichage alternatif de l'attribut, qui remplace le nom de champ extrait du modèle.
String
N/A
Facultatif
showExportAction
Active ou désactive l'action Exporter. Options : true, false.
Boolean
true
Facultatif
actionBarConfiguration
Configuration de la barre d'actions intégrée. Pour en savoir plus, consultez la section relative au composant Barre d'actions.
JSON
N/A
Facultatif
modelConfigurations
Point d'entrée permettant au générateur d'application de transmettre des valeurs supplémentaires au modèle, pour personnaliser davantage le composant.
JSON
N/A
Facultatif
Exemple de configuration
{
"modelConfigurations":{
},
"filterFieldId":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":""
}
],
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"defaultSortField":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":""
}
],
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"actionBarConfiguration":{
"maxItemsToShow":{
"value":2
},
"modelThingName":{
"entityName":"PTC.ActionBarModel.Thing"
},
"actions":{
"selectedValues":{
"data":[
{
"itemListsData":[
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
]
}
}
},
"modelThingName":{
"entityName":"PTC.ItemListModelThing"
},
"label":{
"value":"[[PTC.ItemListLabel]]"
},
"showExportAction":{
"value":true
},
"selectionType":{
"selectedKey":"multi"
},
"waitForInput":{
"value":false
},
"filterLabelOverride":{
"value":""
},
"defaultSortDirection":{
"selectedKey":"asc"
},
"attributes":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":"",
"additionalData":{
"fieldTitleOverride":{
"value":""
}
}
}
],
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"defaultSelectedFilterValue":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":""
}
],
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"enableSearch":{
"value":true
},
"maxNumberOfRowsInGrid":{
"value":50
}
}