Attributs
Définition et mode d'utilisation
Le composant Attributs est un widget qui affiche les paires nom-valeur. La valeur apparaît toujours sous le nom. Vous pouvez afficher les valeurs des différents types de données. Un jeu d'attributs peut être présenté sous la forme d'un groupe à l'aide d'un nom de groupe.
Voici quelques exemples d'illustration du composant Attributs :
Vous pouvez configurer le composant Attributs de l'une des manières suivantes :
• Définir les attributs à afficher
• Définir la mise en page et les paramètres d'affichage associés
• Définir le titre d'un groupe d'attributs. Cette fonction n'est disponible que pour les groupes d'attributs avec une mise en page verticale
Attributs générique est une configuration générique prédéfinie disponible pour le composant Attributs.
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 Attributs. 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 |
SubComponentConfiguration | Liez la configuration à cette propriété lorsque ce composant est utilisé en tant que sous-composant dans un autre composant ou dans une application composite contenue. Exemple de JSON : { "implementationThingName":"PTC.Nav.AttributesGenericBusinessLogicThing", "configuration":{ "layout":{ "selectedKey":"horizontal", "additionalData":{ }, "version":"1.0.0" }, "attributes":{ "sets":[ { "data":{ "selectedValues":{ "data":[ { "itemListsData":[ { "items":[ { "id":"Role#Display", "ordinal":0 }, { "id":"Activity|Deadline", "ordinal":5 }, { "id":"Status#Display", "ordinal":4 } ], "objectType":"PTC.Workflow.WorkItem" }, { "items":[ { "id":"Category#Display", "ordinal":1 }, { "id":"RequestPriority#Display", "ordinal":3 } ], "objectType":"PTC.ChangeMgmt.ChangeRequest" } ], "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" } } ] } } } ] } } } | JSON |
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 | La liste des attributs pour lesquels des données doivent être récupérées à partir du système principal. Pour Windchill, ces noms de propriété doivent correspondre à ceux définis par l'EDM des services REST Windchill. | N/A | Obligatoire | ||
isMultiLine | Détermine si le contenu doit être renvoyé à la ligne. Options : true, false. Cette propriété est une sous-propriété de layout et est uniquement pertinente lorsque layout est défini sur vertical. Sa clé de conteneur est isMultilineDefinition. | N/A | Obligatoire | ||
layout | Détermine la façon dont les attributs sont organisés dans l'interface utilisateur. Les options disponibles sont les suivantes : • vertical : les attributs sont empilés l'un en dessous de l'autre. • horizontal : les attributs sont disposés côte à côte. Les sous-propriétés disponibles pour layout dépendent du fait que vertical ou horizontal soit sélectionné. Pour plus de détails, consultez les exemples de configuration présentés à la rubrique Attributs générique. | N/A | Obligatoire | ||
maxHeight | La hauteur maximale pour le nom de l'attribut et sa valeur dans l'interface utilisateur. Si le contenu dépasse la valeur de la propriété maxHeight, le lien ou le bouton "afficher plus/afficher moins" est disponible. Cette propriété n'est pertinente que dans les deux cas suivants : • Lorsque layout est défini sur horizontal. Dans ce cas, il s'agit d'une sous-propriété de layout. • Lorsque layout est défini sur vertical et isMultiLine est défini sur true. Dans ce cas, il s'agit d'une sous-propriété de isMultiLine. Sa clé de conteneur est dimensionDefinition. | N/A | Obligatoire | ||
maxWidth | La largeur maximale pour le nom de l'attribut et sa valeur dans l'interface utilisateur. Cette propriété n'est pertinente que dans les deux cas suivants : • Lorsque layout est défini sur horizontal. Dans ce cas, il s'agit d'une sous-propriété de layout. • Lorsque layout est défini sur vertical et isMultiLine est défini sur false. Dans ce cas, il s'agit d'une sous-propriété de isMultiLine. Sa clé de conteneur est dimensionDefinition. | N/A | Obligatoire | ||
Exemple de configuration
Pour obtenir un exemple de configuration pour le composant Attributs, consultez la rubrique sur la configuration Attributs générique.
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 des 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 |
UpdateAvailableAttributes | Met à jour un ou plusieurs attributs de la liste des attributs et renvoie la liste finale. Paramètres : attributes (obligatoire) : JSON avec la liste des attributs standard et supplémentaires. Renvois : JSON |
Définition de l'implémentation
Pour la définition d'implémentation du composant Attributs, consultez la rubrique sur la configuration Attributs générique.