Реквизиты документа
Реквизиты документа - это предопределенная конфигурация компонента "Реквизиты элемента", которая отображается на панели, содержащей базовую информацию о документе. Панель содержит основные и дополнительные заголовки, изображение, дополнительный значок и атрибуты реквизитов. Дополнительный значок обозначает тип документа; при этом используется значок из Windchill для этого типа документа. На панели доступны следующие атрибуты по умолчанию: версия, состояние, последнее изменение и контекст. Для конфигурации "Реквизиты документа" также отображаются действия Открыть документ, Сообщить о проблеме и Показать в Windchill
На приведенном ниже изображении показана предопределенная конфигурация реквизитов документа:
Свойства привязки
Дополнительные сведения о привязке реквизитов документа см. в разделе компонента Реквизиты элемента.
 | Для реквизитов документа входное свойство привязки поддерживает тип объекта PTC.DocMgmt.Document. |
Свойства конфигурации
Список всех доступных свойств конфигурации для "Реквизитов документа" см. в таблице свойств конфигурации для компонента Реквизиты элемента. В следующей таблице приведена дополнительная информация о свойствах конфигурации, специфичная для "Реквизитов документа".
Дополнительные сведения о структуре конфигурации см. в разделе Структура конфигурации компонента.
Дополнительные сведения о подсвойствах см. в разделе Подсвойства и ключи контейнера.
Имя свойства | Описание | Тип свойства | Значение по умолчанию | Обязательное или необязательное | |
|---|---|---|---|---|---|
primaryTitle | Дополнительные сведения см. в разделе Реквизиты элемента. Принимает атрибуты с типом объекта PTC.DocMgmt.Document. | Н/Д | Обязательное | ||
secondaryTitle | Дополнительные сведения см. в разделе Реквизиты элемента. Принимает атрибуты с типом объекта PTC.DocMgmt.Document. | Н/Д | Обязательное | ||
attributes | Дополнительные сведения см. в разделе Реквизиты элемента. Принимает атрибуты с типом объекта PTC.DocMgmt.Document. | Н/Д | Обязательное | ||
Пример конфигурации
{
"primaryTitle":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"numericIdentifier":1,
"id":"Number"
},
{
"numericIdentifier":2,
"id":"Name"
}
],
"objectType":"PTC.DocMgmt.Document"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
]
},
"pattern":"%1, %2",
"filteredValues":{
"data":[
{
"itemListsData":[
{
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"expanded":{
"version":"1.0.0",
"value":true
},
"actionBarConfiguration":{
"value":{
}
},
"showSecondaryIcon":{
"version":"1.0.0",
"value":true
},
"secondaryTitle":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"numericIdentifier":1,
"id":"DocTypeName"
}
],
"objectType":"PTC.DocMgmt.Document"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
]
},
"pattern":"%1",
"filteredValues":{
"data":[
{
"itemListsData":[
{
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"attributes":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":"Version",
"ordinal":0
},
{
"id":"State#Display",
"ordinal":1
},
{
"id":"LastModified",
"ordinal":2
},
{
"id":"Context|Name",
"ordinal":3
}
],
"objectType":"PTC.DocMgmt.Document"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
]
},
"inTailoring":true,
"filteredValues":{
"data":[
{
"itemListsData":[
{
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"showImage":{
"version":"1.0.0",
"value":true,
"additionalData":{
"itemIdentityShowImageDefinition":{
"defaultImagePath":{
"value":"/Thingworx/MediaEntities/PTC.Nav.BigDocumentThumbnail"
}
}
}
},
"enableExpandCollapse":{
"version":"1.0.0",
"value":true
},
"baseConfigurationVersion":{
"value":"nav.1"
},
"implementationConfigurationVersion":{
"value":"nav.1"
}
}
"primaryTitle":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"numericIdentifier":1,
"id":"Number"
},
{
"numericIdentifier":2,
"id":"Name"
}
],
"objectType":"PTC.DocMgmt.Document"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
]
},
"pattern":"%1, %2",
"filteredValues":{
"data":[
{
"itemListsData":[
{
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"expanded":{
"version":"1.0.0",
"value":true
},
"actionBarConfiguration":{
"value":{
}
},
"showSecondaryIcon":{
"version":"1.0.0",
"value":true
},
"secondaryTitle":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"numericIdentifier":1,
"id":"DocTypeName"
}
],
"objectType":"PTC.DocMgmt.Document"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
]
},
"pattern":"%1",
"filteredValues":{
"data":[
{
"itemListsData":[
{
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"attributes":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":"Version",
"ordinal":0
},
{
"id":"State#Display",
"ordinal":1
},
{
"id":"LastModified",
"ordinal":2
},
{
"id":"Context|Name",
"ordinal":3
}
],
"objectType":"PTC.DocMgmt.Document"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
]
},
"inTailoring":true,
"filteredValues":{
"data":[
{
"itemListsData":[
{
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"showImage":{
"version":"1.0.0",
"value":true,
"additionalData":{
"itemIdentityShowImageDefinition":{
"defaultImagePath":{
"value":"/Thingworx/MediaEntities/PTC.Nav.BigDocumentThumbnail"
}
}
}
},
"enableExpandCollapse":{
"version":"1.0.0",
"value":true
},
"baseConfigurationVersion":{
"value":"nav.1"
},
"implementationConfigurationVersion":{
"value":"nav.1"
}
}
Сервисы настройки
В дополнение к конфигурации каждый компонент поддерживает расширение бизнес-логики для настройки компонента. Бизнес-логика каждого компонента включает в себя переопределяемые сервисы в шаблоне вещи, которые можно расширять и переопределять. Переопределяемые сервисы для этого компонента подробно описаны в следующей таблице.
Примеры возвращаемых значений и параметров для каждого сервиса приведены в разделе Примеры ввода/вывода для сервисов настройки.
Наименование | Описание |
|---|---|
GetConfigurations | Возвращает доступные конфигурации для реализации компонента "Реквизиты документа". Параметры: нет Возвращает: JSON |
GetImplementationLabel | Возвращает локализованное наименование компонента или лексему, которые можно использовать для получения локализованного наименования. Это локализованное наименование отображается в интерфейсе пользователя Mashup Builder. Параметры: нет Возвращает: строку |
GetItemIdentityAttributes | Проверяет конфигурацию и добавляет все требуемые дополнительные атрибуты, а затем вызывает GetAttributeValues для получения всех значений атрибутов из серверной системы. Если сконфигурировано отображение изображения или дополнительного значка, они добавляются в возвращенный JSON, вследствие чего GetAttributeValues вызывает их значения из серверной системы. Параметры: input (обязательный) - JSON в формате CCO, содержащий идентификатор входных данных, которые нужно вызвать из серверной системы, и информацию об адаптере для серверной системы. configuration (необязательный) - JSON с окончательной объединенной конфигурацией, полученной из ресурса диспетчера настройки. attributes (обязательный) - файл JSON со списком атрибутов, как определено в конфигурации или задано в процессе настройки. Возвращает: JSON |
GetAttributesValues | Возвращает JSON с атрибутами и их значениями. Параметры: input (обязательный) - JSON в формате CCO, содержащий идентификатор входных данных, которые нужно вызвать из серверной системы, и информацию об адаптере для серверной системы. configuration (необязательный) - JSON с окончательной объединенной конфигурацией, полученной из ресурса диспетчера настройки. attributes (обязательный) - JSON со списком атрибутов. Возвращаемые данные: JSON в формате CCO |
Определение реализации
{
"array": [
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"additionalDefinition": [],
"updateServiceName": "",
"supportedTypes": {
"data": [
{
"itemListsData": [
{
"selectionGroupIds": [
"DOCUMENT"
],
"objectType": "PTC.DocMgmt.Document"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring": true
},
"addServiceName": ""
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.PatternSelector"
},
"mandatory": true,
"key": "primaryTitle"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"additionalDefinition": [],
"updateServiceName": "",
"supportedTypes": {
"data": [
{
"itemListsData": [
{
"selectionGroupIds": [
"DOCUMENT"
],
"objectType": "PTC.DocMgmt.Document"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring": true
},
"addServiceName": ""
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.PatternSelector"
},
"mandatory": true,
"key": "secondaryTitle"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"additionalDefinition": [],
"updateServiceName": "",
"minimumSelectedAttributes": null,
"supportedTypes": {
"data": [
{
"itemListsData": [
{
"selectionGroupIds": [
"DOCUMENT"
],
"objectType": "PTC.DocMgmt.Document"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring": true
},
"addServiceName": "",
"maximumSelectedAttributes": "5"
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.AttributesSelector"
},
"mandatory": false,
"key": "attributes"
},
{
"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": {
"default": false,
"true": {
"additionalDefinition": [
{
"directDefinition": [
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Textbox"
},
"mandatory": false,
"key": "defaultImagePath"
}
],
"key": "itemIdentityShowImageDefinition"
}
],
"label": "[[PTC.Nav.Yes]]"
},
"false": {
"additionalDefinition": [],
"label": "[[PTC.Nav.No]]"
},
"label": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": false,
"key": "showImage"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"default": false,
"true": {
"additionalDefinition": [],
"label": "[[PTC.Nav.Yes]]"
},
"false": {
"additionalDefinition": [],
"label": "[[PTC.Nav.No]]"
},
"label": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": false,
"key": "showSecondaryIcon"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"default": true,
"true": {
"additionalDefinition": [],
"label": "[[PTC.Nav.Yes]]"
},
"false": {
"additionalDefinition": [],
"label": "[[PTC.Nav.No]]"
},
"label": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": true,
"key": "enableExpandCollapse"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"default": true,
"true": {
"additionalDefinition": [],
"label": "[[PTC.Nav.Yes]]"
},
"false": {
"additionalDefinition": [],
"label": "[[PTC.Nav.No]]"
},
"label": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": true,
"key": "expanded"
}
]
}
"array": [
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"additionalDefinition": [],
"updateServiceName": "",
"supportedTypes": {
"data": [
{
"itemListsData": [
{
"selectionGroupIds": [
"DOCUMENT"
],
"objectType": "PTC.DocMgmt.Document"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring": true
},
"addServiceName": ""
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.PatternSelector"
},
"mandatory": true,
"key": "primaryTitle"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"additionalDefinition": [],
"updateServiceName": "",
"supportedTypes": {
"data": [
{
"itemListsData": [
{
"selectionGroupIds": [
"DOCUMENT"
],
"objectType": "PTC.DocMgmt.Document"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring": true
},
"addServiceName": ""
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.PatternSelector"
},
"mandatory": true,
"key": "secondaryTitle"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"additionalDefinition": [],
"updateServiceName": "",
"minimumSelectedAttributes": null,
"supportedTypes": {
"data": [
{
"itemListsData": [
{
"selectionGroupIds": [
"DOCUMENT"
],
"objectType": "PTC.DocMgmt.Document"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring": true
},
"addServiceName": "",
"maximumSelectedAttributes": "5"
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.AttributesSelector"
},
"mandatory": false,
"key": "attributes"
},
{
"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": {
"default": false,
"true": {
"additionalDefinition": [
{
"directDefinition": [
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Textbox"
},
"mandatory": false,
"key": "defaultImagePath"
}
],
"key": "itemIdentityShowImageDefinition"
}
],
"label": "[[PTC.Nav.Yes]]"
},
"false": {
"additionalDefinition": [],
"label": "[[PTC.Nav.No]]"
},
"label": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": false,
"key": "showImage"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"default": false,
"true": {
"additionalDefinition": [],
"label": "[[PTC.Nav.Yes]]"
},
"false": {
"additionalDefinition": [],
"label": "[[PTC.Nav.No]]"
},
"label": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": false,
"key": "showSecondaryIcon"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"default": true,
"true": {
"additionalDefinition": [],
"label": "[[PTC.Nav.Yes]]"
},
"false": {
"additionalDefinition": [],
"label": "[[PTC.Nav.No]]"
},
"label": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": true,
"key": "enableExpandCollapse"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"default": true,
"true": {
"additionalDefinition": [],
"label": "[[PTC.Nav.Yes]]"
},
"false": {
"additionalDefinition": [],
"label": "[[PTC.Nav.No]]"
},
"label": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": true,
"key": "expanded"
}
]
}