Обзор

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

Зависимости приложения

Ниже перечислены зависимости приложения Adobe Sign для ServiceNow.

  • Необходимые плагины

○ Orchestration

  • Требуются разрешения для доступа к системной таблице

○ Уведомление по электронной почте (sys_event_email_action)

○ Шаблоны сообщений электронной почты (sys_email_client_template)

○ Макеты сообщений электронной почты (sys_email_layout)

Инструкции по настройке

Установите приложение Adobe Sign для ServiceNow

После регистрации в приложении-коннекторе и/или его приобретения это приложение появится в меню «Системные приложения» в экземпляре ServiceNow.

app menu

После завершения установки появятся два новых меню приложений на навигационной панели слева — «Adobe Sign» и «Администрирование Adobe Sign».

Меню слева — это меню (страница) пользователя, а справа — это страница администратора.

user menu
Admin Menu


Автоматическое обновление запланированных задач

Запланированная задача с именем Adobe Sign — автоматическое обновление документов была создана. Она позволяет обновлять документы, сохраненные в таблице Документы Adobe Sign.  По умолчанию эта задача запускается ежедневно в час ночи.  Эту настройку можно изменить в соответствии с требованиями.


MID Server и файл Jar

Чтобы упростить процедуру подписания вложенных документов используется приложение MID Server вместе с двумя пользовательскими файлами Jar (см. ниже).  Если у вас нет MID Server, следуйте инструкциям по настройке, предоставленным ServiceNow (см. здесь).

После установки приложения MID Server убедитесь, что оно настроено как сервер по умолчанию для Orchestration.  В меню «Orchestration» перейдите в раздел Mid Server Properties (Свойства MID Server) и введите имя сервера MID Server в поле Default Mid Server to use for Orchestration activities (Сервер MID Server, используемый по умолчанию для операций Orchestration).  

Mid Server

Существуют два пользовательских файла Jar, которые необходимо развернуть в приложении MID Server.

  • JSON Simple
  • MultiPartFileUpload

Загрузить

Процедура установки описана здесь.

Убедитесь, что приложение MID Server перезапустилось (эта операция выполняется автоматически).

Примечание.

Обе ссылки wiki, указанные выше, относятся к версии Istanbul.  Процедура установки может немного отличаться в зависимости от запущенной версии ServiceNow.


Пользователи/роли

Приложение поддерживает две роли: «x_desci_adobesign_admin» и «x_desci_adobesign_user».  Любой пользователь с ролью «x_desci_adobesign_admin» имеет полный доступ ко всем функциям, а также к меню для пользователей и администраторов.  

Пользователи с ролью «x_desci_adobesign_user» имеют только доступ к пользовательским меню Adobe Sign и элементам образца каталога.


Условия успеха/сбоя для операций настраиваемого рабочего процесса

Все операции настраиваемого рабочего процесса разработаны с выходным значением «result» (результат).  По умолчанию это выходное значение соответствует значению результата операции: 

  • Если ошибки нет (activityOutput.result==null), то операции продолжаются как успешные. 
  • Состояние ошибки (activityOutput.result!=null)) приводит к регистрации соответствующей ошибки в журнале; при этом рабочий процесс закрывается незавершенным. 

Обработка состояния «сбой» настраивается пользователем: уведомление может быть отправлено, задача может быть добавлена для обзора технического ресурса и т. д.  


Пользовательские поля задачи

Три пользовательских поля добавлены в таблицу задач. При необходимости они могут быть добавлены в пользовательский список Adobe Sign для отображения состояния документа и сведений о нем для конечного пользователя в более удобном оформлении.  Поля:

  • Статус документа (x_desci_adobesign_document_status) — статус документа (на основе статуса в Adobe Sign).  Те же значения отображаются в поле «Статус документа» и соответствуют статусам в Adobe Sign.
  • URL-адрес документа (x_desci_adobesign_document_url) — URL-адрес документа соглашения в Adobe Sign
  • ID соглашения (x_desci_adobesign_agreement_id) — уникальный ID соглашения 

Для получения более подробной информации о создании пользовательского списка нажмите здесь

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

Внимание.

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

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

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

Снимок экрана-образца представлен ниже:

Task Fields

