SmartCOMM DocGen (プレビュー)
Smart Communications は、企業がより有意義な顧客との会話を行えるよう支援することに重点を置いた大手テクノロジー企業です。
SmartCOMM オンデマンド Doc-Gen コネクタには、オムニチャネルの顧客コミュニケーションを作成するための事前構築済みの統合が含まれています。 このコネクタは、オンデマンドのユースケース向けに SmartCOMM への RESTful Web サービス呼び出しを提供します。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Smart Communications サポート |
| [URL] | http://support.smartcommunications.com |
| メール | support@smartcommunications.com |
| Connector Metadata | |
|---|---|
| 発行者 | Smart Communications |
| Web サイト | https://www.smartcommunications.com |
| プライバシー ポリシー | https://www.smartcommunications.com/external-privacy-policy |
| カテゴリー | Communication;コンテンツとファイル |
Smart Communications™ は、エンタープライズ カスタマー コミュニケーション向けの主要なクラウドベースのプラットフォームです。 Customer Communications Management 用 Gartner’s Magic Quadrant でリーダーとしてランク付けされた唯一のクラウド ソリューションとして、350 を超えるグローバル ブランド (その多くは世界で最も規制の厳しい業界) がスマート コミュニケーションを利用して、マルチチャネルの顧客コミュニケーションをより有意義なものにすると同時に、プロセスの簡素化と運用の効率化を支援しています。
Power Apps 向け SmartCOMM オンデマンド コネクタには、顧客コミュニケーションを作成するための事前構築済みの統合が含まれています。 このコネクタは、オンデマンドのユースケース向けに SmartCOMM への RESTful Web サービス呼び出しを提供します。
このコネクタは、base64 でエンコードされた byte[] 出力を含む応答を生成する SmartCOMM 'GenerateDocument' 操作をサポートします。 出力は、さまざまなタイプのチャネル出力をサポートしています。 (例: SMS、PRINT、TEXT、XML、TML、XSLFO、HTML)
前提条件
Power Apps の SmartCOMM コンポーネントを使用するには、最初にいくつかのことを完了する必要があります。
- カスタム コネクタ機能を備えた Microsoft Power Apps または Power Automate プラン
- ユーザー アクセスを使用して組織用に設定された SmartCOMM インスタンス
- ドキュメントを生成するためのドキュメント テンプレートを設定するには、Smart Communications の担当者と協力する必要があります。
- コンポーネント設定を構成するには、'BatchConfigResID' または SmartCOMM テンプレート セレクターのリソース ID を知る必要があります。 これを見つけるには、Smart Communications の担当者にお問い合わせください。
- OAuth 2.0 クライアントを使用して SmartCOMM インスタンスをセットアップする (認証コード付与タイプ)
資格情報の入手方法
- SmartCOMM ユーザー管理者に連絡して、ユーザー アクセスを作成してください
- ユーザーアクセスが作成されると、アカウントを有効にするためのメールが届きます
- 指示に従ってアカウントを有効化します
- 承認コード フローでは、SmartCOMM クラウド内のリソースを所有する SmartCOMM ユーザーが、クライアントがユーザー アカウントにアクセスすることを承認します。 ユーザーはリダイレクト URL にアクセスしてテナントにログインします。 ユーザーは、自分のユーザー名と資格証明を入力して、最初の試行でテナンシにアクセスできます。 (次の試行では、アクセス コード ページが直接ポップアップ表示されます)
- [承認] ボタンをクリックして、アクセス コードを取得する要求を受け入れます
- その後、クライアントは、ユーザーの資格情報ではなく、アクセス トークンを使用してリソースにアクセスします。
コネクタの使用を開始する
- SmartCOMM インスタンスのホスト URL を入力します
- OAuth 2.0 クライアントの詳細 (クライアント ID、クライアント シークレット、認証 URL、トークン URL) を提供します
- Power Apps生成のリダイレクト URL (例:https://global.consent.azure-apim.net/redirect) を提供します
- 登録済みのユーザー アカウントを使用して SmartCOMM インスタンスへのデータ接続を作成する
- SmartCOMM では、少なくともテンプレート セレクター、テンプレート、およびデータ モデルを含む完全なドキュメント ジェネレーターのセットアップが必要です。
- コネクタの作成
- 必須パラメーター:
- Region
- RegionServer: 例: eu10-sb
- クライアント ID
- これは、OAuth 2.0 Client の詳細提供と同じです
- Client Secret
- これは、OAuth 2.0 Client の詳細提供と同じです
- Region
- 必須パラメーター:
- generateDocument エンドポイント へのリクエスト URL を提供します。 E.g. https://.smartcommunications.cloud/one/oauth2/api/v10/job/generateDocument
- 必須パラメーター:
- ドキュメント データを含める
- はい、いつも通り
- transactionData (Json または XML)
- コネクタによって行われるため、base64 エンコーディングは不要です
- SmartComm と同じ形式にする必要があります
- batchConfigResId
- Smartcomm テンプレート セレクターのリソース ID
- projectId
- 既定は空ですが、SmartComm プロジェクトがリリースされていない場合は入力する必要があります
- transactionRange
- 空にすることもできますが、入力すると、配列からどのインデックスを使用する必要があるかが表示されます
- transactionDataType
- application/json または application/xml
- これは transactionData パラメーターの形式です
- Merge.pdf のような追加のパラメーターは、SmartComm API 説明で読み取ることができます
- https://.smartcommunications.cloud/one/apiViewer/
- は、使用しているスマート コミュニケーション サーバーです (NA1.smartcommunications.cloud、EU1.smartcommunications.cloud など)。
- ドキュメント データを含める
- 必須パラメーター:
- SmartCOMM オンデマンド生成コネクタは、通信を生成し、応答 (base64 でエンコードされた出力を含む) を Power App に返します
- base64 でエンコードされたドキュメントを含むエンベロープ配列を返します。
- ドキュメントは、通常 文字列 内にあります
- コミュニケーションは、Power App に表示してダウンロードし、アーカイブ (例: SharePoint、S3 バケット)、または出力配信サービス (SNS、Outlook、メールハウスなど) にプッシュされます。
既知の問題と制限事項
- レート制限 (これはライセンス契約の一部であるため、詳細については SmartCOMM 管理者に確認してください)
- 個々の最大リクエスト サイズは 10MB です
一般的なエラーと解決策
- JSON ペイロードを使用する場合は、'transactionDataType' が 'application/json' に設定します。
- SmartCOMM プロジェクト内で範囲を限定したい場合は、'projectId' を指定します
- 出力を応答に含める必要がある場合は、'includeDocumentData' を true に設定します
- 以下の一般的なエラー コードのセクションを参照してください。
一般的なエラー コード
HTTP 403 - ドキュメントの生成に失敗しました。このエラーは、'id' (SmartCOMM エラー コード) とエラー 'msg' (SmartCOMM エラーの説明) を返します
HTTP 500 - 内部サーバー エラー サービスを呼び出したときにエラーが発生した場合は、5 秒待ってから再試行することをお勧めします。 複数回連続して失敗した場合、リクエストが無効である可能性があるため、サービスはユーザーに警告し、その呼び出しの送信を停止する必要があります。
HTTP 429 - 要求が多すぎる HTTP 429 応答を受け取った場合は、60 秒待ってから要求を再試行する必要があります。
HTTP 503 - サービスを利用できません メンテナンス中に HTTP 503 応答が送信されます。 120 秒待ってから、リクエストを再試行してください。 マイルストーン アップグレード中は、メンテナンス ウィンドウが 1 時間以上かかる場合があります。
よくあるご質問
'ここに、よくある質問とそれぞれの回答の詳細を示します。 これは、基盤となるサービスとの対話、またはコネクタ自体に関する FAQ をカバーできます。'
'GenerateDocument' サービスの詳細情報はどこで入手できますか? - こちらで見つけることができます -https:// .smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job
このコネクタを使用してデータは暗号化されますか? - はい、HTTPS が設定されている場合、接続はエンドツーエンドで暗号化されます。
SmartCOMM ユーザー アカウントを取得するにはどうすればよいですか? - SmartCOMM ユーザー管理者に連絡してください。
承認タイプとは? - OAuth 2.0
OAuth2 クライアント ID とシークレットを取得するにはどうすればよいですか? - SmartCOMM 管理者に連絡するか、https:// .smartcommunications.cloud/one/help/oneplatform/en/index.htm#EditClient.htm を参照してください
認証コードを取得するにはどうすればよいですか? - 詳細については、上記のセクション '資格情報の取得方法' を参照してください。
このコネクタのサポートを受けるにはどうすればよいですか? - サポートに関するお問い合わせはすべて、support@smartcommunications.com までお問い合わせください
SmartCOMM 製品に関する詳細情報をどこで確認できますか? - https://www.smartcommunications.com
batchConfigResId を取得するにはどうすればよいですか? - SmartCOMM SME に連絡するか、https:// .smartcommunications.cloud/one/help/oneplatform/en/index.htm#ResourceProperties.htm を参照してください
projectid を取得するにはどうすればよいですか? - SmartCOMM SME に連絡するか、https:// .smartcommunications.cloud/one/help/oneplatform/en/index.htm#ResourceProperties.htm を参照してください
返事はどれくらいで届きますか？ - 応答時間は、ネットワーク速度、ペイロード サイズ、リソースの複雑さなどによって異なります。SmartCOMM では、パフォーマンス ベースラインを実行して、最大応答時間と平均応答時間を収集することをお勧めします
応答から出力を取得するにはどうすればよいですか? - 成功した応答には、base64 でエンコードされた byte[] 出力が含まれます。 出力を表示するには、byte[] 出力をデコードし、"mimeType" で指定された形式でコピーを保存するアクションを実行する必要があります。 - 詳細は、https:// .smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job を参照してください
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | Description | Required |
|---|---|---|---|
| Region | string | スマートコミュニケーション リージョンに入る | True |
| クライアント ID | string | OAuth Client Id の入力 | True |
| Client Secret | string | OAuth クライアント シークレットを入力 | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| ドキュメントを生成 |
この機能により、PDF ドキュメントが生成されます。 |
ドキュメントを生成
この機能により、PDF ドキュメントが生成されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント データを含める
|
includeDocumentData | True | boolean |
生成されたドキュメント データを直接提供する必要があるかどうかを決定するブール フラグ。 使用できる値は True または false です。 true の場合、各チャネルの結果に対して base64 データが提供されます。 false の場合、チャネルの結果ごとにデータを取得するための URL が提供されます。 応答で返されるドキュメント データは、Base64 でエンコードされます。 |
|
projectId
|
projectId | integer |
リクエストの実行範囲を限定するために使用される CMS プロジェクト ID。 この値が指定されていない場合、ジョブは運用モードで実行されます。 |
|
|
transactionData
|
transactionData | True | string |
サンプル データを使用します。 |
|
batchConfigResId
|
batchConfigResId | True | integer |
テンプレート セレクター リソースの CMS ID。 テンプレート セレクターは、トランザクション データをテンプレートおよびデータ モデルにマップするために使用されます。 |
|
transactionRange
|
transactionRange | integer |
transactionRange |
|
|
transactionDataType
|
transactionDataType | string |
トランザクション データのコンテンツ タイプを選択します。 'application/xml' または 'application/json' にすることができます。 デフォルトは 'application/xml' です。 |
|
|
名称
|
name | string |
プロパティの名前。 |
|
|
価値
|
value | string |
プロパティ値。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
例外
|
exceptions | array of object |
例外 |
|
classId
|
exceptions.classId | integer |
ビジネス例外のコード。 |
|
id
|
exceptions.id | integer |
ビジネス例外の固有 ID。 |
|
className
|
exceptions.className | string |
ビジネス例外の説明。 |
|
msg
|
exceptions.msg | string |
ユーザー定義の例外メッセージ。 |
|
previewKey
|
previewKey | string |
キーは、ドキュメント パーツを取得するために使用されます。 リクエストで includeDocumentData が true に設定されている場合は使用されません。 |
|
numberTransactions
|
numberTransactions | integer |
ジョブで発生したトランザクションの数。 |
|
dataModelValuesLocation
|
dataModelValuesLocation | string |
データ モデル値部分への参照。 |
|
envelopes
|
envelopes | array of object |
エンベロープ |
|
startpage
|
envelopes.primaryChannel.startPage | integer |
マージされたプライマリ印刷ドキュメントに含まれるドキュメントの開始ページ番号。 |
|
pageCount
|
envelopes.primaryChannel.pageCount | integer |
生成したドキュメントのページ数。 |
|
channelType
|
envelopes.primaryChannel.channelType | integer |
チャネルのタイプ。 可能なタイプは次の通りです: '1' TYPE_HTML '2' TYPE_PRINT '3' TYPE_SMS '4' TYPE_TEXT '5' TYPE_TML '6' TYPE_XML '7' TYPE_WORDML '8' TYPE_XSLFO. |
|
channelName
|
envelopes.primaryChannel.channelName | string |
チャネル名。 |
|
properties
|
envelopes.primaryChannel.properties | array of object |
properties |
|
名称
|
envelopes.primaryChannel.properties.name | string |
名称 |
|
価値
|
envelopes.primaryChannel.properties.value | string |
価値 |
|
データ
|
envelopes.primaryChannel.data | string |
Base64 としてエンコードされたドキュメント データ リクエストで includeDocumentData が true に設定されている場合のみ入力されます。 |
|
documentName
|
envelopes.primaryChannel.documentName | string |
生成したドキュメント セットの名前。 |
|
mimeType
|
envelopes.primaryChannel.mimeType | string |
ドキュメントのコンテンツ タイプです。 |
|
channelId
|
envelopes.primaryChannel.channelId | integer |
ドキュメントのチャネル ID。 |
|
partLocation
|
envelopes.primaryChannel.partLocation | string |
cachedItems メソッドを介して取得するためのドキュメント パーツへの参照。 これはリクエストで includeDocumentData が true に設定されている場合は使用されません。 |
|
enclosureChannels
|
envelopes.enclosureChannels | array of object |
enclosureChannels |
|
startPage
|
envelopes.enclosureChannels.startPage | integer |
startPage |
|
pageCount
|
envelopes.enclosureChannels.pageCount | integer |
pageCount |
|
channelType
|
envelopes.enclosureChannels.channelType | integer |
channelType |
|
channelName
|
envelopes.enclosureChannels.channelName | string |
channelName |
|
properties
|
envelopes.enclosureChannels.properties | array of object |
properties |
|
名称
|
envelopes.enclosureChannels.properties.name | string |
名称 |
|
価値
|
envelopes.enclosureChannels.properties.value | string |
価値 |
|
データ
|
envelopes.enclosureChannels.data | string |
データ |
|
documentName
|
envelopes.enclosureChannels.documentName | string |
documentName |
|
mimeType
|
envelopes.enclosureChannels.mimeType | string |
mimeType |
|
channelId
|
envelopes.enclosureChannels.channelId | integer |
channelId |
|
partLocation
|
envelopes.enclosureChannels.partLocation | string |
partLocation |
|
jobMessages
|
jobMessages | array of object |
jobMessages |
|
引数
|
jobMessages.args | array of string |
引数 |
|
msgID
|
jobMessages.msgID | integer |
このメッセージの ID。 |
|
destID
|
jobMessages.destID | integer |
デスティネーションの ID。 |
|
msgType
|
jobMessages.msgType | string |
メッセージ タイプ: info (I)、warn (W)、または error (E)。 |
|
msgText
|
jobMessages.msgText | string |
メッセージ テキスト。 |
|
msgDate
|
jobMessages.msgDate | string |
メッセージの日時。 |
|
transactionNo
|
jobMessages.transactionNo | integer |
トランザクションの番号。 |
|
packageID
|
jobMessages.packageID | integer |
パッケージの ID |
|
batchID
|
jobMessages.batchID | integer |
バッチの ID。 |
|
docID
|
jobMessages.docID | integer |
ドキュメントの ID。 |
|
channelID
|
jobMessages.channelID | integer |
ドキュメントのチャネル ID。 |