SmartCOMM DocGen （預覽版）

Smart Communications 是一家領先的科技公司，專注於幫助企業進行更有意義的客戶對話。

SmartCOMM 按需 Doc-Gen 連接器包括用於產生全通路客戶通訊的預建整合。 此連接器提供 SmartCOMM 的 RESTful Web 服務呼叫，以用於隨選使用案例。

此連接器適用於以下產品和區域：

Smart Communications™ 是領先的基於雲的企業客戶通信平台。 作為唯一在 Gartner 客戶溝通管理魔力象限中被評為領導者的雲端解決方案，超過 350 個全球品牌（其中許多來自全球監管最嚴格的行業）依靠智慧通訊使多通路客戶溝通更有意義，同時也幫助他們簡化流程並提高營運效率。

適用於 Power Apps 的 SmartCOMM 隨選連接器包含用於產生客戶通訊的預先建置整合。 此連接器提供 SmartCOMM 的 RESTful Web 服務呼叫，以用於隨選使用案例。

此連接器支援 SmartCOMM 的「GenerateDocument」作業，該作業會產生包含 base64 編碼的 byte[] 輸出的回應。 輸出支援不同類型的通道輸出。 （例如簡訊、列印、文字、XML、TML、XSLFO、HTML）

先決條件

若要在 Power Apps 中使用 SmartCOMM 元件，您需要先完成一些操作：

• 具有自訂連接器功能的 Microsoft Power Apps 或 Power Automate 方案
• 為您的組織設定的具有使用者存取權的 SmartCOMM 實例
• 您需要與您的 Smart Communications 聯絡人合作，設定文件範本以從中產生文件。
• 若要設定元件設定 - 您必須知道 'BatchConfigResID' 或 SmartCOMM 範本選取器資源識別碼。 請詢問您的智慧通訊聯絡人來協助您找到此資訊。
• 使用 OAuth 2.0 用戶端 （授權碼授與類型） 設定 SmartCOMM 執行個體

如何取得認證

1. 請聯絡您的 SmartCOMM 使用者管理員以建立您的使用者存取權
2. 建立使用者存取權限後，您將收到一封電子郵件以啟動您的帳戶
3. 按照說明啟動您的帳戶
4. 在「授權碼」流程中，擁有 SmartCOMM 雲端中資源的 SmartCOMM 使用者會授權用戶端存取其使用者帳戶。 使用者將存取重新導向 URL 以登入租用戶。 使用者可以輸入其使用者名稱和認證資料，以存取租用戶進行第一次嘗試。 （以下嘗試會直接彈出存取碼頁）
5. 按一下 [接受] 按鈕，以接受擷取存取碼的要求
6. 然後，用戶端會使用存取權杖來存取資源，而不是使用者的認證。

開始使用連接器

1. 提供 SmartCOMM 執行個體的主機 URL
2. 提供 OAuth 2.0 用戶端詳細資料 — 用戶端 ID、用戶端密碼、授權 URL 和權杖 URL
3. 提供 Power Apps 產生的重新導向 URL （例如 https://global.consent.azure-apim.net/redirect）
4. 使用已註冊的使用者帳戶建立與 SmartCOMM 執行個體的資料連線
   • 我們需要在 SmartCOM 上設置一個完整的文檔生成器設置，其中至少包含一個模板選擇器、一個模板和一個數據模型。
5. 建立連接器
   • 必要參數：
     • Region
       • 範例的 RegionServer：eu10-sb
     • 用戶端識別碼
       • 這與提供OAuth 2.0使用者端詳細資料中的相同
     • 用戶端密碼
       • 這與提供OAuth 2.0使用者端詳細資料中的相同
6. 提供 [要求 URL] 以 generateDocument 端點。 例如 https://< RegionServer.smartcommunications.cloud/one/oauth2/api/v10/job/generateDocument>
   • 必要參數：
     • 包含文件資料
       • 是的，像往常一樣
     • transactionData （Json 或 XML）
       • 不需要 base64 編碼，因為它是由連接器完成的
       • 它應該與 SmartComm 中的格式相同
     • batchConfigResId
       • Smartcomm 範本選取器的資源 ID
     • projectId
       • 預設為空，但未發布 SmartComm 專案時必須填寫
     • 交易範圍
       • 它可以是空的，但填寫時應該顯示應該從數組中使用哪些索引
     • transactionDataType
       • application/json 或 application/xml
       • 它是transactionData參數的格式
     • 額外的參數，如 merge.pdf 可以在 SmartComm API 描述中閱讀
       • https://< 伺服器>.smartcommunications.cloud/one/apiViewer/
       • 其中 <server> 是您正在使用的智慧通訊伺服器（NA1.smartcommunications.cloud、EU1.smartcommunications.cloud 等）。
