Official translation unavailable. Translate this page with Google:

Информация об уровне продукта

Требуется подписка на NiceLabel Cloud.

Подробную информацию о триггерах в целом см. в разделе Описание триггеров.

Подробнее о NiceLabel Label Cloud см. здесь.

Триггер облака позволяет интегрировать NiceLabel Cloud или локальный Control Center с существующими бизнес-системами, которые работают в частном облаке или в специализированных центрах обработки данных. Если существующая бизнес-система (например, SAP S/4HANA или Oracle NetSuite) выдает какие-либо данные, размещенный в облаке API позволяет отправлять запросы HTTP триггеру облака.

Триггер облака позволяет выполнять локальную печать этикеток, содержимое которых получено из облачных информационных систем. Поскольку триггер облака, работающий на локальном сервере Automation, использует стандартные методы доступа к облачным службам, это обеспечивает безопасное и быстрое развертывание локальной печати.

Триггер облака предоставляет безопасный и прозрачный способ интеграции локальной печати этикеток с помощью приложений, которые обмениваются данными через открытые интернет-каналы.

По сравнению с триггером сервера HTTP для триггера облака не требуется открывать в брандмауэре входящие порты. Триггер облака использует специальный API NiceLabel, который выполняется в облаке. Поэтому для триггера требуется открыть только исходящий порт 443 или порты 9350-9354. В большинстве случаев эти порты уже открыты.

Существует два варианта развертывания триггера облака:

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

Развертывание триггера облака с помощью NiceLabel Cloud

Порядок развертывания с помощью NiceLabel Cloud

Чтобы настроить локальную печать этикеток с помощью триггера облака, развернутого в NiceLabel Cloud, необходимо взаимодействие пользователей с тремя ролями: пользователя, который настраивает триггер облака на локальном сервере Automation (разработчик); пользователя, который настраивает триггер облака в NiceLabel Cloud; и пользователя, который создает подписку на портале разработчика.

UUID-4a7834ab-e9e3-d7ac-d0fd-c550f1520e0e.png
  1. Разработчик настраивает и развертывает конфигурацию триггера облака на локальном сервере Automation с помощью Automation Builder и Automation Manager.

    Примечание

    В приложении NiceLabel Automation необходимо войти в систему NiceLabel Cloud.

  2. Администратор NiceLabel Cloud предоставляет внешнему интегратору доступ к триггеру облака в Control Center. Затем администратор NiceLabel Cloud отправляет внешнему интегратору соответствующий ключ интегратора.

  3. Внешний интегратор подключается к порталу разработчика, чтобы объединить бизнес-систему заказчика и NiceLabel Cloud.

    Примечание

    На портале разработчика размещен специальный API с именем Cloud Trigger. Этот API служит связующим звеном между событиями, которые происходят в бизнес-системе заказчика, и локальной конфигурацией Automation.

    Примечание

    Слово «внешний» означает, что этот пользователь должен создать подписку на портале разработчика. Созданная подписка служит для проверки подлинности интегратора. Внешние интеграторы не обязательно должны быть внешними сотрудниками. Это могут быть внутренние интеграторы компании из группы разработки.

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

    1. Вход в систему портала разработчика. Перед первым входом интегратор должен пройти процедуру регистрации.

    2. Создание подписки для API триггера облака.

    3. Подключение подписки с помощью ключа интегратора. Таким образом подписка получает доступ к триггерам облака заказчика.

      Подробнее см. в разделе Настройка API NiceLabel Cloud на портале разработчика.

Настройка триггера облака в Automation Builder

