Struttura documento
Struttura documento è una configurazione predefinita del componente Elenco elementi. Struttura documento contiene un albero struttura che visualizza la relazione gerarchica tra un documento e i relativi discendenti. Per ogni elemento nell'albero, Struttura documento visualizza gli attributi che è possibile scegliere tramite configurazione. Gli attributi di default sono Numero, Nome e Stato del ciclo di vita.
È possibile configurare Struttura documento per impostare il livello di espansione iniziale dell'albero. Per default, il livello di espansione iniziale è impostato su 3. Gli utenti possono espandere e comprimere gli elementi nell'albero.
L'albero Struttura documento include i rientri nella colonna all'estrema sinistra per visualizzare visivamente il livello della struttura. Per default, la prima colonna della tabella è Numero. È possibile definire l'ordine di tutte le colonne, ad eccezione di Numero, tramite configurazione.
Struttura documento non supporta l'esportazione dei dati dell'albero.
Di seguito è riportata un'immagine di esempio che mostra la configurazione predefinita Struttura documento:
Componente Struttura documento nell'interfaccia utente di Navigate
* 
Se un utente che visualizza un albero struttura non dispone dei diritti di accesso per un elemento nella struttura, tale elemento non viene visualizzato e viene mostrato il seguente messaggio: "Alcuni elementi sono nascosti perché non disponi dei relativi diritti di accesso".
Proprietà di associazione 
Per informazioni sull'associazione di Struttura documento, vedere il componente Elenco elementi.
* 
Per Struttura documento, la proprietà di associazione di input supporta il tipo di oggetto PTC.DocMgmt.Document.
L'output della proprietà di associazione selectedItems contiene elementi con il tipo di oggetto PTC.DocMgmt.DocStructure.
Proprietà di configurazione 
Per un elenco di tutte le proprietà di configurazione disponibili per Struttura documento, vedere la tabella Proprietà di configurazione per il componente Elenco elementi. Nella tabella riportata di seguito vengono fornite informazioni aggiuntive specifiche di Struttura documento relative alle proprietà di configurazione.
Per ulteriori informazioni sulla struttura della configurazione, vedere Struttura di configurazione del componente.
Per ulteriori informazioni sulle sottoproprietà, vedere Sottoproprietà e chiavi contenitore.
Nome proprietà
Descrizione
Tipo di proprietà
Valore di default
Obbligatoria o facoltativa
attributes
Per ulteriori informazioni, vedere Elenco elementi.
Accetta gli attributi del tipo di oggetto PTC.DocMgmt.DocStructure.
Accetta inoltre l'attributo DefaultPDFRepresentation, che è del tipo di oggetto PTC.DocMgmt.DocStructure:PTC.Visualization.Representation.Custom.Adapter. Quando l'attributo DefaultPDFRepresentation è incluso nella configurazione, l'albero Struttura documento include una colonna Rappresentazione. La colonna Rappresentazione contiene un link per visualizzare la rappresentazione per ogni documento che ne ha una disponibile.
Per default, l'albero Struttura documento viene ordinato in base al primo attributo, ovvero l'attributo con il valore ordinale non negativo più basso.
N/D
Obbligatoria
Configurazione di esempio 
{
"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"
}
}
Servizi di personalizzazione 
Oltre alla configurazione, ogni componente supporta l'estensione della logica aziendale per personalizzare il componente. La logica aziendale di ciascun componente include servizi ignorabili in un modello di oggetto che è possibile estendere e sostituire. I servizi ignorabili per questo componente sono descritti in dettaglio nella tabella seguente.
Per esempi di elementi restituiti e parametri per ogni servizio, vedere Esempi di input/output per i servizi di personalizzazione.
Nome
Descrizione
DefHookAttributesTypesInfo
Restituisce una matrice JSON contenente le informazioni sull'adattatore e i tipi di oggetto degli attributi supportati da Struttura documento.
Parametri: nessuno
Restituisce: matrice JSON
GetConfigurations
Restituisce le configurazioni disponibili per Struttura documento.
Parametri: nessuno
Restituisce: JSON
GetImplementationSettings
Restituisce i dati delle impostazioni di implementazione di Struttura documento. Le implementazioni possono sostituire questo servizio per fornire le proprie impostazioni. Per ulteriori informazioni, vedere l'argomento Informazioni aggiuntive sul servizio GetImplementationSettings per Elenco elementi.
Parametri: nessuno
Restituisce: oggetto JSON
GetItems
Restituisce la struttura per il documento specificato nell'input.
Parametri:
input (obbligatorio) - JSON in formato CCO che include l'ID input per i dati da recuperare dal sistema di back-end e le informazioni sull'adattatore per il sistema di back-end.
configuration (obbligatorio) - JSON con la configurazione unita finale ottenuta dalla risorsa per la gestione delle personalizzazioni.
Restituisce: JSON in formato CCO
MapItemToInputObject
Mappa un elemento di struttura documento a un input di documento che può essere quindi utilizzato dal servizio GetItems.
Parametri:
input (facoltativo) - JSON in formato CCO che include l'ID input per il documento alla radice della struttura.
item (obbligatorio) - JSON che include il documento da mappare.
Restituisce: JSON in formato CCO con un singolo documento contenente solo l'attributo id.
Definizione di implementazione 
{
"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"
}
]
}
È stato utile?