DocGen SmartCOMM (предварительная версия)

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

Соединитель SmartCOMM on-Demand Doc-Gen включает предварительно созданную интеграцию для создания взаимодействия с клиентами omnichannel. Соединитель предоставляет вызовы веб-службы RESTful в SmartCOMM для вариантов использования по запросу.

Этот соединитель доступен в следующих продуктах и регионах:

Smart Communications™ — это ведущая облачная платформа для корпоративных коммуникаций клиентов. Как единственное облачное решение, назначающееся лидером в Gartner Magic Quadrant for Customer Communications Management, более 350 глобальных брендов - многие из самых строго регулируемых отраслей мира - полагаются на Smart Communications, чтобы сделать многоканавую связь клиентов более значимыми, а также помочь им упростить свои процессы и эффективно работать.

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

Соединитель поддерживает операцию SmartCOMM "GenerateDocument", которая создает ответ, включая выходные данные в кодировке Base64 байт[] . Выходные данные поддерживают различные типы выходных данных канала. (например, SMS, PRINT, TEXT, XML, TML, XSLFO, HTML)

Предпосылки

Чтобы использовать компонент SmartCOMM в Power Apps, вам потребуется выполнить несколько действий.

• План Microsoft Power Apps или Power Automate с пользовательским компонентом соединителя
• Экземпляр SmartCOMM, настроенный для вашей организации с доступом пользователей
• Чтобы настроить шаблон документа для создания документов, необходимо работать с контактом Smart Communications.
• Чтобы настроить параметры компонента, необходимо знать идентификатор ресурса селектора шаблонов BatchConfigResID или SmartCOMM. Обратитесь к контакту Smart Communications, чтобы помочь вам найти это.
• Настройка экземпляра SmartCOMM с помощью клиента OAuth 2.0 (тип предоставления кода авторизации)

Получение учетных данных

1. Обратитесь к администратору пользователя SmartCOMM, чтобы создать доступ к пользователю
2. После создания доступа пользователя вы получите сообщение электронной почты для активации учетной записи.
3. Следуйте инструкциям по активации учетной записи.
4. В потоке кода авторизации пользователь SmartCOMM, который владеет ресурсами в облаке SmartCOMM, разрешает клиентам доступ к учетной записи пользователя. Пользователи получат доступ к URL-адресу перенаправления для входа в клиент. Пользователи могут ввести имя пользователя и учетные данные, чтобы получить доступ к клиенту для первой попытки. (следующие попытки будут всплывать на кодовую страницу доступа напрямую)
5. Примите запрос для получения кода доступа, нажав кнопку "Принять"
6. Затем клиенты используют маркеры доступа для доступа к ресурсам, а не учетным данным пользователя.

Начало работы с соединителем

1. Укажите URL-адрес узла экземпляра SmartCOMM
2. Укажите сведения о клиенте OAuth 2.0: идентификатор клиента, секрет клиента, URL-адрес авторизации и URL-адрес маркера
3. Укажите СОЗДАННЫЙ URL-адрес перенаправления Power Apps (например, ) https://global.consent.azure-apim.net/redirect
4. Создание подключения к экземпляру SmartCOMM с помощью зарегистрированной учетной записи пользователя
   • Нам нужна полная настройка генератора документов в SmartCOMM, которая содержит по крайней мере селектор шаблона, шаблон и модель данных.
5. Создание соединителя
   • обязательные параметры:
     • Region
       • RegionServer для exmaple: eu10-sb
     • Идентификатор клиента
       • Он совпадает с сведениями о клиенте OAuth 2.0.
     • Секрет клиента
       • Он совпадает с сведениями о клиенте OAuth 2.0.
6. Укажите URL-адрес запроса для создания конечной точкиDocument. Например, https://< RegionServer.smartcommunications.cloud/one/oauth2/api/v10/job/generateDocument>
   • обязательные параметры:
     • Включение данных документа
       • Да, как обычно
     • transactionData (Json или XML)
       • не требуется кодировка Base64, так как она выполняется соединителем.
       • Он должен быть таким же форматом, как и в SmartComm
     • batchConfigResId
       • Идентификатор ресурса селектора шаблона Smartcomm
     • projectId
       • значение по умолчанию пустое, но должно быть заполнено, если проект SmartComm не выпущен
     • transactionRange
       • он может быть пустым, но при заполнении должен показать, какие индексы следует использовать из массива.
     • transactionDataType
       • application/json или application/xml
       • это формат параметра transactionData
     • Дополнительные параметры, такие как merge.pdf, можно прочитать в описании API SmartComm
       • <https:// server.smartcommunications.cloud/one/apiViewer/>
       • Где <используется сервер> Smart Communications (NA1.smartcommunications.cloud, EU1.smartcommunications.cloud и т. д.).
