Liste des éléments
Définition et mode d'utilisation
Le composant 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 final 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 la liste spécifiques.
La capture d'écran suivante vous donne un aperçu du composant Liste des éléments :
Vous pouvez configurer le composant Liste des éléments de l'une des manières suivantes :
• 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étermine si les éléments peuvent être sélectionnés dans la liste et, le cas échéant, s'il est possible d'en sélectionner un seul ou plusieurs.
• Configurer les actions disponibles dans la barre d'actions intégrée
• Choisir d'afficher ou non l'action Exporter
L'utilisateur peut filtrer ou rechercher Liste des éléments en utilisant la zone de filtre ou la zone de recherche. Toutefois, si la zone de filtre et la zone de recherche ne sont pas activées dans la configuration, le filtrage et la recherche ne sont pas disponibles. Vous pouvez cliquer sur un titre de colonne pour trier la liste en fonction de cette colonne. Pour inverser l'ordre de tri, cliquez de nouveau sur le titre de la colonne.
Le composant Liste des éléments contient un composant 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 plus d'informations, consultez la rubrique Barre d'actions (bêta). Par défaut, Liste des éléments contient une action Exporter, qui exporte tous les éléments 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).
Activité, Eléments affectés, Pièces jointes et Tâches sont les configurations prédéfinies disponibles pour le composant Liste des éléments.
Propriétés de liaison
Entrée | ||
|---|---|---|
Nom de la propriété | Description | Type de propriété |
input | Utilisé pour identifier les données à récupérer à partir du système principal. Lorsque l'entrée est requise, définissez la propriété de configuration waitForInput sur true. Exemple de JSON : { "version":"1.0.0", "data":[ { "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" }, "itemListsData":[ { "items":[ { "id":{ "value":"OR:wt.workflow.work.WorkItem:1432583" } } ], "objectType":"PTC.Workflow.WorkItem" } ] } ] } | JSON au format CCO |
tailoringName | Identifie de manière unique une instance du composant Liste des éléments. Cette valeur est utilisée en interne pour rechercher des informations sur la personnalisation de cette instance spécifique. N'utilisez cette propriété de liaison que lorsqu'il existe une page de personnalisation dédiée pour votre tâche personnalisée. | |
Sortie | ||
|---|---|---|
Nom de la propriété | Description | Type de propriété |
totalItemsNumber | Nombre d'éléments de la liste qui correspondent aux critères de recherche et de filtre. | Integer |
selectedItems | Utilisé pour identifier les éléments de grille sélectionnés et leurs attributs. Cette propriété peut être liée à la propriété de liaison d'entrée input d'autres composants. Exemple de JSON : { "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" } | JSON au format CCO |
Propriétés de configuration
Les tableaux ci-après présentent les champs JSON utilisés pour configurer ce composant.
Pour plus d'informations sur la structure de la configuration, consultez la rubrique Structure de configuration du composant.
Pour plus d'informations sur les sous-propriétés, consultez la rubrique Sous-propriétés et clés de conteneur.
Nom de la propriété | Description | Type de propriété | Valeur par défaut | Obligatoire ou facultatif ? | |
|---|---|---|---|---|---|
actionBarConfiguration | Configuration de la barre d'actions intégrée. Pour plus d'informations, consultez la rubrique Barre d'actions (bêta). | N/A | Facultatif | ||
attributes | Attributs à afficher. Ceux-ci apparaissent sous forme de titres de colonne dans la grille. | N/A | Obligatoire | ||
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. Cette propriété est une sous-propriété de filterFields et est uniquement pertinente lorsque filterFields est inclus dans la configuration. Sa clé de conteneur est itemListFilterFieldDefinition. | N/A | Facultatif | ||
defaultSortDirection | Le sens du tri par défaut. Options : asc, qui indique l'ordre croissant et dsc, qui indique l'ordre décroissant. Lorsque cette option est vide, l'ordre de tri est décroissant. Cette propriété est une sous-propriété de defaultSortField et est uniquement pertinente lorsque defaultSortField est inclus dans la configuration. Sa clé de conteneur est itemListDefaultSortFieldDefinition. | asc | Facultatif | ||
defaultSortField | Colonne de tri initiale. Lorsque ce paramètre est vide, cela signifie que Liste des éléments est triée d'après la première colonne. | N/A | Facultatif | ||
enableSearch | Indique s'il faut présenter le champ de recherche. Options : true, false. | true | Facultatif | ||
filterFields | Les ID dans le système principal des champs sur lesquels pour filtrer les données. Lorsque ce paramètre est vide, cela signifie qu'il n'y a aucune option de filtrage des données. | N/A | Facultatif | ||
filterLabelOverride | Une étiquette du filtre qui remplace la valeur affichée renvoyée par le service GetItems. Cette propriété est une sous-propriété de filterFields et est uniquement pertinente lorsque filterFields est inclus dans la configuration. Sa clé de conteneur est itemListFilterFieldDefinition. | N/A | Facultatif | ||
implementationConfigurations | Point d'entrée permettant au générateur d'applications de transmettre des valeurs supplémentaires pour leur implémentation, afin de personnaliser davantage le composant. | N/A | Facultatif | ||
label | Titre de la liste des éléments. | [[PTC.ItemList]] | Facultatif | ||
maxNumberOfRowsInGrid | Nombre maximal de lignes à afficher dans la zone de grille. Il est recommandé d'entrer une valeur inférieure à 10 000. | 500 | Facultatif | ||
searchHintText | Texte d'information affiché dans la zone de recherche. Cette propriété est une sous-propriété de enableSearch et est uniquement pertinente lorsque enableSearch est défini sur true. Sa clé de conteneur est itemListSearchDefinition. | Find Item | Facultatif | ||
selectionType | Détermine le nombre d'éléments de la grille qui peuvent être sélectionnés en même temps. Options : • none : les éléments de la grille ne peuvent pas être sélectionnés. • single : un seul élément de grille peut être sélectionné à la fois. • multi : un ou plusieurs éléments de grille peuvent être sélectionnés à la fois. | multi | Facultatif | ||
showExportAction | Active ou désactive l'action Exporter. Options : true, false. | true | Facultatif | ||
waitForInput | Indique s'il faut attendre au moment de l'exécution qu'une valeur soit transmise au paramètre d'application composite d'entrée de Liste des éléments, avant de déclencher la récupération des éléments qui remplissent la grille. Options : true, false. | false | Facultatif | ||
Exemple de configuration
Pour obtenir des exemples de configurations pour le composant Liste des éléments, consultez les rubriques Activité, Eléments affectés, Pièces jointes et Tâches.
Services de personnalisation
En plus de la configuration, chaque composant prend en charge l'extension de sa logique métier afin de le personnaliser. La logique métier de chaque composant inclut des services substituables dans un modèle d'objet que vous pouvez étendre et remplacer. Les services substituables pour ce composant sont détaillés dans le tableau suivant.
Vous trouverez des exemples de renvois et de paramètres pour chaque service à la rubrique Exemples d'entrée/sortie pour les services de personnalisation.
 | Lorsque vous renvoyez un objet JSON au format CCO à partir d'un composant d'implémentation de logique métier vers le composant Liste d'éléments, n'incluez que les attributs d'un même type d'objet. Actuellement, la liste des éléments ne prend pas en charge l'inclusion d'attributs de types d'objet différents. |
