Создание заданий с вебхуками

Лицензия:

Для использования этой функциональной возможности требуется лицензия на роль ArcGIS Workflow Manager Server Advanced.

Вебхуки позволяют приложениям отправлять информацию другим приложениям и сервисам, когда происходит определенное действие или событие. ArcGIS Workflow Manager позволяет обрабатывать информацию из входящих вебхуков для автоматического создания заданий из указанного шаблона задания. Вы также можете сохранить полезные данные входящего вебхука в виде файла и прикрепить его к заданию, а также настроить пользовательские выходные значения, которые можно использовать в ходе всего задания.

Создать входящий вебхук

Выполните следующие шаги, чтобы создать входящий вебхук:

1. Обратитесь к веб-приложению Workflow Manager.
2. Щелкните вкладку Оформление.

   Появится страница Дизайн.

   Примечание:

   Если у вас недостаточно прав доступа, вкладка Оформление будет недоступна.

3. Щелкните кнопку Шаблоны заданий .

   Появится панель Шаблоны заданий.

4. Щелкните шаблон задания, для которого хотите создать входящий вебхук.

   Шаблон задания появится на панели.

5. Перейдите на вкладку Автоматические действия.

   Если у вас нет лицензии для роли ArcGIS Workflow Manager Server Advanced или нет достаточных прав, вы не сможете настраивать автоматические действия.

6. В разделе Создание задания вебхука нажмите Добавить вебхук.

   Появится диалоговое окно Создать вебхук.

7. Введите имя вебхука в текстовом окне Имя.
8. Укажите имя пользователя и пароль в текстовых окнах Имя пользователя и Пароль, чтобы создать учетные данные для входящего вебхука.

   Вы также можете использовать выражение ArcGIS Arcade в текстовых полях Имя пользователя и Пароль для динамического заполнения этих значений с помощью зашифрованных пользовательских настроек.

   Внимание:

   Информация, которую вы предоставляете в текстовых полях Имя пользователя и Пароль, не шифруется. Рекомендуется создавать зашифрованные пользовательские настройки для безопасного хранения учетных данных вебхука.

   Подсказка:

   Нажмите Этот входной параметр поддерживает выражения Arcade и выберите выражение ArcGIS Arcade, чтобы добавить его в соответствующее текстовое поле.

9. При необходимости включите Резервное имя пользователя и пароль и настройте резервный набор учетных данных для вебхука, указав имя пользователя и пароль в текстовых полях Резервное имя пользователя и Резервный пароль.

   Вы также можете использовать выражение ArcGIS Arcade в текстовых полях Имя пользователя и Пароль для динамического заполнения этих значений с помощью зашифрованных пользовательских настроек.

   Внимание:

   Информация, которую вы предоставляете в текстовых полях Резервное имя пользователя и Резервный пароль, не шифруется. Рекомендуется создавать зашифрованные пользовательские настройки для безопасного хранения учетных данных вебхука.

10. Чтобы использовать аутентификацию с секретным ключом, включите Секретный ключ заголовка и укажите значения для секретного ключа в текстовых полях Ключ и Значение.
11. При необходимости щелкните вкладку Полезные данные и включите параметр Вложить ответ, чтобы сохранить полезные данные входящего вебхука в виде файла и прикрепить его к заданию.
12. При желании выполните следующие действия, чтобы настроить имя вложения и папку, в которой оно будет храниться:
    1. Введите имя папки, в которой будет храниться вложение, в текстовом окне Имя папки.

       Имя папки не может содержать путь к файловой системе или специальные символы. Если имя папки не указано, автоматически создается папка с именем Общие.

       Примечание:

       Папка содержится в элементе рабочего процесса и не является путем к файловой системе.

    2. Выберите одну из следующих опций Имя вложения:
       • Созданный автоматически - вложению автоматически присваивается имя, с помощью следующего синтаксиса: <StepName>_<RunDate>_<RunTime>
       • Пользовательский - позволяет указать пользовательское имя вложения.
