Vignettes
Définition et mode d'utilisation
Le composant Vignettes est un widget qui vous permet d'afficher les paires nom-valeur, également appelées attributs, sous la forme de vignettes. L'objectif du composant Vignettes est de mettre en surbrillance les informations clés, afin que les utilisateurs puissent les afficher en un clin d'oeil. La valeur de l'attribut apparaît dans la moitié supérieure de la vignette, et le nom de l'attribut, dans la moitié inférieure de la vignette. La valeur peut prendre jusqu'à deux lignes et le nom peut prendre jusqu'à une ligne. Si le nom ou la valeur ne tient pas dans la vignette du fait de sa longueur, il est tronqué et la partie tronquée est remplacée par des points de suspension. Les vignettes sont généralement organisées sur une seule ligne. S'il y a trop de vignettes pour qu'elles s'affichent sur une seule ligne, la taille des vignettes est ajustée pour qu'elles tiennent sur la ligne. Si le nombre de vignettes reste malgré tout trop élevé pour qu'elles tiennent toutes sur la ligne, l'affichage des vignettes s'étend sur une deuxième ligne.
La capture d'écran suivante vous donne un aperçu du composant Vignettes :
Vous pouvez configurer le composant Vignettes de l'une des manières suivantes :
• Définir le nombre maximal de vignettes à afficher
• Ajouter un attribut supplémentaire
Vignettes génériques est une configuration générique prédéfinie disponible pour le composant Vignettes.
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. Exemple de JSON : { "version":"1.0.0", "data":[ { "adapter":{ "thingName":"PTC.WCAdapter", "instanceName":"windchill" }, "itemListsData":[ { "objectType":"PTC.ChangeMgmt.ChangeRequest", "items":[ { "id":{ "value":"OR:wt.change2.WTChangeRequest2:439476" } } ] } ] } ] } | JSON au format CCO |
TailoringName | Identifie de manière unique une instance du composant Vignettes. 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. | Chaîne |
Propriétés de configuration
Les tableaux ci-après présentent les propriétés JSON utilisées 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 ? | ||
|---|---|---|---|---|---|---|
attributes | Noms de propriété pour lesquels des données sont attendues de la part du système principal. Ces attributs peuvent être récupérés à partir du système principal ou supplémentaires. | N/A | Obligatoire | |||
maxTileCount | Nombre maximal d'attributs à afficher sous forme de vignettes. En l'absence de valeur, le nombre de vignettes affichées n'est pas limité. | N/A | Facultatif | |||
Exemples de configurations
Pour obtenir un exemple de configuration pour le composant Vignettes, consultez la rubrique sur la configuration Vignettes génériques.
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.
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 |
ProcessAttributesConfiguration | Traite la configuration des attributs et divise ces derniers en attributs standard et attributs supplémentaires. Renvoie un JSON avec des paires de valeurs clés sous la forme suivante : • OOTBAttributes : OOTB Attributes configuration CCO JSON • additionalAttributes : Additional Attributes configuration CCO JSON Les attributs sont divisés en ceux standard et supplémentaires en fonction de leur type d'objet. Les attributs dont le type d'objet se termine par .Custom.Adapter ou Custom.Implementation sont traités comme des attributs supplémentaires. Tous les autres attributs sont considérés comme des attributs standard. Paramètres : attributes (obligatoire) : JSON avec la liste des attributs standard et supplémentaires. configuration (facultatif) : JSON avec la configuration fusionnée finale obtenue à partir de la ressource de gestionnaire de personnalisations. Renvois : JSON au format CCO |
GetAttributesValues | Renvoie un JSON avec les attributs et leurs valeurs. Paramètres : input (obligatoire) : 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 (facultatif) : JSON avec la configuration fusionnée finale obtenue à partir de la ressource de gestionnaire de personnalisations. attributes (obligatoire) : JSON avec la liste des attributs standard et supplémentaires. Renvois : JSON au format CCO |
GetAdditionalAttributesValues | Renvoie un JSON avec les valeurs des attributs supplémentaires. Ce service doit être mis en oeuvre par l'implémentation du composant. Paramètres : input (obligatoire) : 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 (facultatif) : JSON avec la configuration fusionnée finale obtenue à partir de la ressource de gestionnaire de personnalisations. attributes (obligatoire) : JSON avec la liste des attributs supplémentaires. OOTBAttributesValues (facultatif) : JSON au format CCO avec renvoi des valeurs des attributs standard par GetAttributesValues.Ces valeurs peuvent être utilisées pour calculer les valeurs des attributs supplémentaires. Renvois : JSON au format CCO |
GetAdditionalAttributes | Renvoie la liste des attributs supplémentaires à ajouter à la liste des attributs standard disponibles. Paramètres : aucun Renvois : JSON |
Définition de l'implémentation
Pour la définition d'implémentation du composant Vignettes, consultez la rubrique sur la configuration Vignettes génériques.