Nom | Description |
|---|---|
GetConfigurations | Renvoie les configurations disponibles pour l'implémentation du composant. Paramètres : aucun Renvois : JSON |
GetImplementationLabel | Renvoie soit le nom localisé du composant, soit le jeton qui peut être utilisé pour obtenir le nom localisé. Ce nom localisé s'affiche dans l'interface utilisateur de Mashup Builder. Paramètres : aucun Renvois : chaîne |
GetItems | Renvoie la liste des éléments à partir du système principal. Pour créer une implémentation personnalisée de la liste d'éléments, remplacez ce service pour récupérer les données personnalisées. Paramètres : input (facultatif) : JSON au format CCO qui comprend l'ID d'entrée pour les données à récupérer du système principal et les informations d'adaptateur pour le système principal. Lorsque vous utilisez ce paramètre, assurez-vous que la propriété de configuration waitForInput est définie sur true. configuration (obligatoire) : JSON avec la configuration fusionnée finale obtenue à partir de la ressource de gestionnaire de personnalisations. Renvois : JSON au format CCO |
InitializeFilters | Renvoie la définition du type de filtre pour chacun des champs de filtre de la configuration. Paramètres : input (facultatif) : JSON au format CCO qui comprend l'ID d'entrée pour les données à récupérer du système principal et les informations d'adaptateur pour le système principal. configuration (obligatoire) : JSON avec la configuration fusionnée finale obtenue à partir de la ressource de gestionnaire de personnalisations. Renvois : JSON au format CCO |
DefHookImplementationConfigurationDefinitionGroup | Renvoie la définition spécifique à l'implémentation avec les configurations personnalisées de l'implémentation. Paramètres : aucun Renvois : JSON:Array |
DefHookImplementationAttributesDefinition | Renvoie la définition spécifique à l'implémentation pour les attributs sélectionnés. Paramètres : aucun Renvois : JSON:Array |
DefHookMaxRowsProperties | Renvoie les propriétés pour le nombre maximal de lignes à afficher dans la zone de grille. Paramètres : aucun Renvois : JSON |
Définition de l'implémentation
Pour les définitions d'implémentation du composant Liste des éléments, consultez les rubriques Activité, Eléments affectés, Pièces jointes et Tâches.