Подключения внешних систем

Приложение Adobe Sign для ServiceNow требует наличия учетной записи Adobe Sign для упрощения взаимодействия между приложением-коннектором и ServiceNow.  


Подключение учетной записи Adobe Sign к ServiceNow

Учетная запись Adobe Sign требуется для взаимодействия ServiceNow с сервисом электронных подписей.  Если у вас нет учетной записи, получите в Adobe Sign.

После создания учетной записи создайте связь между ServiceNow и Adobe Sign, нажав ссылку Подключиться к Adobe в меню «Администрирование Adobe Sign».

Connect1

После этого откроется страница подключения.

7Connect2-rebranded

 

  • Нажмите кнопку Подключиться, чтобы установить доверенные отношения с Adobe Sign.
    • Откроется страница входа в Adobe Sign, на которой необходимо выполнить вход и предоставить постоянный доступ.
8login-rebrand
  • Выполните аутентификацию в Adobe Sign с использованием учетной записи администратора Adobe Sign.
    • Панель обновится, и отобразится запрос на подтверждение установления доверенных отношений.
9Trust-rebrand
  • Подтвердите доступ, нажав кнопку Разрешить доступ.

После выполнения этой операции появится сообщение Подключение к Adobe Sign завершено (см. ниже) при нажатии ссылки Подключиться к Adobe Sign.

 

10Connect 4-rebrand

Теперь сервис Adobe Sign подключен к ServiceNow. 


Проверка конфигурации

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

Демонстрационные элементы каталога / рабочие процессы

Будут созданы демонстрационные элементы каталога и рабочие процессы, которые демонстрируют использование пользовательских рабочих процессов.  Это полноценные примеры настройки элементов и рабочих процессов для использования приложения Adobe Sign для ServiceNow.


Элементы каталога

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

Примечание.

Необходимо ввести адреса электронной почты, разделенные запятой (email1@email.com, email2@email.com и т. д.). Запросы на получение подписи будут отправлены в соответствии с порядком ввода адресов электронной почты.

  • Adobe Sign — Запрос на подписание — позволяет автору запроса выбрать существующий документ (на локальном жестком диске или в библиотеке документов в Adobe Sign) и отправить одному или нескольким пользователям на подпись. Эту операцию можно настроить, чтобы отправлять документ «как есть» (незамедлительно) или вначале предварительно просмотреть документ в интерфейсе отправки в Adobe Sign.
  • Adobe Sign — Запрос на подписание W9 — отправка определенного документа на подпись (в данном случае — формы W9); при этом пользователю не требуется указывать дополнительные данные.  На этом примере показано, как приложение-коннектор может отправлять определенные документы, не требуя от пользователя выполнять поиск или прикреплять документ к запросу.  Характеристики документа добавляются в операцию пользовательского рабочего процесса.


Процессы

Два демонстрационных рабочих процесса будут установлены вместе с приложением.  Эти рабочие процессы также имеют пользовательские значения этапов, соответствующие статусу документа в Adobe Sign.  В настоящее время используются только некоторые из этих значений, однако другие значения могут быть использованы в следующих версиях приложения. 

Adobe Sign — Запрос на подписание — связано с элементом каталога «Adobe Sign — запрос подписи» и демонстрирует четыре различных сценария использования приложения-коннектора для отправки документа на подпись.

  • Использовать существующий документ с предпросмотром — отправляет документ, выбранный в раскрывающемся списке, после предварительного просмотра автором запроса.  После отправки автор запроса получает сообщение электронной почты со ссылкой на созданный документ (см. Уведомления по электронной почте).  После проверки документа пользователем он будет последовательно отправлен (в порядке ввода адресов электронной почты) всем получателям на подпись.  После подписания соглашения оно прикрепляется к завершенному запрошенному элементу.
  • Использовать существующий документ без предпросмотра — после отправки отправляет документ, выбранный в раскрывающемся списке, на все адреса электронной почты (в порядке ввода адресов).  Предварительный просмотр документа не выполняется. После подписания соглашения оно прикрепляется к завершенному запрошенному элементу.
  • Прикрепить документ с предпросмотром — отправляет прикрепленный документ после его просмотра автором запроса.  После отправки автор запроса получает сообщение электронной почты со ссылкой на созданный документ (см. Уведомления по электронной почте).  После проверки документа пользователем он будет последовательно отправлен (в порядке ввода адресов электронной почты) всем получателям на подпись.  После подписания соглашения оно прикрепляется к завершенному запрошенному элементу.
  • Прикрепить документ без предварительного просмотра — после отправки отправляет документ, выбранный в раскрывающемся списке, на все адреса электронной почты (в порядке ввода адресов).  Предварительный просмотр документа не выполняется. После подписания соглашения оно прикрепляется к завершенному запрошенному элементу.

 

