Выполнение сервисов в подсистеме WorkflowSubsystem в ThingWorx Composer
Предварительные требования
Перед выполнением сервисов в ThingWorx Composer необходимо убедиться, что выполнены следующие предварительные условия.
• Сервер ThingWorx Flow должен выполняться.
• Вы вошли в систему как администратор ThingWorx.
Шаги
1. На инструментальной панели ThingWorx Flow щелкните Composer, чтобы перейти к ThingWorx Composer.
2. В ThingWorx Composer в разделе Система выберите Подсистемы.
3. Выберите WorkflowSubsystem и щелкните вкладку Сервисы. Для ThingWorx Flow доступны следующие сервисы:
4. Найдите сервис и выполните одно из следующих заданий:
◦ Выберите сервис, чтобы просмотреть информацию о входных и выходных данных.
◦ Щелкните 
. Укажите правильные входные значения и щелкните Выполнить.
. Укажите правильные входные значения и щелкните Выполнить.Сервисы
LoadOAuthConfiguration
Используйте этот сервис, чтобы загрузить JSON-файл конфигурации OAuth на сервер ThingWorx Flow. Этот сервис обновляет или добавляет поставщики OAuth для соединителей, указанных в файле JSON. Ни одна из существующих конфигураций OAuth не удаляется.
Ввод | Вывод | ||
|---|---|---|---|
Имя параметра | Базовый тип | Описание | |
oauthConfigurations | JSON | Укажите действительный файл JSON с правильными настройками конфигурации OAuth для соединителя. | Возвращает сообщение, которое сообщает об успешном завершении или ошибках в результате выполнения сервиса. |
Например, чтобы загрузить конфигурацию OAuth для JIRA, укажите значение oauthConfigurations как
"jira": {
"JIRA": {
"CLIENT_ID": "<Client ID>"
"CLIENT_SECRET": "<Secret>"
}
},
"JIRA": {
"CLIENT_ID": "<Client ID>"
"CLIENT_SECRET": "<Secret>"
}
},
См. в разделе Конфигурирование и загрузка OAuth сведения о шаблонах JSON-файлов конфигурации OAuth, доступных в ThingWorx Composer.
DeleteOAuthConfiguration
Используйте этот сервис, чтобы удалить конфигурацию OAuth с сервера ThingWorx Flow, если поставщик OAuth не используется ни одним соединителем.
Ввод | Вывод | ||
|---|---|---|---|
Имя параметра | Базовый тип | Описание | |
Connector config name | Строка | Укажите действительное значение конфигурации соединителя, для которого требуется удалить настройки конфигурации OAuth. | Возвращает сообщение, которое сообщает об успешном завершении или ошибках в результате выполнения сервиса. |
OAuth provider | Строка | Укажите действительный поставщик OAuth для указанного соединителя. | |
Чтобы удалить ту же конфигурацию OAuth для JIRA, укажите значение поля Connector config name как jira и поля OAuth provider как JIRA.
GetOAuthConfiguration
Используйте этот сервис, чтобы загрузить список соединителей, для которых на сервер загружены настройки OAuth ThingWorx Flow. Конфиденциальная информация, например идентификаторы клиентов, секреты клиента и URL-адреса, не отображается.
Ввод | Вывод | ||
|---|---|---|---|
Имя параметра | Базовый тип | Описание | |
– | – | - | Возвращает JSON, который предоставляет наименование соединителя и наименование поставщика OAuth для всех OAuth, загруженных на сервер ThingWorx Flow. |
DeleteOAuthAccessToken
Используйте этот сервис, чтобы удалить лексемы доступа OAuth указанного поставщика OAuth.
Ввод | Вывод | ||
|---|---|---|---|
Имя параметра | Базовый тип | Описание | |
OAuth provider | Строка | Укажите действительный поставщик OAuth для сторонних сервиса или утилиты. | Возвращает сообщение, которое сообщает об успешном завершении или ошибках в результате выполнения сервиса. |
User Name | Строка | Укажите имя пользователя ThingWorx, для которого нужно удалить сгенерированные лексемы доступа для указанного поставщика OAuth. Это необязательное поле. Если имя пользователя не задано, то сервис удаляет все лексемы доступа OAuth для любого пользователя для указанного поставщика OAuth. | |
 | После того как служба удалит лексему доступа OAuth для поставщика OAuth, соединитель OAuth (именованный пользователь) отображается со значком  на информационной панели ThingWorx Flow. |