13. При необходимости выполните следующие действия, чтобы проанализировать полезные данные входящего веб-запроса и настроить пользовательские выходные значения:
    1. Щелкните переключатель Режим тестирования в разделе Выходные значения.
    2. Вставьте пример полезных данных входящего вебхука в текстовое поле Образец ответа.

       Пример полезных данных в формате JSON:

       {"spatialReference": {
         "wkid": 4326,
         "latestWkid": 4326
       },
       "locations": [
         {
           "name": "380 New York Street",
           "extent": {
             "xmin": -117.196701,
             "ymin": 34.055489
           }
         }
       ]}

    3. Щелкните Добавить выходные данные и путь.
    4. Введите имя для выходного значения в текстовом окне Выходное значение.

       Это имя значения, которое используется для получения пользовательского выходного значения.

    5. Предоставьте выражение JSONPath в точечной записи или в скобках для значения, которое вы хотите сохранить, в текстовом окне Путь извлечения.

       Пример JSONPath в точечной записи:

       $.spatialReference

       Пример JSONPath в скобках:

       $['locations'][0]['name']

       Значение отображается в столбце Образец результата.

    6. При желании повторите шаги с c по e, чтобы добавить дополнительные пользовательские выходные значения.
14. Щелкните Сохранить.

    Входящий вебхук отображается в разделе Создание задания вебхука.

15. Щелкните Сохранить, чтобы сохранить шаблон задания.

    Вебхуку присваивается идентификатор и URL-адрес.

16. Наведите указатель мыши на вебхук и нажмите кнопку Копировать URL , чтобы скопировать URL-адрес входящего вебхука в буфер обмена и настроить его для использования в вашем приложении.

Редактирование вебхука

Выполните следующие шаги, чтобы отредактировать входящий вебхук:

1. Обратитесь к веб-приложению Workflow Manager.
2. Щелкните вкладку Оформление.

   Появится страница Дизайн.

   Примечание:

   Если у вас недостаточно прав доступа, вкладка Оформление будет недоступна.

3. Щелкните кнопку Шаблоны заданий .

   Появится панель Шаблоны заданий.

4. Щелкните шаблон задания, содержащий входящий вебхук, который вы хотите изменить.

   Шаблон задания появится на панели.

5. Перейдите на вкладку Автоматические действия.

   Если у вас нет лицензии для роли ArcGIS Workflow Manager Server Advanced или нет достаточных прав, вы не сможете настраивать автоматические действия.

6. В разделе Создание задания вебхука наведите указатель мыши на входящий вебхук, который хотите изменить, и нажмите Редактировать.

   Появится диалоговое окно Создать вебхук.

7. При необходимости обновите настройки входящего вебхука.
8. Нажмите Сохранить, чтобы сохранить изменения.
9. Щелкните Сохранить, чтобы сохранить шаблон задания.

   Входящий вебхук обновлен.

Удаление вебхука

Удаление входящего вебхука является необратимым и не может быть отменено. Выполните следующие шаги, чтобы удалить входящий вебхук:

1. Обратитесь к веб-приложению Workflow Manager.
2. Щелкните вкладку Оформление.

   Появится страница Дизайн.

   Примечание:

   Если у вас недостаточно прав доступа, вкладка Оформление будет недоступна.

3. Щелкните кнопку Шаблоны заданий .

   Появится панель Шаблоны заданий.

4. Щелкните шаблон задания, содержащий входящий вебхук, который вы хотите удалить.

   Шаблон задания появится на панели.

5. Перейдите на вкладку Автоматические действия.

   Если у вас нет лицензии для роли ArcGIS Workflow Manager Server Advanced или нет достаточных прав, вы не сможете настраивать автоматические действия.

6. В разделе Создание задания вебхука наведите указатель мыши на входящий вебхук, который хотите удалить, и нажмите Удалить вебхук .

   Внимание:

   Удаленные входящие вебхуки не могут быть восстановлены.
7. Щелкните Сохранить, чтобы сохранить шаблон задания.

   Вебхук удален.