Adobe Sign — Запрос на подписание определенного документа — связано с элементом каталога «Adobe Sign — Запрос на подписание W9», демонстрирует использование приложения-коннектора для отправки документа через рабочий процесс, а также для предоставления автору запроса определенного документа.  Следующие два сценария проиллюстрированы в данном рабочем процессе:

  • Отправка указанного в рабочем процессе документа с предварительным просмотром — отправляет документ, указанный в рабочем процессе, после предварительного просмотра автором запроса.  После отправки автор запроса получает сообщение электронной почты со ссылкой на созданное соглашение.  После проверки документа пользователем он будет последовательно отправлен (в порядке ввода адресов электронной почты) всем получателям на подпись.  После подписания соглашения оно прикрепляется к завершенному запрошенному элементу.
  • Отправка указанного в рабочем процессе документа без предварительного просмотра — после отправки отправляет документ, указанный в рабочем процессе, на все введенные адреса электронной почты.  Предварительный просмотр документа не выполняется. После подписания соглашения оно прикрепляется к завершенному запрошенному элементу.


Операции пользовательского рабочего процесса

Операции пользовательского рабочего процесса созданы для упрощения процедуры подписания документов.  В зависимости от выбранной операции («прикрепить документ», «использовать существующий», «с предварительным просмотром или без него» и т. д.), операция может измениться для обработки запроса.  Все пользовательские операции указаны ниже; они используются хотя бы один раз в двух примерах рабочих процессов, входящих в комплект.

Примечание.

Если пользовательские операции не отображаются, как показано ниже, см. раздел Устранение неполадок для исправления ошибки.

  • Adobe Sign — Отправить выбранные, Предварительный просмотр — используется, если переменная «adobe_preview» имеет значение yes, а переменная «adobe_attach_or_existing» имеет значение no.  Отправляет выбранный документ («adobe_lib_doc») на адреса электронной почты в разделе «adobe_email_address» для подписи после предварительного просмотра и отправки автором запроса.
  • Adobe Sign — Отправить выбранные, Без предварительного просмотра — используется, если переменная «adobe_preview» имеет значение no и переменная «adobe_attach_or_existing» имеет значение no.  Отправляет выбранный документ («adobe_lib_doc») на адреса электронной почты в разделе «adobe_email_address» для подписи после отправки запроса без предварительного просмотра.
  • Adobe Sign — Отправить вложение, Предварительный просмотр — используется, если переменная «adobe_preview» имеет значение yes и переменная «adobe_attach_or_existing» имеет значение yes. Отправляет прикрепленный документ на адреса электронной почты в разделе «adobe_email_address» для подписи после предварительного просмотра и отправки автором запроса.
  • Adobe Sign — Отправить вложение, Без предварительного просмотра — используется, если переменная «adobe_preview» имеет значение no, а переменная «adobe_attach_or_existing» имеет значение yes.  Отправляет выбранный документ («adobe_lib_doc») на адреса электронной почты в разделе «adobe_email_address» для подписи после отправки запроса без предварительного просмотра.
  • Adobe Sign — Получить данные вложения — используется, если переменная «adobe_attach_or_existing» имеет значение yes.  Собирает данные соглашения и использует пользовательский файл Jar и сервер MID Server для преобразования в составной формат / формат формы. 
  • Adobe Sign — Отправка документа X, Без предварительного просмотра — используется, если документ предварительно настроен и переменная «adobe_preview» имеет значение no.  Входной параметр «adobe_lib_doc» содержит имя отправляемого соглашения.  Значение имени указано в таблице «Документы Adobe Sign».  В данном примере осуществляется отправка документа W-9, при этом для параметра «adobe_agreement_name» устанавливается значение по умолчанию «Запрос на подписание формы W9».
  • Adobe Sign — Отправка документа X, Предварительный просмотр — используется, если документ предварительно настроен и переменная «adobe_preview» имеет значение yes.  Входной параметр «adobe_lib_doc» содержит имя отправляемого соглашения.  Значение имени указано в таблице «Документы Adobe Sign».  В данном примере элемента/рабочего процесса осуществляется отправка документа W-9, при этом для параметра «adobe_agreement_name» устанавливается значение по умолчанию «Запрос на подписание формы W9»
  • Adobe Sign — Прикрепить подписанное соглашение — эта операция возвращает подписанный документ из Adobe Sign и прикрепляет к текущей записи.  Эту операцию рекомендуется выполнять, если документ был выбран или прикреплен автором запроса, но НЕ тогда, когда определенный документ был встроен в запрос.  В этом случае следует использовать операцию «Adobe Sign — Прикрепить подписанное соглашение X». 
  • Adobe Sign — Прикрепить подписанное соглашение — эта операция возвращает подписанный документ из Adobe Sign и прикрепляет к текущей записи.  Эту операцию рекомендуется выполнять, если документ был выбран или прикреплен автором запроса, но НЕ тогда, когда определенный документ был встроен в запрос.
  • Adobe Sign — Прикрепить подписанное соглашение Х — эта операция возвращает подписанный предварительно настроенный документ из Adobe Sign и прикрепляет к текущей записи.