В этом разделе описана процедура настройки триггера облака в приложении Automation, которое работает на локальном сервере.

  1. Откройте Automation Builder. Убедитесь, что в приложении Automation Builder выполнен вход в систему NiceLabel Cloud. Выберите Файл > О программе >NiceLabel Cloudи убедитесь, что выполнен вход в учетную запись.

  2. Откроется вкладка Элементы конфигурации. Нажмите Триггер облака, чтобы создать новую конфигурацию для триггера облака.

  3. Задайте Имя и Описание, чтобы можно было легко найти этот триггер среди других триггеров облака.

  4. Задайте настройки триггера в разделе Связь:

    • Укажите Уникальный идентификатор. После развертывания триггера этот уникальный идентификатор требуется для его вызова.

      При запуске конфигурации триггера облака на нескольких компьютерах проследите, чтобы каждый из них автоматически использовал свой собственный уникальный идентификатор. Чтобы избежать нежелательного дублирования, вставьте в уникальный идентификатор внутренние переменные. Для этого можно использовать две внутренние переменные:

      • ComputerName: имя компьютера, на котором запущена конфигурация.

      • SystemUserName: Имя пользователя Windows текущего пользователя, выполнившего вход.

      Чтобы вставить внутренние переменные в уникальный идентификатор, нажмите «Вставить источник данных» и выберите внутренние переменные.

      UUID-7905238a-2b2d-69c4-9856-247bdcb0320c.png
    • Подождите, пока закончится запуск триггера. Протокол HTTP требует, чтобы получатель (в данном случае NiceLabel Automation) отправил отправителю числовой ответ с указанием состояния полученного сообщения. По умолчанию NiceLabel Automation отправляет ответ с кодом 200. Это означает, что приложение Automation успешно получило данные, но ничего не говорит об успешности действий триггера.

      Этот параметр указывает, что триггер не отправляет ответ сразу после получения данных, а дожидается выполнения всех действий. Затем он отправляет код ответа, указывающий на успешное выполнение действия. Если этот параметр включен, можно выбрать настраиваемый ответ и указать отправляемые данные (например, в ответ на запрос HTTP можно отправлять изображение для предварительного просмотра этикетки в формате PDF).

      Встроенные стандартные коды ответа HTTP Automation для триггера облака:

      Код ответа HTTP

      Описание

      200

      Все действия выполнены успешно.

      500

      При выполнении действий произошли ошибки.

      Примечание

      Чтобы отправить Automation обратную связь по процессу печати, включите синхронный режим печати. Дополнительные сведения см. в разделе Синхронный режим печати.

    • Тип ответа. Задает тип ответного сообщения. В выпадающем списке доступны часто используемые типы мультимедиа для Интернета (также известные как типы MIME или типы содержимого). Если в списке нет требуемого типа мультимедиа, введите его. Automation отправляет данные ответа как сообщение обратной связи в формате заданного типа мультимедиа. Переменная позволяет использовать переменные типы мультимедиа. Если параметр включен, выберите или создайте переменную, содержащую тип мультимедиа.

      Примечание

      Если не указать тип содержимого, NiceLabel Automation по умолчанию использует application/octet-stream.

    • Данные ответа. Содержимое ответного сообщения. Примеры данных, которые можно отправить обратно в виде ответа HTTP: собственные сообщения об ошибках, изображение этикетки для предварительного просмотра, сгенерированные файлы PDF, файлы потока печати (файлы очереди), файлы XML с информацией от механизма печати и изображением этикетки для предварительного просмотра (закодированный в виде строки Base64).

      Если выходные данные состоят только из двоичного содержимого (например, изображение этикетки для предварительного просмотра или поток печати), необходимо выбрать поддерживаемый тип мультимедиа, например image/jpeg или application/octet-stream.

    • Дополнительные заголовки. Позволяют задать собственные заголовки MIME для ответного сообщения HTTP.

      Синтаксис заголовка ответа и примеры приведены в разделе Действие «Запрос HTTP».

      Подсказка

      В разделах Данные ответа и Дополнительные заголовки можно использовать фиксированное содержимое, сочетание фиксированного и переменного содержимого или только переменное содержимое. Чтобы вставить переменное содержимое, нажмите кнопку со стрелкой справа от области данных и вставьте переменную из списка. Можно также создать новую переменную, содержащую нужные данные. Дополнительные сведения см. в разделе Использование составных значений.

  5. Разверните и запустите триггер в Automation Manager. Триггер облака начинает отслеживать входящие запросы.

Примечание

Если конфигурация требует повышенной доступности и масштабируемости, можно развернуть несколько одинаковых триггеров облака. Для этого установите несколько экземпляров Automation и разверните в них триггеры облака. Если развернутые триггеры облака имеют одинаковый Уникальный идентификатор, встроенный балансировщик нагрузки в NiceLabel Cloud автоматически распределяет трафик между ними.

Настройка доступа к триггеру облака для внешнего интегратора.

Примечание

