Имя свойства | Описание | Тип | Значение по умолчанию | Обязательное или необязательное | |
maxItemsToShow | Максимальное число отображаемых кнопок действий. Если кнопок действий больше, чем данное указанное значение, в выпадающем меню будут отображены дополнительные действия. | Целое число | 2 | Обязательный | |
modelThingName | Имя вещи, содержащей сервис со следующей сигнатурой: public JSONObject GetActions(@ThingworxServiceParameter(name = "ccoJson", baseType = "JSON") JSONObject ccoJson) Этот сервис получает входные данные в формате CCO (Common Communication Object), содержащем один элемент. Затем он возвращает JSONObject, содержащий массив, который сопоставляет идентификатор доступного действия с его меткой, полученной из серверной системы. См. приведенный ниже пример с образцом конфигурации JSON. | Строка | "PTC.ActionBar Model.Thing" | Обязательный | |
actions | Действия, доступные на панели действий. См. подсвойство: | Строка | Н/Д | Обязательный | |
id | ИД действия, полученного из серверной системы. См. подсвойства, приведенные в следующей таблице. | Строка | Н/Д | Обязательный | |
objectType | Тип объекта, для которого должны быть вызваны действия. | Строка | Н/Д | Обязательный | |
adapter | Исходная конфигурация для серверной системы. См. подсвойства: | Строка | Н/Д | Обязательный | |
instanceName | Экземпляр соединителя, то есть соединитель, который должен использоваться для соединения с серверной системой. | Строка | "windchill" | Обязательный | |
thingName | Наименование серверной системы или адаптера, из которого загружаются данные. | Строка | "PTC.WCAdapter" | Обязательный |
Поля конфигурации для id | |||||
Имя свойства | Описание | Тип | Значение по умолчанию | Обязательное или необязательное | |
overrideLabel | Здесь набор значений представлен меткой кнопки действия, которая переопределяет значение, поступающее из серверной системы. Для локализации заключите это значение в двойные скобки. | Строка | Н/Д | Необязательный | |
actionButtonVisibility | Определяет, при каких условиях отображаются кнопки действий и в каком состоянии. Опции: AlwaysShown, DisableUnavailable, HideUnavailable. Кнопка AlwaysShown всегда видима и включена. Кнопка DisableUnavailable всегда видима, но отключена, если действие недоступно для данного выбора. Кнопка HideUnavailable видима, только если действие доступно для данного выбора. Примечание. Существуют другие конфигурации, определяющие, должна ли кнопка быть включена или выключена. | Строка | Н/Д | Обязательный | |
buttonStyle | Определяет визуальный стиль кнопки. Опции: primary, secondary, tertiary, danger, transparent. | Строка | Н/Д | Обязательный | |
overrideSetDisabled | Если это поле задано, то его значение будет единственным фактором, определяющим включение или выключение кнопки. Опции: true, false. При значении true эта кнопка будет выключена, а при значении false - включена. | Логический | Н/Д | Необязательный | |
activityType | Определяет, запускает ли данное действие сервис или отображает всплывающий мэшап. Опции: popup, service. В приведенных ниже таблицах представлены необходимые подсвойства для всплывающего окна и для сервиса. | Строка | Н/Д | Обязательный | |
fireEventOnFinish | Если для этого поля задано значение true, при завершении работы сервиса инициируется событие EventTriggered, а при закрытии всплывающего окна инициируется событие PopupClosed. | Логический | Н/Д | Необязательный | |
inputConstraints | Определяет ограничение входных данных для этого действия. Опции: InputRequired, SingleInputOnly и NoInputRequired. InputRequired - это действие должно получать входные данные для работы. При пустых входных данных, когда они не содержат ни одного элемента, кнопка этого действия выключена. SingleInputOnly - это действие должно получать один входной параметр для работы. Если входные данные пустые или содержат более одного элемента, кнопка этого действия выключена. NoInputRequired - это действие может выполняться без входных данных или с входными данными. | Строка | Н/Д | Необязательный | |
ordinal | Порядок, в котором отображаются кнопки действий. Действие с наименьшим порядковым номером отображается в начальном крайнем левом положении. Разрешены отрицательные значения. | Целое число | Н/Д | Обязательный | |
iconWhenEnabled | Если это поле указано, то кнопка действия, когда она включена, содержит соответствующий значок слева от метки. | Строка | Н/Д | Необязательный | |
entityName | Наименование медиаобъекта, который должен использоваться в качестве значка. | Строка | Н/Д | Необязательный | |
iconWhenDisabled | Если это поле указано, то кнопка действия, когда она выключена, содержит соответствующий значок слева от метки. | Строка | Н/Д | Необязательный | |
entityName | Наименование медиаобъекта, который должен использоваться в качестве значка. | Строка | Н/Д | Необязательный |
Подсвойства activityType для popup | ||||
Имя свойства | Описание | Тип | Значение по умолчанию | Обязательное или необязательное |
mashupName | Имя мэшапа, которое отображается в виде всплывающего окна. | Строка | Н/Д | Обязательный |
redirectAfterPopupSuccess | Перенаправляет в другой мэшап, если всплывающее окно закрылось после успешной операции. Чтобы передать в панель действий информацию об успешном или неуспешном завершении операции, выполняемой всплывающим окном, необходимо задать для параметра PTC.ActionBar.popupCloseParameters сессии значение, обозначающее, соответственно, успешное завершение или сбой. Например, мэшап всплывающего окна может содержать выражение, вычисляемое по завершении операции, выполняемой всплывающим окном, а в этом выражении задан параметр сессии. В следующем примере атрибут JSON operationSuccessful имеет значение true, после того как операция была успешно выполнена: sessionStorage.setItem("PTC.ActionBar.popupCloseParameters", JSON.stringify( { operationSuccessful: true } )); | Строка | Н/Д | Необязательный |
popupWidth | Определяет ширину появляющегося всплывающего окна. Если это поле оставлено пустым, ширина всплывающего окна по умолчанию будет равна 1024. | Целое число | Н/Д | Необязательный |
popupHeight | Определяет ширину появляющегося всплывающего окна. Если это поле оставлено пустым, ширина всплывающего окна по умолчанию будет равна 640. | Целое число | Н/Д | Необязательный |
Подсвойства activityType для service | ||||
Имя свойства | Описание | Тип | Значение по умолчанию | Обязательное или необязательное |
thingWithService | Наименование вещи, содержащей сервис, который будет выполняться. | Строка | Н/Д | Обязательный |
serviceName | Имя сервиса, который должен выполняться. | Строка | Н/Д | Обязательный |
parameters | Это необязательное поле позволяет передавать в сервис жестко закодированные параметры. Параметры определяются в JSONObject, но должны иметь формат строки объекта JSON с обратной косой чертой и кавычками. Параметры необходимо вводить в файл конфигурации в формате "{\"myParamName\": \"hardcodedValue\"}" . Дополнительные сведения см. ниже. | StringRepresentationOfJSONObject | Н/Д | Необязательный |
Существует два параметра, которые сервис получает автоматически, если определена сигнатура сервиса для их получения: serviceParam_InputCco и serviceParam_ActionId. Параметр serviceParam_InputCco - это JSONObject и входное значение, предоставляемое на панели действий. Параметр serviceParam_ActionId - это строка, содержащая ИД действия, которое было выбрано. Если эти параметры не включены в сигнатуру сервиса, их нельзя использовать. Если нужно использовать эти параметры, определите свою сигнатуру сервиса для использования любого из них или обоих, выполнив следующие действия. @ThingworxServiceDefinition(name = "MyService", category = "MyCategory") public void MyService( @ThingworxServiceParameter(name = "serviceParam_InputCco", baseType = "JSON") JSONObject serviceParam_InputCco, @ThingworxServiceParameter(name = "serviceParam_ActionId", baseType = "STRING") String serviceParam_ActionId) |