Уведомления по электронной почте

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

  • Adobe Sign — Запрос открыт — отправляется при запросе предварительного просмотра (переменная «adobe_preview» имеет значение yes), если элемент является одним из демонстрационных элементов.  Уведомление содержит ссылку на соглашение, которое требуется проверить.  

ПРИМЕЧАНИЕ. При создании других уведомлений необходимо добавить URL-адрес документа для проверки автором запроса.  Эта ссылка также содержится в форме RITM; ее можно добавить для других пользователей путем добавления поля «URL-адрес документа» в представление формы.

  • Adobe Sign — Запрос отменен — отправляется, если элемент является одним из двух демонстрационных элементов каталога, состояние имеет значение «Закрыто незавершенным», а этап имеет значение «Прервано».
  • Adobe Sign — Запрос закрыт — отправляется, если элемент является одним из двух демонстрационных элементов каталога, состояние имеет значение «Закрыто завершенным», а этап имеет значение «Подписано».

При переходе к одной из этих записей можно просмотреть примеры шаблонов и пример макета.

Настройка запланированной задачи автоматического обновления

Запланированная задача, автоматически обновляющая таблицу Документы Adobe Sign, предварительно настроена для запуска в час ночи (локальное системное время). Настройки этой задачи можно изменить для выполнения в любое время, ежедневно, еженедельно или непрерывно.

Для изменения задачи перейдите в меню Администрирование Adobe Sign, затем разверните пункт Настройка обновления документов и нажмите Задача автоматического обновления документов.

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

При нажатии Выполнить сейчас задача будет сразу же однократно запущена.

AutoRefresh panel

Поддержка и устранение неполадок

Контактные данные службы поддержки

Справочная документация и ссылки доступны в меню для пользователей и администраторов.  Указанный ниже веб-сайт также содержит контактные данные службы поддержки


Устранение неполадок

Ниже представлено несколько распространенных проблем, которые могут возникнуть при настройке и использовании Adobe Sign для ServiceNow.

Имена переменных элементов каталога — имена переменных, используемые в двух элементах образцового каталога, имеют большое значение для работы приложения-коннектора.  Они широко используются в операциях пользовательского рабочего процесса, и любое изменение может привести к ошибкам рабочего процесса.  При изменении имен переменных необходимо соответствующим образом изменить данные во всех операциях Adobe Sign, используемых рабочим процессом.

Ошибка подключения при попытке перехода по ссылке «Подключиться к Adobe Sign» (только для администраторов) — при появлении экрана с ошибкой подключения (см. ниже) необходимо попытаться повторно подключиться в соответствии с процедурой, указанной в разделе Подключение учетной записи Adobe Sign к ServiceNow .  Кроме того, необходимо убедиться, что учетные данные Adobe Sign правильные.

