Проект соединителя
Проект соединителя соответствует соединителю системы, который логически группирует определенную функциональность интеграции. Несколько версий артефактов, связанных с группой функциональности, содержатся в едином проекте. Существуют артефакты для настройки и локализации в дополнение к артефактам тестирования в проекте.
Информация соединителя хранится и обрабатывается в проекте в структуре.
Чтобы создать новый проект, выполните следующую команду в командной строке:
flow init <user project root directory>
Она создаст проект нового соединителя в указанной папке. Если имя папки не предоставлено, интерфейс командной строки создаст проект в текущей папке.
Опции для команды init показаны в следующей таблице:
|
Опции
|
Описание
|
Тип данных
|
|---|---|---|
|
--help
|
Отображает справку.
|
[boolean]
|
|
--parentDir, -d
|
Родительский каталог для проекта.
|
[по умолчанию: "."]
|
|
--logLevel, -1
|
Задает уровень ведения журнала.
|
[по умолчанию: "info"]
|
Команда init создает папку, которая содержит следующие компоненты:
• Папка lib
• Папка test
• Файл package.json
• Файл index.js
Свойства из файла package.json описаны в следующей таблице:
|
package.json
|
|---|
 |
|
Свойство
|
Описание
|
|---|---|
|
name
|
Состоит из любых символов, которые допустимы в именах файлов. Предпочтительно, чтобы наименование было наименованием сервиса, с которым взаимодействует соединитель. Суффикс должен иметь вид -connector, чтобы показывать, что это - соединитель ThingWorx Flow. Имя должно иметь следующий формат:
<ptc-servicename-connector>
servicename не может содержать специальные символы, исключая символ подчеркивания (_).
Например, наименование соединителя ThingWorx Flow должно иметь вид ptc-thingworx-connector в наименовании пакета.
|
|
description
|
Предоставьте подходящее описание для пакета, перечисляемого в результатах поиска.
|
|
scripts
|
Это словарь, содержащий команды сценариев, которые выполняются неоднократно в жизненном цикле соединителя.
• Чтобы запустить сценарии тестирования, выполните следующую команду:
npm test
• Чтобы запустить пользовательские сценарии, выполните следующую команду:
npm run <script name>
Дополнительные сведения о сценариях см. на веб-сайте сценариев npm
|
|
dependencies
|
Другие пакеты NPM, которые соединитель использует в своем коде, когда артефакты вызываются во время выполнения.
ptc-flow-sdk - необходимая зависимость.
Не удаляйте зависимость ptc-flow-sdk, иначе ThingWorx Flow не сможет загружать соединитель.
Дополнительные сведения о зависимостях см. в разделе зависимостей на веб-сайте npm.
|
|
devDependencies
|
Используются на этапе разработки. Можно сопоставить дополнительные пакеты npm, которые используются только при тестировании соединителя в devDependencies.
Дополнительные сведения см. в разделе devDependencies на веб-сайте npmjs.
|