Чтобы настроить доступ интегратора к триггеру облака, требуется разрешение на управление интеграцией с облаком в облачном Control Center. Подробнее об управлении полномочиями пользователей см. в руководстве пользователя Control Center.

  1. Перейдите к облачному Control Center. Откройте браузер и введите.

    https://<yourlabelcloudname>.onnicelabel.com/dashboard.
  2. Выберите Интеграции > Интеграция облака.

  3. Нажмите +Добавить. Откроется страница добавления нового интегратора доступа .

  4. Введите Имя добавляемого интегратора.

    UUID-48984233-2f5c-3b15-04d2-a284439f7360.png
  5. Скопируйте Ключ.

  6. Нажмите Сохранить.

  7. Направьте внешнего интегратора на портал разработчика. Отправьте внешнему интегратору следующие сведения:

    • Ссылка на API NiceLabel Cloudhttps://developerportal.onnicelabel.com/

    • Ключ интегратора (см. шаг 5).

    • Уникальный идентификатор триггера. Уникальный идентификатор указан в настройках конфигурации Automation триггера облака (см. шаг 4 в разделе). Настройка триггера облака в Automation Builder.

    Примечание

    Ключ необходим внешнему интегратору для проверки подлинности при вызове триггера облака заказчика.

Примечание

Дополнительную информацию см. в разделе «Триггеры облака» руководства пользователя Control Center.

Создание подписки на портале разработчика

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

Примечание

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

Примечание

Заказчики — это компании, запускающие конфигурации триггеров облака, которые получают данные из внешних информационных систем.

Примечание

Каждый интегратор может запускать несколько триггеров облака в рамках одной подписки.

  1. Откройте браузер и перейдите на https://developerportal.onnicelabel.com/.

  2. Чтобы пройти регистрацию, следуйте указаниям на экране. После нажатия кнопки Регистрация вы получите электронной письмо с подтверждением. Нажмите ссылку подтверждения, чтобы активировать учетную запись на портале разработчика.

  3. Откройте вкладку Продукты и нажмите Label Cloud. Открывшаяся страница содержит ваши API и существующие подписки.

  4. Нажмите Добавить подписку. Открывается страница подписки на продукт.

    Примечание

    Можно создать несколько подписок. Однако одной подпиской может пользоваться только один заказчик. Поэтому NiceLabel рекомендует включать имя заказчика в Название подписки, например Cloud Trigger Example Customer.

  5. Введите Название подписки.

  6. Нажмите Подтвердить. Созданная подписка становится доступна в разделе Продукты > Label Cloud.

  7. Вернувшись на страницу Label Cloud, нажмите Developer Sign Up API v1.

  8. Нажмите Проба. Открывается страница API.

    UUID-233e0250-4199-27da-0968-e7275329f997.png
  9. Вставьте ключ интегратора, полученный из облачного Control Center заказчика.

  10. Нажмите Отправить.

    • Вы получите ответ: Subscription <your subscription key> successfully associated with integrator key <integrator key value>.

    Примечание

    Вы получили ключ интегратора от администратора NiceLabel Cloud. Ключ выглядит следующим образом: 979d7be5df2b473193ac5519f94cd901

    Пример 26. Пример

    При передаче ключа интеграции в качестве параметра запроса адрес URL выглядит следующим образом: https://labelcloudapi.onnicelabel.com/SignUpApi/DeveloperSignup?integratorKey=979d7be5df2b473193ac5519f94cd901.


    Когда вы выполняете вызов с использованием URL, как показано в примере, операция DeveloperSignup сопоставляет подписку с назначенным заказчиком. Так интегратор выполняет проверку подлинности при вызове триггера облака, работающего в Automation заказчика.

    Подключенные подписки также отображаются в облачном Control Center. Проверьте подключение подписки внешнего интегратора в разделе Интеграции > Интеграция облака. Интеграции с облаком должен быть присвоен статус Разработчик [имя, адрес эл. почты] подписан.

Вызов триггера облака (развертывание NiceLabel Cloud)

Этот шаг позволяет убедиться, что выходные данные внешних бизнес-систем успешно запускают триггеры облака, которые работают локально. Это цель операции CloudTrigger. В URL вызова укажите имя вызываемого триггера.

Чтобы вызвать триггер с уникальным идентификатором MyCloudTrigger, вызовите следующий URL­адрес:

https://labelcloudapi.onnicelabel.com/TriggerApi/CloudTrigger/MyCloudTrigger

Для каждого события (выходных данных) во внешней бизнес-системе вызовите URL, как показано в примере. Каждый вызов запускает триггер облака, который работает на локальном сервере Automation.

Все вызовы API должны включать следующие два заголовка:

  • Api-Version — это версия используемого API. В настоящее время доступна только версия API v1.

  • Ocp-Apim-Subscription-Key — это ключ, который идентифицирует подписку.