Error Gump-rebrand

 

Операции с вложениями выполняются с ошибками — правильное выполнение операций с вложениями зависит от подключения к серверу MID Server.  Убедитесь, что сервер MID Server настроен и запущен, а файл Jar правильным образом установлен.  Если ошибки по-прежнему возникают, убедитесь, что все имена переменных указаны правильно (см. выше).

Ошибки ID соглашения при отправке запроса — ошибки ID соглашения могут возникать, если документы, указанные в таблице «Документ Adobe Sign» / меню «Мои документы», принадлежат другой учетной записи Adobe Sign.  Несмотря на то, что имена демонстрационных документов, предоставленных Adobe, могут совпадать, они имеют разные ID соглашений в учетной записи. Если прикрепленная учетная запись Adobe изменится, необходимо обновить документ с помощью функции «Обновить список документов» в меню Adobe Sign.

Параметры меню отображаются (не отображаются) для пользователей — убедитесь, что все пользователи, которым нужен доступ к приложению, имеют правильные назначенные роли.  При использовании групп они также должны иметь прикрепленные роли.

Нет ошибок, однако получатели сообщений электронной почты не получают запросы на подпись — убедитесь, что введенные адреса электронной почты разделены запятыми. Правильный формат: email1@email.com, email2@email.com, email3@email.com и т. д.

Операции пользовательского рабочего процесса не отображаются надлежащим образом в редакторе рабочих процессов — в настоящее время существует ошибка, влияющая на отображение операций пользовательского рабочего процесса.  Проблема обычно возникает после обновления до приложения AdobeSign для ServiceNow.  Если операции не отображаются, выполните указанные ниже действия для исправления ошибки.

  • Перейдите в таблицу «wf_element”activity» путем ввода wf_element_activity.list в строке поиска на левой навигационной панели
1_navigate_to_wfelement

Будет показан список всех операций рабочего процесса, в том числе глобальных.

  • Примените к списку фильтр, чтобы отобразить только операции Adobe Sign (фильтр «application = AdobeSign»)
2_filter_using_adobesign

После применения фильтра к списку для отображения только операций AdobeSign будут показаны все версии перечисленных операций. Если пользовательские операции не были добавлены, количество должно составлять приблизительно 320 (см. снимок экрана)

  • Нажмите любую запись об операции, чтобы открыть ее, затем нажмите кнопку «гамбургер» на заголовке записи и выберите Версии
3_select_versions

 

Откроется список версий.

4_versions_list

 

  • Можно отсортировать список версий по номеру версии, затем можно открыть последнюю запись о версии.  В данном примере последняя версия — 10; именно эта запись будет отредактирована 

Обратите внимание, что несмотря на номер версии (10), она имеет состояние «Published = false».  В этом заключается причина проблемы, которую требуется устранить с помощью временного решения.  Даже несмотря на наличие операций, последняя запись версии не имеет состояния «Published=true», поэтому она не отображается в редакторе рабочих процессов, доступном пользователю.

5_version_10
  • Установите для последней версии значение «true», дважды нажав поле «Опубликовано» и изменив значение с «false» на «true»
  • Повторите эту процедуру для каждой пользовательской операции
    • При выполнении этой процедуры можно с помощью фильтра скрыть исправленные операции в основном списке.

Примечание.

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

Добавление связанного списка в представление

Добавление связанных списков в представление

  • Нажмите значок «гамбургер» (так же, как для отображения версий в примере выше), затем выберите Настройка > Связанные списки.  
1_choose_relatedlist
  • Переместите связанный список в разделе Версия -> Определение элемента в поле Выбрано
  • Нажмите Сохранить.
2_add_version_-_elementdefinition

Это действие добавляет связанные списки в форму; его необходимо выполнять только один раз для всех записей.

Теперь можно дважды нажать активное поле и установить значение «true».

3_related_list_exposed


Ссылки


Загружаемая версия

Загрузить

Эта работа лицензируется в соответствии с лицензией Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported  На посты, размещаемые в Twitter™ и Facebook, условия Creative Commons не распространяются.

Правовые уведомления   |   Политика конфиденциальности в сети Интернет