7. SmartCOMM 隨選產生連接器會產生通訊，並將回應 （包括 base64 編碼的輸出） 傳回給 Power App
   • 傳回信封陣列，其中包含 base64 編碼的文件。
   • 文件通常位於 <documentEnvelope><信封內><envelope><primaryChannel><資料>字串</資料>
8. 然後，通訊可以顯示在 Power App 中以供下載、封存（例如 SharePoint、S3 儲存貯體）或推送到輸出傳遞服務，例如 SNS、Outlook、郵件站等。

已知問題與限制

1. 速率限制（請諮詢您的 SmartCOMM 管理員以了解更多詳細信息，因為這是許可協議的一部分）
2. 個別要求大小上限為 10MB

常見錯誤和補救措施

1. 使用 JSON 承載時，請確定 'transactionDataType' 設定為 'application/json'。
2. 當您想要限制 SmartCOMM 專案內的範圍時，請確定指定 'projectId'
3. 當您需要將輸出包含在回應中時，請確保將 'includeDocumentData' 設定為 true
4. 請參閱下面的常見錯誤代碼部分。

常見的錯誤碼

• HTTP 403 - 產生檔失敗此錯誤會傳回 'id' （SmartCOMM 錯誤碼） 和錯誤 'msg' （SmartCOMM 錯誤描述）

• HTTP 500 - 內部伺服器錯誤我們也建議您在呼叫服務時發生錯誤，請等待五秒鐘，然後再重試。 在多次連續失敗時，您的服務應該提醒使用者並停止提交該呼叫，因為您的要求可能無效。

• HTTP 429 - 請求太多如果您收到 HTTP 429 回應，您應該等待 60 秒，然後重試您的請求。

• HTTP 503 - 服務無法使用 HTTP 503 回應會在維護期間傳送。 您應該等待 120 秒，然後重試您的請求。 在里程碑升級期間，維護時段可能會持續一個小時或更長時間。

FAQ

“在此處提供常見問題的細分及其各自的答案。 這可以涵蓋有關與底層服務互動或連接器本身的常見問題解答。」

• 在哪裡可以找到有關「GenerateDocument」服務的更多資訊？ - 可以在這裡找到 - https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

• 是否使用此連接器加密資料？ - 是的，如果配置了 HTTPS，則連接將端到端加密。

• 如何取得 SmartCOMM 用戶帳戶？ - 聯絡您的 SmartCOMM 使用者管理員。

• 授權類型為何？ - OAuth 2.0

• 如何取得 OAuth2 用戶端 ID 和密碼？ - 請連絡您的 SmartCOMM 系統管理員，或參閱 https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #EditClient.htm

• 如何取得授權碼？ - 有關完整詳細信息，請參閱上面的“如何獲取憑據”部分。

• 如何取得此連接器的支援？ - 聯絡 support@smartcommunications.com 所有支援查詢

• 在哪裡可以找到有關 SmartCOMM 產品的更多資訊？ - https://www.smartcommunications.com

• 如何取得 batchConfigResId？ - 聯絡您的 SmartCOMM SME 或參閱 https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm。

• 如何取得 projectId？ - 聯絡您的 SmartCOMM SME 或參閱 https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm。

• 我多久會收到回覆？ - 回應時間可能會根據您的網路速度、有效負載大小和資源複雜性等而有所不同。SmartCOMM 建議執行效能基準，以收集最大回應時間及平均回應時間

• 如何從回應中取得輸出？ - 成功的回應包括 base64 編碼的 byte[] 輸出。 要查看輸出，必須採取措施解碼 byte[] 輸出並以“mimeType”中指定的格式保存副本。 更多詳情請參閱 https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

正在建立連線

連接器支援下列驗證類型：

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

節流限制

動作

產生文件