Тестирование вызовов CloudTrigger

Чтобы вы лучше понимали работу вызовов CloudTrigger, портал разработчика позволяет тестировать такие вызовы.

Перед тестированием этого вызова необходимо настроить действующую конфигурацию Automation.

  1. Откройте портал разработчика, откройте вкладку Продукты и нажмите Label Cloud.

  2. Выберите Cloud Trigger API v1.

  3. Создайте образец для метода GET или POST. Нажмите соответствующую ссылку.

    • Выбрав метод, нажмите Проба. Открывается новая страница. triggerID уже добавлен в Параметры запроса.

    • В поле Значение скопируйте и вставьте triggerID, полученный от разработчика конфигурации Automation. Это уникальный идентификатор триггера. Уникальный идентификатор указан в разделеAutomation Builder > Настройки триггера > Общие.

      UUID-b2a4eb67-50bc-91d5-4b8c-709a50ee1587.png
  4. В разделе Проверка прав доступа выберите ключ подписки. Поскольку уже имеется как минимум одна заданная подписка, выпадающий список уже содержит ключ для заданной подписки. Выберите этот ключ — первичный или вторичный.

  5. Нажмите Отправить.

    • Состояние ответа: 200 OK.

Быстрая проверка работоспособности триггера

После настройки API NiceLabel Cloud на портале разработчика можно создать простую конфигурацию в Automation Builder для проверки работоспособности триггера. Если триггер работает, после нажатия кнопки Проба на странице API триггера облака отобразится сообщение «Триггер работает».

  1. Откройте Automation Builder и создайте новую конфигурацию. Убедитесь, что Automation Manager подключен к NiceLabel Cloud.

  2. Добавьте новый триггер облака.

  3. Укажите имя и описание, после чего задайте уникальный идентификатор. В этом примере используется уникальный идентификатор TestCloudTrigger.

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

    • Выберите текст/обычный для параметра Тип ответа.

    • Укажите данные ответа. Это ответ, который отображается в случае, если триггер работает. В качестве примера воспользуемся строкой «Триггер работает».

    • Укажите дополнительные заголовки. Используйте формат Heading:Value.

  5. Разверните конфигурацию.

  6. Откройте портал разработчика и перейдите на страницу Cloud Trigger API v1.

  7. Нажмите Проба.

  8. Вставьте TestCloudTrigger в поле triggerID. Нажмите Отправить.

    • Содержимое ответа будет включать подтверждение: «Триггер работает».

      UUID-7a2db5bb-633b-5b19-e8f2-16e863b1d8b3.png

Развертывание триггера облака с помощью локального Control Center

Настройка триггера облака в Automation Builder