После удаления лексем доступа OAuth для пользователя пользователи должны предоставить свои данные авторизации для соединителя OAuth, чтобы выполнить рабочий процесс:
◦ OAuth (именованный пользователь) - измените соединитель OAuth (именованный пользователь), чтобы предоставить учетные данные для изменения конфигурации соединителя.
◦ OAuth (пользователь сессии) - каждый пользователь, использующий этот соединитель OAuth (пользователь сессии) в рабочем процессе, должен войти в систему и еще раз предоставить утверждения и права стороннему сервису или утилите.
RefreshMetadata
ThingWorx Flow кэширует информацию Windchill OData для повышения производительности. Если вы изменили спецификации метаданных Windchill или обновили динамические атрибуты на сервере Windchill, используйте этот сервис, чтобы обновить их на сервере ThingWorx Flow.
Ввод | Вывод | ||
|---|---|---|---|
Имя параметра | Базовый тип | Описание | |
connectorName | Строка | Укажите наименование соединителя для стороннего сервиса. | Возвращает сообщение, которое сообщает об успешном завершении или ошибках в результате выполнения сервиса. |
ValidateFlowSetup
Запустите этот сервис, чтобы проверить, может ли ThingWorx взаимодействовать с сервисами ThingWorx Flow.
Ввод | Вывод | ||
|---|---|---|---|
Имя параметра | Базовый тип | Описание | |
– | – | – | Возвращает сообщение, которое сообщает об успешном завершении или ошибках в результате выполнения сервиса. |
При возникновении проблем соединения между сервисами ThingWorx и ThingWorx Flow отображаются следующие коды ошибок и сообщения.
Код ошибки | Сообщение об ошибке |
|---|---|
[FLOW-CONFIG-01] | ThingWorx Flow не включено. Добавьте раздел OrchestrationSettings в файл platform-settings.json, чтобы включить ThingWorx Flow. |
[FLOW-RABBIT-01] | Не удалось соединиться с RabbitMQ. Убедитесь, что сервис RabbitMQ выполняется и доступен. |
[FLOW-API-01] | Не удалось соединиться с ThingWorx Flow. Проверьте подробности по журналам ThingWorx. |
[FLOW-API-02] | Не удалось соединиться с ThingWorx Flow. Убедитесь, что после установки ThingWorx Flow вы обращаетесь к ThingWorx через имя хост-компьютера и порт ThingWorx Flow. В противном случае ThingWorx Flow и ThingWorx не смогут взаимодействовать. |
[FLOW-KEY-01] | Ключ администрирования OAuth не найден в хранилище ключей ThingWorx. |
[FLOW-KEY-02] | Ключ администрирования обмена не найден в хранилище ключей ThingWorx. |
[FLOW-KEY-03] | Не удалось получить ключи ThingWorx Flow из хранилища ключей ThingWorx. |
[FLOW-KEY-04] | Не удалось получить ключи ThingWorx Flow из хранилища ключей ThingWorx. |
[FLOW-EXCHANGE-01] | Не удалось соединиться с сервисом обмена ThingWorx Flow. Проверьте подробности по журналам ThingWorx. |
[FLOW-EXCHANGE-02] | Не удалось соединиться с сервисом обмена ThingWorx Flow. Убедитесь, что сервис обмена ThingWorx Flow включен и выполняется. |
[FLOW-OAUTH-01] | Не удалось соединиться с сервисом ThingWorx Flow OAuth. Проверьте подробности по журналам ThingWorx. |
[FLOW-OAUTH-02] | Не удалось соединиться с сервисом ThingWorx Flow OAuth. Убедитесь, что сервис ThingWorx Flow OAuth включен и выполняется. |