Реквизиты элемента
Определение и использование
Компонент "Реквизиты элемента" - это виджет, позволяющий отображать для конкретного элемента базовую информацию, также называемую идентифицирующей информацией. Эта информация отображается на панели, как правило, в верхней части страницы элемента. Панель содержит изображение, основной заголовок, дополнительный заголовок, дополнительный значок и различные атрибуты реквизитов элемента. Дополнительный значок обозначает тип элемента и может быть сконфигурирован для использования значков Windchill. Компонент "Реквизиты элемента" также содержит встроенную панель действий, отображающую действия, которые можно выполнить с элементом.
На приведенном ниже изображении показан компонент "Идентификация элементов".
Можно сконфигурировать компонент "Реквизиты элемента" следующими способами.
• Определить основной и дополнительный заголовки
• Сконфигурировать действия, доступные на встроенной панели действий
• Задать атрибуты идентификации, которые должны отображаться
• Укажите, нужно ли показывать изображение, и определите путь к изображению по умолчанию
• Выбрать, нужно ли показывать дополнительный значок
• Выберите, доступно ли свертывание панели
Реквизиты задания, Реквизиты детали и Реквизиты документа - это предопределенные конфигурации, доступные для компонента "Реквизиты элемента".
Свойства привязки
Входные данные | ||||
|---|---|---|---|---|
Имя свойства | Описание | Тип свойства | ||
Input | Используется для идентификации данных, которые должны вызываться из серверной системы. Ниже приведен пример: Пример JSON: { "version":"1.0.0", "data":[ { "adapter":{ "thingName":"PTC.WCAdapter", "instanceName":"windchill" }, "itemListsData":[ { "objectType":"PTC.ChangeMgmt.ChangeRequest", "items":[ { "id":{ "value":"OR:wt.change2.WTChangeRequest2:439476" } } ] } ] } ] }
| JSON в формате CCO | ||
TailoringName | Уникально идентифицирует экземпляр компонента "Реквизиты элемента". Это значение используется для внутреннего поиска информации о настройке конкретного экземпляра. Используйте это свойство привязки, только если существует специальная страница настройки для пользовательского задания. | Строка | ||
Свойства конфигурации
В следующей таблице и на изображениях показаны свойства JSON, используемые для конфигурирования этого компонента.
Дополнительные сведения о структуре конфигурации см. в разделе Структура конфигурации компонента.
Дополнительные сведения о подсвойствах см. в разделе Подсвойства и ключи контейнера.
Имя свойства | Описание | Тип свойства | Значение по умолчанию | Обязательное или необязательное | |||
|---|---|---|---|---|---|---|---|
actionBarConfiguration | Действия, которые должны отображаться на панели действий в интерфейсе пользователя. Дополнительные сведения см. в описании компонента Панель действий. | Н/Д | Необязательное | ||||
attributes | Список атрибутов, для которых данные вызываются из серверной системы.
| Н/Д | Необязательное | ||||
defaultImagePath | Путь по умолчанию для вызова изображения. Это свойство является подсвойством для showImage и применимо, только если для showImage задано значение true. Ключ его контейнера: itemIdentityShowImageDefinition. | Н/Д | Является обязательным, если для showImage задано значение true. | ||||
enableExpandCollapse | Определяет, можно ли свернуть и развернуть панель "Реквизиты элемента" в интерфейсе пользователя. Если задано значение true, панель можно развернуть, чтобы видеть всю информацию, или свернуть, чтобы видеть только основной заголовок и, если требуется, панель действий. Если задать значение false, панель нельзя развернуть или свернуть. Будет ли панель развернута или свернута, зависит от значения, заданного для свойства expanded. | true | Обязательное | ||||
expanded | Определяет состояние панели "Реквизиты элемента" по умолчанию: развернуто или свернута. Если задано значение true, панель по умолчанию развернута. Если задано значение false, панель по умолчанию свернута. | true | Обязательное | ||||
primaryTitle | Основной заголовок, который отображается в верхней части панели "Реквизиты элемента". | Н/Д | Обязательное | ||||
secondaryTitle | Дополнительный заголовок, который отображается под основным заголовком на панели "Реквизиты элемента". | Н/Д | Обязательное | ||||
showImage | Определяет, нужно ли показывать изображение на панели "Реквизиты элемента". Опции: true, false. Если задано значение true, изображение отображается на панели. Определите путь к изображению, используя свойство defaultImagePath. Если задано значение false, изображение не отображается. | Н/Д | Обязательное | ||||
showSecondaryIcon | Нужно ли показывать дополнительный значок. Опции: true, false. Если задано значение true, на панели отображается дополнительный значок. Если задано значение false, дополнительный значок не отображается. | false | Обязательное | ||||
Пример конфигурации
Примеры конфигураций для компонента "Реквизиты элемента" см. в разделах Реквизиты задания, Реквизиты детали и Реквизиты документа.
Сервисы настройки
В дополнение к конфигурации каждый компонент поддерживает расширение бизнес-логики для настройки компонента. Бизнес-логика каждого компонента включает в себя переопределяемые сервисы в шаблоне вещи, которые можно расширять и переопределять. Переопределяемые сервисы для этого компонента подробно описаны в следующей таблице.
Примеры возвращаемых значений и параметров для каждого сервиса приведены в разделе Примеры ввода/вывода для сервисов настройки.
Наименование | Описание |
|---|---|
GetConfigurations | Возвращает доступные конфигурации для реализации компонента. Параметры: нет Возвращает: JSON |
GetImplementationLabel | Возвращает локализованное наименование компонента или лексему, которые можно использовать для получения локализованного наименования. Это локализованное наименование отображается в интерфейсе пользователя Mashup Builder. Параметры: нет Возвращает: строку |
ProcessAttributesConfiguration | Обрабатывает конфигурацию атрибутов и разделяет атрибуты на стандартные атрибуты и дополнительные атрибуты. Возвращает JSON с парами "ключ-значение" в следующем виде: • OOTBAttributes : OOTB Attributes configuration CCO JSON • additionalAttributes : Additional Attributes configuration CCO JSON Атрибуты разделяются на стандартные и дополнительные на основании их типа объекта. Атрибуты, имеющие тип объекта, заканчивающийся на .Custom.Adapter или .Custom.Implementation, обрабатываются как дополнительные атрибуты. Все остальные атрибуты считаются стандартными атрибутами. Компонент "Реквизиты элемента" не поддерживает использование атрибутов с типами объекта, оканчивающимися только на .Custom.Implementation. Убедитесь, что хотя бы один из используемых атрибутов имеет другой тип объекта. Параметры: attributes (обязательный) - JSON со списком стандартных атрибутов и дополнительных атрибутов. configuration (необязательный) - JSON с окончательной объединенной конфигурацией, полученной из ресурса диспетчера настройки. Возвращаемые данные: JSON в формате CCO |
GetItemIdentityAttributes | Проверяет конфигурацию и добавляет все требуемые дополнительные атрибуты, а затем вызывает GetAttributeValues для получения всех значений атрибутов из серверной системы. Параметры: input (обязательный) - JSON в формате CCO, содержащий идентификатор входных данных, которые нужно вызвать из серверной системы, и информацию об адаптере для серверной системы. configuration (необязательный) - JSON с окончательной объединенной конфигурацией, полученной из ресурса диспетчера настройки. attributes (обязательный) - файл JSON со списком стандартных атрибутов, как определено в конфигурации или задано в процессе настройки. Возвращает: JSON |
GetAttributesValues | Возвращает JSON с атрибутами и их значениями. Параметры: input (обязательный) - JSON в формате CCO, содержащий идентификатор входных данных, которые нужно вызвать из серверной системы, и информацию об адаптере для серверной системы. configuration (необязательный) - JSON с окончательной объединенной конфигурацией, полученной из ресурса диспетчера настройки. attributes (обязательный) - JSON со списком стандартных атрибутов и дополнительных атрибутов. Возвращаемые данные: JSON в формате CCO |
GetAdditionalAttributes | Возвращает список дополнительных атрибутов, которые нужно добавить в список доступных стандартных атрибутов. Параметры: нет Возвращает: JSON |
Определение реализации
Сведения об определениях реализации для компонента "Реквизиты элемента" см. в разделах Реквизиты задания, Реквизиты детали и Реквизиты документа.