Структура документа
"Структура документа" - это предопределенная конфигурация компонента "Список элементов". Структура документа содержит дерево структуры, отображающее иерархическую взаимосвязь между документом и его потомками. Для каждого элемента в дереве структура документа отображает атрибуты, которые можно выбрать в данной конфигурации. Атрибуты по умолчанию: "Обозначение", "Наименование" и "Состояние".
Можно сконфигурировать структуру документа, чтобы задать начальный уровень развертывания дерева. По умолчанию для начального уровня развертывания задано значение 3. Пользователи могут развертывать и свертываться элементы в дереве.
Дерево структуры документов содержит отступ в крайнем левом столбце для визуального отображения уровня структуры. По умолчанию первым столбцом в таблице является "Обозначение". Для всех столбцов, кроме столбца "Обозначение", можно определить в конфигурации их порядок.
Структура документа не поддерживает экспорт данных дерева.
На приведенном ниже изображении показана предопределенная конфигурация структуры документа.
Компонент "Структура документа" в интерфейсе пользователя Navigate
* 
Если у пользователя, просматривающего дерево структуры, нет прав доступа к какому-либо элементу в структуре, этот элемент не отображается, а отображается следующее сообщение: "Некоторые элементы скрыты, потому что у вас нет прав доступа к ним".
Свойства привязки 
Дополнительные сведения о привязке структуры документа см. в разделе компонента Список элементов.
* 
Для структуры документа свойство привязки входных данных поддерживает тип объекта PTC.DocMgmt.Document.
Выход свойства привязки selectedItems содержит элементы с типом объекта PTC.DocMgmt.DocStructure.
Свойства конфигурации 
Список всех доступных свойств конфигурации для "Структуры документа" см. в таблице свойства конфигурации для компонента Список элементов. В следующей таблице приведена дополнительная информация о свойствах конфигурации, специфичная для "Структуры документа".
Дополнительные сведения о структуре конфигурации см. в разделе Структура конфигурации компонента.
Дополнительные сведения о подсвойствах см. в разделе Подсвойства и ключи контейнера.
Имя свойства
Описание
Тип свойства
Значение по умолчанию
Обязательное или необязательное
attributes
Дополнительные сведения см. в разделе Список элементов.
Принимает атрибуты с типом объекта PTC.DocMgmt.DocStructure.
Кроме того, принимается атрибут DefaultPDFRepresentation, имеющий тип объекта PTC.DocMgmt.DocStructure:PTC.Visualization.Representation.Custom.Adapter. Если в данную конфигурацию включен атрибут DefaultPDFRepresentation, то дерево структуры документа содержит столбец Представление. Столбец Представление содержит ссылку для просмотра представления каждого документа, имеющего доступное представление.
По умолчанию дерево структуры документа сортируется по первому атрибуту, т. е. атрибуту с наименьшим неотрицательным значением порядкового номера.
Н/Д
Обязательное
Пример конфигурации 
{
"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"
}
}
Сервисы настройки 
В дополнение к конфигурации каждый компонент поддерживает расширение бизнес-логики для настройки компонента. Бизнес-логика каждого компонента включает в себя переопределяемые сервисы в шаблоне вещи, которые можно расширять и переопределять. Переопределяемые сервисы для этого компонента подробно описаны в следующей таблице.
Примеры возвращаемых значений и параметров для каждого сервиса приведены в разделе Примеры ввода/вывода для сервисов настройки.
Наименование
Описание
DefHookAttributesTypesInfo
Возвращает JSON-массив, содержащий информацию об адаптере и типы объектов атрибутов, поддерживаемые компонентом "Структура документа".
Параметры: нет
Возвращает: JSON-массив
GetConfigurations
Возвращает доступные конфигурации для структуры документа.
Параметры: нет
Возвращает: JSON
GetImplementationSettings
Возвращает данные настроек реализации структуры документа. Реализации могут переопределять этот сервис, чтобы предоставить свои собственные настройки. Дополнительные сведения см. в разделе Дополнительная информация о сервисе GetImplementationSettings для списка элементов.
Параметры: нет
Возвращает: объект JSON.
GetItems
Возвращает структуру для документа, указанного во входных данных.
Параметры:
input (обязательный) - JSON в формате CCO, содержащий идентификатор входных данных, которые нужно вызвать из серверной системы, и информацию об адаптере для серверной системы.
configuration (обязательный) - JSON с окончательной объединенной конфигурацией, полученной из ресурса диспетчера настройки.
Возвращает: JSON в формате CCO
MapItemToInputObject
Сопоставляет элемент структуры документа с входными данными документа, которые затем могут использоваться сервисом GetItems.
Параметры:
input (необязательно) - JSON в формате CCO, который включает идентификатор входных данных для документа в корне структуры.
item (обязательно) - JSON, который включает документ для сопоставления.
Возвращает: JSON в формате CCO с одним документом, содержащим только атрибут id.
Определение реализации 
{
"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"
}
]
}
Было ли это полезно?