7. Соединитель SmartCOMM on Demand Generation создает обмен данными и возвращает ответ (включая выходные данные в кодировке Base64) в Power App.
   • Возвращает массив конверта, содержащий документы в кодировке Base64.
   • Документ обычно внутри documentEnvelope конверты><><основной <строки< данных>или данныхChannel><><>
8. Затем сообщения можно отобразить в Power App для скачивания, архивировать (например, контейнер SharePoint, S3) или отправить в службу доставки выходных данных, например SNS, Outlook, mailhouse и т. д.

Известные проблемы и ограничения

1. Ограничение скорости (обратитесь к администратору SmartCOMM для получения дополнительных сведений, так как это является частью лицензионного соглашения)
2. Отдельный максимальный размер запроса составляет 10 МБ

Распространенные ошибки и средства устранения неполадок

1. При использовании полезных данных JSON убедитесь, что "transactionDataType" задано значение application/json.
2. Убедитесь, что необходимо указать "projectId", если требуется ограничить область в проекте SmartCOMM
3. Убедитесь, что параметр includeDocumentData имеет значение true, если необходимо включить выходные данные th в ответ
4. См. раздел "Распространенные коды ошибок" ниже.

Распространенные коды ошибок

• HTTP 403— ошибка создания документа завершилась ошибкой. Эта ошибка возвращает идентификатор (код ошибки SmartCOMM) и ошибку msg (описание ошибки SmartCOMM)

• HTTP 500 — внутренняя ошибка сервера мы также рекомендуем в случае ошибки при вызове службы, ждать пять секунд до повтора. При нескольких непрерывных сбоях служба должна оповещать пользователей и перестать отправлять этот вызов, так как ваш запрос может быть недопустимым.

• HTTP 429 — слишком много запросов, если вы получаете ответ HTTP 429, следует ждать 60 секунд, а затем повторить запрос.

• HTTP 503 — служба недоступна ответ HTTP 503 отправляется во время обслуживания. Вы должны ждать 120 секунд, а затем повторить запрос. Периоды обслуживания могут длиться час или более во время обновления вехи.

Часто задаваемые вопросы

"Укажите разбивку часто задаваемых вопросов и их соответствующих ответов здесь. Это может охватывать часто задаваемые вопросы о взаимодействии с базовой службой или о самом соединителе.

• Где можно найти дополнительные сведения о службе GenerateDocument? — можно найти здесь — https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

• Шифруются ли данные с помощью этого соединителя? — Да, если httpS настроен, подключение будет зашифровано в конце.

• Как получить учетную запись пользователя SmartCOMM? — Обратитесь к администратору пользователя SmartCOMM.

• Какой тип авторизации? — OAuth 2.0

• Как получить идентификатор и секрет клиента OAuth2? — Обратитесь к администратору SmartCOMM или обратитесь к https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #EditClient.htm

• Как получить код авторизации? — Дополнительные сведения см. в разделе "Как получить учетные данные" выше.

• Как получить поддержку этого соединителя? - Обратитесь support@smartcommunications.com за всеми запросами в службу поддержки

• Где можно найти дополнительные сведения о продукте SmartCOMM? - https://www.smartcommunications.com

• Как получить пакетную конфигурациюConfigResId? — Обратитесь к SME SmartCOMM или обратитесь к https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Как получить идентификатор projectId? — Обратитесь к SME SmartCOMM или обратитесь к https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Как скоро я получаю ответ? — Время отклика может отличаться в зависимости от скорости сети, размера полезных данных и сложности ресурсов и т. д. SmartCOMM рекомендует запустить базовые показатели производительности для сбора максимального времени отклика и среднего времени отклика.

• Как получить выходные данные из ответа? — успешный ответ включает выходные данные в кодировке Base64 байт[]. Чтобы просмотреть выходные данные, необходимо выполнить действия, чтобы декодировать выходные данные байтов[] и сохранить копию в формате, указанном в mimeType. Дополнительные сведения см. в разделе https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

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

Ограничения регулирования

Действия

Создание документа