В этом разделе описана процедура настройки триггера облака в приложении Automation, которое работает на локальном сервере.

  1. Откройте Automation Builder. Убедитесь, что приложение Automation Builder связано с Control Center. Для этого выберите Файл > Параметры > Control Center и проверьте, что указан URL-адрес вашего Control Center.

    Примечание

    «Связывание» Automation Builder и Control Center также означает, что оба приложения используют один и тот ключ лицензии.

  2. Откроется вкладка Элементы конфигурации. Нажмите Триггер облака, чтобы создать новую конфигурацию для триггера облака.

  3. Задайте Имя и Описание, чтобы можно было легко найти этот триггер среди других триггеров облака.

  4. Задайте настройки триггера в разделе Связь:

    • Укажите Уникальный идентификатор. После развертывания триггера этот уникальный идентификатор будет использован для регистрации триггера в Control Center. Используйте только буквенно-цифровые символы. Специальные символы не допускаются.

      При запуске конфигурации триггера облака на нескольких компьютерах проследите, чтобы каждый из них автоматически использовал свой собственный уникальный идентификатор. Чтобы избежать нежелательного дублирования, вставьте в уникальный идентификатор внутренние переменные. Для этого можно использовать две внутренние переменные:

      • ComputerName: имя компьютера, на котором запущена конфигурация.

      • SystemUserName: Имя пользователя Windows текущего пользователя, выполнившего вход.

      Чтобы вставить внутренние переменные в уникальный идентификатор, нажмите «Вставить источник данных» и выберите внутренние переменные.

      UUID-7905238a-2b2d-69c4-9856-247bdcb0320c.png
    • Подождите, пока закончится запуск триггера. Протокол HTTP требует, чтобы получатель (в данном случае NiceLabel Automation) отправил отправителю числовой ответ с указанием состояния полученного сообщения. По умолчанию NiceLabel Automation отправляет ответ с кодом 200. Это означает, что приложение Automation успешно получило данные, но ничего не говорит об успешности действий триггера.

      Этот параметр указывает, что триггер не отправляет ответ сразу после получения данных, а дожидается выполнения всех действий. Затем он отправляет код ответа, указывающий на успешное выполнение действия. Если этот параметр включен, можно выбрать настраиваемый ответ и указать отправляемые данные (например, в ответ на запрос HTTP можно отправлять изображение для предварительного просмотра этикетки в формате PDF).

      Встроенные стандартные коды ответа HTTP Automation для триггера облака:

      Код ответа HTTP

      Описание

      200

      Все действия выполнены успешно.

      400

      Нет доступных конфигураций.

      500

      При выполнении действий произошли ошибки.

      Примечание

      Чтобы отправить Automation обратную связь по процессу печати, включите синхронный режим печати. Дополнительные сведения см. в разделе Синхронный режим печати.

    • Тип ответа. Задает тип ответного сообщения. В выпадающем списке доступны часто используемые типы мультимедиа для Интернета (также известные как типы MIME или типы содержимого). Если в списке нет требуемого типа мультимедиа, введите его. Automation отправляет данные ответа как сообщение обратной связи в формате заданного типа мультимедиа. Переменная позволяет использовать переменные типы мультимедиа. Если параметр включен, выберите или создайте переменную, содержащую тип мультимедиа.

      Примечание

      Если не указать тип содержимого, NiceLabel Automation по умолчанию использует application/octet-stream.

    • Данные ответа. Содержимое ответного сообщения. Примеры данных, которые можно отправить обратно в виде ответа HTTP: собственные сообщения об ошибках, изображение этикетки для предварительного просмотра, сгенерированные файлы PDF, файлы потока печати (файлы очереди), файлы XML с информацией от механизма печати и изображением этикетки для предварительного просмотра (закодированный в виде строки Base64).

      Если выходные данные состоят только из двоичного содержимого (например, изображение этикетки для предварительного просмотра или поток печати), необходимо выбрать поддерживаемый тип мультимедиа, например image/jpeg или application/octet-stream.

    • Дополнительные заголовки. Позволяют задать собственные заголовки MIME для ответного сообщения HTTP.

      Синтаксис заголовка ответа и примеры приведены в разделе Действие «Запрос HTTP».

      Подсказка

      В разделах Данные ответа и Дополнительные заголовки можно использовать фиксированное содержимое, сочетание фиксированного и переменного содержимого или только переменное содержимое. Чтобы вставить переменное содержимое, нажмите кнопку со стрелкой справа от области данных и вставьте переменную из списка. Можно также создать новую переменную, содержащую нужные данные. Дополнительные сведения см. в разделе Использование составных значений.

  5. Разверните и запустите триггер в Automation Manager. Триггер облака начинает отслеживать входящие запросы.

Примечание

Если конфигурация требует повышенной доступности и масштабируемости, можно развернуть несколько одинаковых триггеров облака. Для этого установите несколько экземпляров Automation и разверните в них триггеры облака. Если развернутые триггеры облака имеют одинаковый Уникальный идентификатор, встроенный балансировщик нагрузки в NiceLabel Cloud автоматически распределяет трафик между ними.

Вызов триггера облака (локальное развертывание)

Этот шаг позволяет убедиться, что выходные данные внешних бизнес-систем успешно запускают триггеры облака, которые работают локально. Это цель операции CloudTrigger. В URL вызова укажите имя вызываемого триггера.

Чтобы вызвать триггер с уникальным идентификатором MyCloudTrigger, вызовите следующий URL­адрес:

https://<YourServerName>/epm/api/trigger/<MyCloudTriggerID>

Примечание

URL-адрес может начинаться с «http» или «https» (в зависимости от настройки Control Center во время установки). Подробнее см. в руководстве по установке Control Center в разделах, посвященных настройке веб-сайта и хранилища.

Для каждого события (выходных данных) во внешней бизнес-системе вызовите URL, как показано в примере. Каждый вызов запускает триггер облака, который работает на локальном сервере Automation.

Все вызовы должны включать заголовок Integrator-Key.

Пример 27. Пример

Ключ интегратора. 9d59d7d444da412b8acfb488a01bb632