Structure du document
Structure du document est une configuration prédéfinie du composant Liste des éléments. Structure du document contient une structure arborescente qui affiche la relation hiérarchique entre un document et ses descendants. Pour chaque élément de l'arborescence, Structure du document présente les attributs que vous pouvez choisir via la configuration. Les attributs par défaut sont Numéro, Nom et Etat.
Vous pouvez configurer Structure du document de manière à définir le niveau de développement initial de l'arborescence. Par défaut, le niveau de développement initial est défini sur 3. Les utilisateurs peuvent développer et réduire les éléments de l'arborescence.
L'arborescence de Structure du document applique une mise en retrait dans la colonne la plus à gauche pour indiquer visuellement le niveau de la structure. Par défaut, la première colonne du tableau est Numéro. Pour toutes les colonnes à l'exception de Numéro, vous pouvez définir l'ordre des colonnes à l'aide de la configuration.
Structure du document ne prend pas en charge l'exportation des données d'arborescence.
La capture d'écran suivante vous donne un aperçu de la configuration prédéfinie Structure du document :
Composant Structure du document dans l'interface utilisateur Navigate
* 
Si l'utilisateur visualisant la structure arborescente ne dispose pas des droits d'accès à un élément de la structure, cet élément n'est pas visible et le message suivant s'affiche : "Certains éléments sont masqués car vous ne disposez pas des droits suffisants pour les afficher."
Propriétés de liaison 
Pour plus d'informations sur la liaison de Structure du document, consultez la rubrique relative au composant Liste des éléments.
* 
Pour Structure du document, la propriété de liaison d'entrée prend en charge le type d'objet PTC.DocMgmt.Document.
La sortie de la propriété de liaison selectedItems contient des éléments avec le type d'objet PTC.DocMgmt.DocStructure.
Propriétés de configuration 
Pour obtenir la liste de toutes les propriétés de configuration disponibles pour la Structure du document, consultez le tableau Propriétés de configuration du composant Liste des éléments. Le tableau suivant fournit des informations supplémentaires spécifiques à la Structure du document concernant les propriétés de configuration.
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 propriété
Description
Type de propriété
Valeur par défaut
Obligatoire ou facultatif ?
attributes
Pour plus d'informations, consultez la rubrique Liste des éléments.
Accepte les attributs du type d'objet PTC.DocMgmt.DocStructure.
En outre, accepte l'attribut DefaultPDFRepresentation, qui présente le type d'objet PTC.DocMgmt.DocStructure:PTC.Visualization.Representation.Custom.Adapter. Lorsque l'attribut DefaultPDFRepresentation est inclus dans la configuration, l'arborescence de Structure du document inclut une colonne Représentation. La colonne Représentation contient un lien permettant d'afficher la représentation de chaque document, si celle-ci est disponible.
Par défaut, l'arborescence de Structure du document est triée selon le premier attribut, c'est-à-dire selon l'attribut qui présente la valeur ordinale non négative la plus faible.
N/A
Obligatoire
Exemple de configuration 
{
"attributes":{
"inTailoring":true,
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":"DefaultPDFRepresentation",
"ordinal":3
}
],
"objectType":"PTC.DocMgmt.DocStructure:PTC.Visualization.Representation.Custom.Adapter"
},
{
"items":[
{
"id":"Document|Number",
"ordinal":0
},
{
"id":"Document|Name",
"ordinal":1
},
{
"id":"Document|State#Display",
"ordinal":2
}
],
"objectType":"PTC.DocMgmt.DocStructure"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
]
}
},
"defaultExpansionLevel":{
"selectedKey":[
"3"
]
},
"enableSearch":{
"value":false
},
"label":{
"value":""
},
"selectionType":{
"selectedKey":"single"
},
"showExportAction":{
"value":false
},
"waitForInput":{
"value":true
},
"baseConfigurationVersion":{
"value":"nav.3"
},
"implementationConfigurationVersion":{
"value":"nav.1"
}
}
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
DefHookAttributesTypesInfo
Renvoie un tableau JSON contenant les informations sur l'adaptateur et les types d'objets des attributs pris en charge par Structure du document.
Paramètres : aucun
Renvois : tableau JSON
GetConfigurations
Renvoie les configurations disponibles pour Structure du document.
Paramètres : aucun
Renvois : JSON
GetImplementationSettings
Renvoie les données des paramètres de l'implémentation de Structure du document. Les implémentations peuvent remplacer ce service afin de fournir leurs propres paramètres. Pour plus d'informations, consultez la rubrique Informations supplémentaires sur le service GetImplementationSettings pour la liste des éléments.
Paramètres : aucun
Renvois : objet JSON
GetItems
Renvoie la structure du document spécifié dans l'entrée.
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 (obligatoire) : JSON avec la configuration fusionnée finale obtenue à partir de la ressource de gestionnaire de personnalisations.
Renvois : JSON au format CCO
MapItemToInputObject
Mappe un élément de structure de document sur une entrée de document, qui peut ensuite être utilisée par le service GetItems.
Paramètres :
input (facultatif) : JSON au format CCO incluant l'ID d'entrée du document à la racine de la structure.
item (obligatoire) : JSON incluant le document à mapper.
Renvois : JSON au format CCO avec un seul document contenant uniquement l'attribut id.
Définition de l'implémentation 
{
"array": [
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"directDefinition": [
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Textbox"
},
"mandatory": false,
"key": "actionBarConfigurationJSON"
}
]
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.DefinitionGroup"
},
"mandatory": false,
"key": "actionBarConfiguration"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"additionalDefinition": [
{
"directDefinition": [
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Textbox"
},
"mandatory": false,
"key": "fieldTitleOverride"
}
],
"key": "itemListAttributesDefinition"
},
{
"directDefinition": [],
"key": "implementationAttributesDefinition"
}
],
"updateServiceName": "",
"minimumSelectedAttributes": null,
"supportedTypes": {
"data": [
{
"itemListsData": [
{
"selectionGroupIds": [
"PSI"
],
"objectType": "PTC.DocMgmt.DocStructure"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring": false
},
"addServiceName": "",
"maximumSelectedAttributes": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.AttributesSelector"
},
"mandatory": true,
"key": "attributes"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"options": [
{
"label": "1",
"key": "1"
},
{
"label": "2",
"key": "2"
},
{
"label": "3",
"key": "3"
},
{
"label": "4",
"key": "4"
},
{
"label": "5",
"key": "5"
},
{
"label": "6",
"key": "6"
},
{
"label": "7",
"key": "7"
},
{
"label": "8",
"key": "8"
},
{
"label": "9",
"key": "9"
},
{
"label": "-1",
"key": "-1"
}
],
"updateServiceName": null,
"addServiceName": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Dropdown"
},
"mandatory": false,
"key": "defaultExpansionLevel"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"additionalDefinition": [
{
"directDefinition": [
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"options": [
{
"description": "Sort column in ascending order",
"label": "[[PTC.Nav.ItemList.SortOrder.Asc]]",
"key": "asc"
},
{
"description": "Sort column in descending order",
"label": "[[PTC.Nav.ItemList.SortOrder.Dsc]]",
"key": "dsc"
}
],
"updateServiceName": null,
"addServiceName": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.RadioButton"
},
"mandatory": false,
"key": "defaultSortDirection"
}
],
"key": "itemListDefaultSortFieldDefinition"
}
],
"updateServiceName": "",
"minimumSelectedAttributes": null,
"supportedTypes": {
"data": [
{
"itemListsData": [
{
"selectionGroupIds": [
"PSI"
],
"objectType": "PTC.DocMgmt.DocStructure"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring": false
},
"addServiceName": "",
"maximumSelectedAttributes": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.AttributesSelector"
},
"mandatory": false,
"key": "defaultSortFields"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"default": true,
"true": {
"additionalDefinition": [
{
"directDefinition": [
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Textbox"
},
"mandatory": false,
"key": "searchHintText"
}
],
"key": "itemListSearchDefinition"
}
],
"label": "[[PTC.Nav.Yes]]"
},
"false": {
"additionalDefinition": [],
"label": "[[PTC.Nav.No]]"
}
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": false,
"key": "enableSearch"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"additionalDefinition": [
{
"directDefinition": [
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"dynamicallySetTypeServiceName": "GetFilterTypeDefinitionForFilterField",
"type": {
"enum": {
"options": [],
"updateServiceName": null,
"dynamicallySetOptionsServiceName": null,
"addServiceName": null,
"multiSelect": null
}
}
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.FieldFilter"
},
"mandatory": false,
"key": "defaultSelectedFilterValues"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Textbox"
},
"mandatory": false,
"key": "filterLabelOverride"
}
],
"key": "itemListFilterFieldDefinition"
}
],
"updateServiceName": "",
"minimumSelectedAttributes": 0,
"supportedTypes": {
"data": [
{
"itemListsData": [
{
"selectionGroupIds": [
"PSI"
],
"objectType": "PTC.DocMgmt.DocStructure"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring": false
},
"addServiceName": "",
"maximumSelectedAttributes": 1
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.AttributesSelector"
},
"mandatory": false,
"key": "filterFields"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.DefinitionGroup"
},
"mandatory": false,
"key": "implementationConfiguration"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Textbox"
},
"mandatory": false,
"key": "label"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"minValue": 50,
"default": 500,
"maxValue": 10000,
"step": 50
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Number"
},
"mandatory": false,
"key": "maxNumberOfRowsInGrid"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"options": [
{
"description": "Disallow items selection",
"label": "[[PTC.Nav.ItemList.SelectionType.None]]",
"key": "none"
},
{
"description": "Allow single item selection",
"label": "[[PTC.Nav.ItemList.SelectionType.Single]]",
"key": "single"
},
{
"description": "Allow multiple items selection",
"label": "[[PTC.Nav.ItemList.SelectionType.Multiple]]",
"key": "multi"
}
],
"updateServiceName": null,
"addServiceName": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.RadioButton"
},
"mandatory": false,
"key": "selectionType"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"default": true,
"true": {
"additionalDefinition": [
{
"directDefinition": [
{
"property": {
"options": [
[
{
"label": "[[PTC.Nav.ItemList.ExportCSVActionLabel]]",
"key": "exportToCsv"
},
{
"label": "[[PTC.Nav.ItemList.ExportCSVAsExcelActionLabel]]",
"key": "exportToExcel"
}
]
]
},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"default": "",
"overflow": null,
"minimumSelectedItems": null,
"options": [],
"updateServiceName": null,
"addServiceName": null,
"constraints": {}
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.CheckboxArray"
},
"mandatory": false,
"key": "exportTypes"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"default": false,
"true": {
"additionalDefinition": [],
"label": null
},
"false": {
"additionalDefinition": [],
"label": null
}
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": false,
"key": "exportUnFilteredData"
}
],
"key": "itemListExportDefinition"
}
],
"label": "[[PTC.Nav.Yes]]"
},
"false": {
"additionalDefinition": [],
"label": "[[PTC.Nav.No]]"
}
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": false,
"key": "showExportAction"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"default": "alphanumeric",
"options": [
{
"description": "Alphanumeric sort order",
"label": "[[PTC.Nav.ItemList.SortOrder.Alphanumeric]]",
"key": "alphanumeric"
},
{
"description": "Natural sort order",
"label": "[[PTC.Nav.ItemList.SortOrder.Natural]]",
"key": "natural"
}
],
"updateServiceName": null,
"addServiceName": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.RadioButton"
},
"mandatory": false,
"key": "sortOrder"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"default": false,
"true": {
"additionalDefinition": [],
"label": "[[PTC.Nav.Yes]]"
},
"false": {
"additionalDefinition": [],
"label": "[[PTC.Nav.No]]"
}
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": false,
"key": "waitForInput"
}
]
}
Est-ce que cela a été utile ?