Tailwind Logo

Sitecore Forms と連携する Webhook を Sitecore Connect で実装する

XM CloudConnect

公開日: 2024-07-29

Sitecore Forms に入力されたデータに関して、Webhook を利用して Sitecore Connect と連携し、保存をするサンプルを作成していきます。データの保存先として、今回は OneDrive にある Excel ファイルを対象とします。実際には、CRM などに保存するのが良いでしょう。

Project を作成する

まず最初に、Sitecore Connect にて Project を作成します。今回は XM Cloud Demo というプロジェクト名にします。

connectexcel02.png

作成をした Project には何も入っていないため、まず最初に Folder を作成します。フォルダ名を XM Cloud to Excel として作成します。

connectexcel03.png

フォルダが出来上がると、レシピを作ることが可能となります。

connectexcel04.png

Recipe を作成する

今回はスクラッチで Recipe を作成していきます。Sitecore Forms と連携するためには、webhook を利用して連携させることを想定しているため、以下のような設定となります。

connectexcel05.png

Start Building のボタンをクリックして、しばらくすると以下のように Webhook の Trigger と次の Action を設定する画面になります。

connectexcel06.png

+ をクリックすると、Webhook でリクエストされた時の処理を選択できるようになります。

Trigger の設定

アクションを作成する前に、Trigger の設定をします。新しく作成をしたトリガーをクリックするとセットアップの画面になります。

connectexcel07.png

Action in app を選択すると、右側からレシピの検索画面が表示されます。Start guided setup のボタンをクリックすると Setup webhook の画面になります。ここでは Event name を設定します。

connectexcel08.png

設定後、Listen for an event の画面に切り替えてください。

connectexcel08a.png

この状態で、Sitecore Forms の管理画面に移動をして、Webhooks の画面に移動をします。

connectexcel09.png

Create webhook のボタンをクリックすると Webhook の設定画面になります。Sitecore Connect の画面に表示されている Webhook の URL を設定してください。

connectexcel10.png

続いて設定をしたいフォームを開いて、設定のアイコン(中央に並んでいるアイコンの右)をクリックして、Choose webhook で作成をした Webhook を指定します。

connectexcel11.png

指定をしたあと、Test webhook をクリックすると、テスト画面が表示されます。

connectexcel12.png

値を入力して、Submit のボタンをクリックすると送信をするデータのプレビューが表示されます。

connectexcel13.png

Submit ボタンを押して、Sitecore Connect の画面に移動をするとデータを無事受信していることを確認することができました。

connectexcel14.png

これで Trigger が完成しました。

connectexcel15.png

Action の作成

トリガーで受け取ったデータを Actions の中で処理をしていきます。今回は、Excel にフォームの内容を記録していく形で作成をします。

まず、+ をクリックすると次のアクションのタイプを選択することができます。

connectexcel16.png

今回は Action in app を選択して、Excel で検索、Excel との連携の設定を作成していきます。

connectexcel17.png

今回は Excel のシートに対して、 Add rows in batch を選択して、行を追加する処理を追加します。クリックをすると Excel のファイルへ接続するための設定画面に切り替わります。

connectexcel18.png

初めて利用をする際には、以下のように接続をするにあたっての権限設定の画面が表示されます。

connectexcel19.png

承諾をすると、ストレージに置かれている Excel ファイルを選択する手続きに変わっていきます。今回のデモではOneDrive に置いている Excel のファイルを指定します。

connectexcel20.png

指定した Excel ファイルに対して、テーブルの定義を追加しておきます。

connectexcel21.png

この名前を Sitecore Connect の設定に対して追加すると、テーブルの項目が設定画面に表示されます。

connectexcel22.png

あとは各項目に対して、Trigger を作成したときの項目をどの Excel のテーブルのデータに設定をするのかを指定します。

connectexcel23.png

これで Action が完成しました。

テストの実行

作成をしている画面の上に Test Jobs に切り替えるボタンがあります。切り替えると以下のような画面になります。

connectexcel24.png

ボタンをクリックするとテストのモードになります。

connectexcel25.png

このモードになっているときに、Sitecore Forms に移動して、対象となるフォームでテストを実行してください。データを受信および Excel にデータの書き込みができれば、以下のように Successful という形で Sitecore Connect のテスト画面が表示されます。

connectexcel26.png

Excel のファイルを参照すると、入力されたデータが含まれていることを確認することができました。

connectexcel27.png

これでレシピはひとまず完成しました。

connectexcel28.png

まとめ

今回は Sitecore Connect でレシピを作成、Sitcore Forms との Webhook との接続、保存先となる Excel ファイルへの設定など、手続きとしてはいろいろと書きましたが、実際の作業時間は1時間も必要ない形で簡単にフォームのデータを Excel に保存することができました。実際の運用となると、CRM との接続で保存先を指定するとか、様々な処理を Sitecore Connect で実装していくことができるかと思います。

関連タグ