Estructura de documentos
Estructura de documento es una configuración predefinida del componente Lista de elementos. Estructura de documento contiene un árbol de estructura en el que se muestra la relación jerárquica entre un documento y sus descendientes. En Estructura de documento se muestran, para cada elemento del árbol, los atributos que se pueden elegir mediante la configuración. Los atributos por defecto son Número, Nombre y Estado.
Puede configurar Estructura de documento para definir el nivel de expansión inicial del árbol. Por defecto, el nivel de expansión inicial está definido en 3. Los usuarios pueden expandir y contraer elementos en el árbol.
En el árbol de estructura de documento se incluye sangría en la columna del extremo izquierdo para mostrar visualmente el nivel de estructura. Por defecto, la primera columna de la tabla es Número. Para todas las columnas excepto Número, se puede definir el orden de las columnas mediante la configuración.
Estructura de documento no soporta la exportación de datos del árbol.
A continuación, se presenta una imagen de ejemplo en la que se muestra la configuración predefinida de Estructura de documento:
Componente Estructura de documento en la interfaz de usuario de Navigate
* 
Si un usuario que visualiza un árbol de estructura no tiene derechos de acceso para un elemento de la estructura, dicho elemento no se muestra y se muestra el siguiente mensaje: "Algunos elementos están ocultos porque no tiene derechos de acceso para ellos".
Propiedades de enlace 
Para obtener información sobre cómo enlazar Estructura de documento, consulte el componente Lista de elementos.
* 
Para Estructura de documento, la propiedad de enlace de entrada soporta el tipo de objeto PTC.DocMgmt.Document.
La salida de la propiedad de enlace selectedItems contiene elementos con el tipo de objeto PTC.DocMgmt.DocStructure.
Propiedades de configuración 
Para obtener una lista de todas las propiedades de configuración disponibles para Estructura de documento, consulte la tabla Propiedades de configuración del componente Lista de elementos. En la siguiente tabla se proporciona información adicional específica de Estructura de documento en relación con las propiedades de configuración.
Para obtener más información sobre la estructura de la configuración, consulte Estructura de configuración de componentes.
Para obtener más información sobre las subpropiedades, consulte Subpropiedades y claves de contenedor.
Nombre de la propiedad
Descripción
Tipo de propiedad
Valor por defecto
Obligatorio u opcional
attributes
Consulte Lista de elementos para obtener más información.
Acepta los atributos del tipo de objeto PTC.DocMgmt.DocStructure.
Además, acepta el atributo DefaultPDFRepresentation, que es del tipo de objeto PTC.DocMgmt.DocStructure:PTC.Visualization.Representation.Custom.Adapter. Cuando el atributo DefaultPDFRepresentation se incluye en la configuración, en el árbol de Estructura de documento se incluye una columna Representación. En la columna Representación se incluye un vínculo para ver la representación de cada documento que tiene uno disponible.
Por defecto, el árbol de Estructura de documento se clasifica según el primer atributo, lo que significa el atributo con el valor ordinal no negativo más bajo.
N/D
Obligatorio
Configuración de ejemplo 
{
"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"
}
}
Servicios de personalización 
Además de la configuración, cada componente soporta la extensión de la lógica empresarial para personalizar el componente. En la lógica empresarial de cada componente se incluyen los servicios desestimables en una plantilla de cosa que se pueden extender y sustituir. En la tabla siguiente se describen los servicios desestimables de este componente.
Para obtener ejemplos de las devoluciones y los parámetros de cada servicio, consulte Ejemplos de entrada/salida para servicios de personalización.
Nombre
Descripción
DefHookAttributesTypesInfo
Devuelve una matriz de JSON que contiene la información del adaptador y los tipos de objeto de los atributos soportados por Estructura de documento.
Parámetros: ninguno
Devuelve: matriz JSON
GetConfigurations
Devuelve las configuraciones disponibles para Estructura de documento.
Parámetros: ninguno
Devuelve: JSON
GetImplementationSettings
Devuelve los datos de configuración de la implementación de Estructura de documento. Las implementaciones pueden sustituir este servicio para proporcionar su propia configuración. Para obtener más información, consulte el tema Información adicional sobre el servicio GetImplementationSettings para lista de elementos.
Parámetros: ninguno
Devuelve: objeto JSON
GetItems
Devuelve la estructura del documento especificado en la entrada.
Parámetros:
input (obligatorio): JSON en formato CCO en el que se incluye el ID de entrada de los datos que se van a extraer del sistema back-end y la información del adaptador para el sistema back-end.
configuration (obligatorio): JSON con la configuración combinada final obtenida del recurso del administrador de personalización.
Devuelve: JSON en formato CCO
MapItemToInputObject
Permite asignar un elemento de estructura de documento a un documento de entrada, que el servicio GetItems puede utilizar posteriormente.
Parámetros:
input (opcional): JSON en formato CCO que incluye el ID de entrada del documento en la raíz de la estructura.
item (Obligatorio): JSON en el que se incluye el documento que se debe asignar.
Devuelve: JSON en formato CCO con un único documento que solo contiene el atributo id.
Definición de implementación 
{
"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"
}
]
}
¿Fue esto útil?