イベントフレームワーク
重要 - 画像/情報は四半期ごとのリリースで更新されます!
四半期ごとのリリースにて、最新の機能・情報を反映し、画像を含めた情報は更新されます。
概要
Gainsightイベントフレームワークを使用すると、プログラムおよびルールエンジンで使用できるイベントを作成できます。イベントは、他のアクティビティの結果であるトリガーとして定義できます。
次に、イベントフレームワークを使用できるいくつかのユースケースを示します。
- Zendeskチケットがある場合、またはSalesforceのケースが閉じられた場合に、プログラムをトリガーして参加者に調査を送信できます。
- 新しいユーザーが非Gainsightシステムでアカウントを作成したときに、プログラムをトリガーしてウェルカムメールを送信できます。
- 参加者が調査に回答するたびに通知メールが送信されます。
- イベントは、その後ルールエンジンでルールをトリガーするために使用できるデータロードの完了である場合があります。
ルールエンジンでは、スケジュールタイプをイベントとして使用し、cURLコマンドを使用してルールを実行できます。cURLコマンドは、Gainsight以外でルールをトリガーする便利な方法です。より広い意味では、開発者サポートがあれば、Gainsight以外のサービスとルールをより深く統合することができます。
この記事では、Gainsight管理ページからトピックとトピック内のイベントを作成する方法について説明します。Gainsightでは、次のサブスクライバでパブリッシャによってトリガーされるイベントを使用します。
- ルールスケジューラ: イベントがパブリッシャによってトリガーされ、Gainsightに到達すると、設定されたルールの実行が開始されます。このユースケースでは、イベントはスケジューラとして機能します。
- JOプログラム-参加者の構成: イベントがパブリッシャによってトリガーされ、Gainsightに到達すると、Gainsightのイベントで設定されたフィールドマッピングに従って、新しい参加者が公開されたプログラムに追加されます。
イベントフレームワークには、次のコンポーネントが含まれます:
- 公開者: イベントの送信者は発行者として定義されます。例: プログラムのCSAT調査モデルでは、ZendeskまたはSalesforceが、クローズされたすべてのケースのケースクローズイベントの発行元になることができます。
- 加入者: 加入者は、イベントが発生したときにどのアクションを実行するかを決定する処理エンティティ/アプリケーションです。Gainsightは、パブリッシャーから送信されたイベントに対して利用可能な加入者として機能できるアプリケーションを制御します。プログラムとルールは利用可能な加入者です。
- トピックとイベント: トピックは、類似するイベント間の論理的な分離として定義できます。イベントはトピック内で定義され、特定の発生を表します。たとえば、イベント 「チケットクローズ」 と 「チケットが再開」 は、トピック 「Zendesk Tickets」 に属することができます。最大20個のトピックと、各トピックに100個のイベントを作成できます。
発行者として登録
Gainsightからイベント (その他のシステム基盤) の送信者を登録できます。Gainsightは、パブリッシャの設定時に使用されるこの登録用の一意のキーを生成します。このキーは特定の組織に対して常に一意であり、セキュリティで保護する必要があります。
イベントの送信者をパブリッシャーとして登録するには、次のアクションを実行します。
- Webブラウザーで次のリンクを開きます。<gainsight-domain>/v1/ui/eventsV2#/events-dashboard/topics/list
または、 [管理] > [イベント] に移動します。
- [パブリッシャーとして登録] をクリックして、他のシステムインフラストラクチャに現在の組織を登録するために使用される一意のキーを生成し、そこからイベントがGainsightに送信されます。このキーは、パブリッシャの設定中に使用されます。このキーは特定の組織に対して常に一意であり、セキュリティで保護する必要があります。
- 共有秘密キーギアの表示アイコンをクリックし、いつでもキーをコピーします。
イベントの作成
トピックを作成し、同様のイベントをトピックに追加できます。トピックは、ビジネスニーズに応じてイベントを分離するメカニズムを提供します。組織ごとに最大20のトピックを作成し、各トピックに最大100のイベントを追加できます。
トピックの作成
トピックを作成するには、次の操作を実行します:
- トピックページで+新しいトピックをクリックします。新しいトピックを追加ダイアログが表示されます。
- [トピックの追加] ダイアログに次の詳細を入力します。
- トピック名: パブリッシャの設定時に使用されるトピックの正確な名前を入力します。たとえば、 「チケットクローズ」 という名前のトピックを、チケットがクローズされたときの操作に関連するイベント用に作成できます。チケット満足度調査は、お客様のサポートチケットが 「チケットクローズ」 トピックのイベントとしてクローズされたときに送信されます。
- 説明 (オプション)
- 保存をクリックします。新しいトピックが作成されます。
- (任意) いつでも説明を編集するには、 [説明の編集] アイコンをクリックします。
イベントの作成
イベントを作成するには、次のアクションを実行します。
- トピックの [イベントの構成] ボタンをクリックするか、タブに移動して必要なトピックを選択します。
- [+新規イベントの作成] をクリックします。
- イベントを作成するには次の詳細を入力します:
- イベント名: パブリッシャの設定時に使用されるイベントの正確な名前を入力します。たとえば、サポート チケットがクローズされるたびに送信されるチケット満足度調査のイベントを作成する場合は、「問題の報告のためにチケットがクローズされました」という名前を付けることができます。
注: 1つのトピックに同じ名前のイベントを複数含めることはできません。ただし、異なるトピックに属し、異なるビジネス上の問題を解決する場合は、同じ名前のイベントを作成できます。 - バージョン: バージョン番号を割り当てます。バージョンは、似たようなイベントがあるが、構造が異なり、それらを個別に追跡する必要がある場合に便利です。例: 「チケットクローズ調査」 は、同じ名前で設定できますが、構造に変更があるたびに異なるバージョンを使用します。バージョンが1.0のケースクローズイベントがあり、イベントの構造を更新する必要がある場合は、1.0イベントの詳細を失うことなく、バージョン1.1の別のイベントを作成できます。両方のイベント(1.0および1.1)は、2つの異なるイベントとして扱われます。
- トピック: イベントを作成するトピックを選択します。
- 説明:(任意) イベントの説明を記述します
- 構造: [+ 新規追加] をクリックして、パブリッシャーによってイベント API 呼び出しで渡されるフィールドを追加します。構造体は、イベントのサブスクライバーがそれを使用できるように、イベントのサンプル形式を定義します。プログラムでは、参加者フィールドへのマッピングに使用されます。例: 以下で指定された構造の ContactEmail は、参加者の [受信者の電子メール アドレス] フィールドへのマッピングに使用されます。
- 以下に示すように、複数のフィールド名を入力します:
- イベントAPI呼び出しで渡されるフィールドの正確な名前を入力します。
- フィールドのを選択します。イベントフレームワークは、文字列、数値、ブール、日付、および日時の5つのデータ型の選択をサポートしています。
- [構造項目の保存] をクリックします。
- 構造に別のイベントフィールドを追加するには、 [イベントフィールドの追加] ボタンをクリックします。
- [保存]をクリックします。
メモ:
- パブリッシャイベントとプログラムの参加者設定の設定に従って、後でいつでも新しいイベントフィールドを追加できますが、イベント構造内の既存のフィールドを編集または削除することはできません。
- ルールエンジンでスケジューラとして消費できるイベントには、イベント構造は必要ありません。
-
イベント構造に追加されたフィールドは、 [プログラム] > [参加者の構成] ページで標準フィールドにマッピングするために使用できます。追加フィールドを標準フィールドにマッピングする場合は、追加フィールドでイベント構造を更新できます。
-
既存のイベントを削除して同じイベントを再度作成する必要がある場合は、既存のイベントを削除せずに、別のバージョンで新しいイベントを作成することをGainsightは推奨しています。
イベント フィールドの解決
この機能は、イベントの送信者からのレコードを、Gainsightオブジェクトに格納されているレコードに解決するのに役立ちます。これを実行するには、必要に応じて、イベント構造に追加されたフィールドを、Gainsight標準オブジェクト、個人、ユーザー、会社、および関係からのフィールドにマッピングします。
Gainsightを使用してイベントフィールドを解決できますが、この機能に依存するGainsightアプリケーション (コンシューマー) は現在開発中です。ジャーニーオーケストレーターは、イベントフレームワークのイベントフィールド機能の解決を優先します。これは、管理者がイベントの送信者からGainsightオブジェクトに格納されているレコードにレコードを解決するのに役立ちます。
イベントフィールドの解決機能の助けを借りて、管理者は次のアクションを実行できます。
- 次のようにしながら、イベントソースフィルターの検索フィールドを選択します。
- イベントフィールドの作成
- ソースとしてのイベントの追加
- 条件付き待機でのイベントフィールドの使用
- 選択したイベント ソースの [参加者ソースのマッピング] セクションでルックアップ フィールドをマッピングします。
この設定を適用するには、次の手順を実行します:
- [イベントフィールドの解決] チェックボックスをクリックします。イベント フィールド、個人、会社、関係、GSユーザー (CSM、他のユーザー) から対象のGainsightオブジェクトを確認できます。
- 次のように、オプション個人を選択して、イベントフィールドとGainsight個人オブジェクト間のフィールドマッピングを適用します:
- 左側のドロップダウンでイベントフィールドを選択し、Gainsight個人オブジェクトからフィールドを選択します。
- 複数のフィールドマッピングを追加するには、[+]をクリックします。
- [個人経由で会社個人に解決] チェックボックスをオンにします。これにより、個人レコードが [会社の個人 ID を使用して会社の個人] フィールドの対応するレコードに解決されます。
- [個人経由で会社個人に解決] チェックボックスをオンにします。これにより、会社個人オブジェクトから会社を使用している会社IDフィールドの対応するレコードにレコードが解決されます。
- [会社経由でGSユーザーに解決] チェックボックスをオンにします。これにより、会社オブジェクトのレコードが、ユーザーオブジェクトの対応するレコードにCSMフィールドを使用して解決されます。
注: 関連エンティティにも同様の解決を適用できます。「個人」 から 「関係 個人」 、 「関係 個人」 から 「関係」 、 「関係」 から 「GSユーザー」 に解決するチェックボックスを選択できます。
- 次のように、 「会社」 オプションを選択して、イベントフィールドと会社オブジェクト間のフィールドマッピングを適用します:
- 左側のドロップダウンで 「イベントフィールド」 を選択し、会社オブジェクトからフィールドを選択します。
- 複数のフィールドマッピングを追加するには、[+]をクリックします。
- [会社経由でGSユーザーに解決] チェックボックスをオンにします。これにより、会社オブジェクトのレコードが、ユーザーオブジェクトの対応するレコードにCSMフィールドを使用して解決されます。
- 次のように、イベントフィールドと関係オブジェクト間のフィールド マッピングを適用する関係オプションを選択して、イベントフィールドと関係オブジェクトのフィールドマッピングを適用します:
- 左側のドロップダウンで [イベントフィールド] を選択し、関係オブジェクトからフィールドを選択します。
- 複数のフィールドマッピングを追加するには、[+]をクリックします。
- [関係によるGSユーザーへの解決] チェックボックスをオンにします。これにより、関係オブジェクトのレコードが、ユーザーオブジェクト内の対応するレコードにCSMフィールドを使用して解決されます。
- 次のように、GSユーザーオプションを選択して、イベントフィールドとユーザーオブジェクト間のフィールドマッピングを適用します。
- 左側のドロップダウンでイベントフィールドを選択し、ユーザーオブジェクトからフィールドを選択します。
- 複数のフィールドマッピングを追加するには、[+]をクリックします。
- [保存]をクリックします。
注:イベントフィールドからの解決は、個人、会社、関係、またはユーザーオブジェクトを含む単一のGainsightオブジェクトに直接適用できます。また、前述のように、現在のオブジェクトを介して別の標準オブジェクトに解決を適用することもできます。たとえば、イベントフィールドを個人を介して会社個人、会社を介して会社個人などに解決できます。
イベントの管理
イベントの作成後、イベントの編集、削除、テスト、およびイベントログの表示を行うことができます。以下は、イベントを管理するために使用できるオプションです:
- イベント構造の表示: 特定のイベントでこのボタンをクリックすると、イベントリストページに直接イベント構造 (追加されたイベントフィールドのリスト) が表示されます。
- イベントの編集: 既存のイベントを編集するには、このボタンをクリックします。イベントが作成されると、説明を編集したり、構造体に新しいイベントフィールドを追加したり、イベントフィールドの解決を適用または変更したりできます。
-
テストイベント: 既存のイベントをテストするには、このボタンをクリックします。次の2つのパブリッシングタイプを使用してイベントをテストできます: テストイベントまたは発行イベント。
-
テストイベント: このオプションを選択し、提出をクリックしてイベントをテストします。現在のイベントは正常にテストされ、応答フィールドに結果が表示されます。イベントに問題があると思われる場合は、応答からeventIdを使用し、Gainsightサポートと共有してイベントをデバッグできます。
-
イベントの公開: このオプションを選択し、提出をクリックして、イベントを手動でサブスクライバに公開します。これにより、ルールが実行されるか、イベントが設定されている新しい参加者に対してプログラムがオーケストレーションされます。
-
-
イベントログ: このボタンをクリックすると、 [テストイベント] 、 [イベントの公開] が時間に対してグラフィカルな形式で表示され、イベントログのリストが表形式で表示されます。[テストイベント] と [公開されたイベント] は、それぞれグラフの赤と緑のカラースパイクで識別されます。[イベントの再テスト] ボタンをクリックすると、ログから任意のイベントを再度テストできます。再テスト後、イベントリストのグラフと表が次のように更新されます:
-
イベントの削除: 特定のイベントを削除するには、このボタンをクリックします。
プログラム イベントのワークフロー
プログラムのイベントのサンプルワークフローを次の図に示します:
上の図は、SalesforceのケースクローズイベントまたはZendeskのチケットクローズイベントがそれぞれの加入者に発行される方法を示しています。(また、この8分 ビデオでは、 「プログラム」 で参加者ソースとしてイベントを設定する方法を説明しています。)
ここでの使用例は次のとおりです。ユーザーは、チケットが閉じられた直後にチケット満足度調査を送信したいと考えています。これは、チケットが閉じられた後にトリガーを設定し、イベントフレームワークを使用してこの情報をプログラムに送信することで実現できます。トリガーを設定するときに行われるさまざまなプロセスを以下に説明します。
- 「イベントの作成」セクションに記載されている手順を使用して、トピック + イベントを作成します。
次の詳細でイベントを作成します:
イベント名: チケット閉鎖
イベント バージョン: 1.0
イベント構造: イベント構造のフィールド:
- ContactEmail (連絡先)
- ContactName (連絡先)
- 会社名
- SFDCAccountIdとは
- SFDCContactIdとは
- Zendeskチケットが閉じられると、イベントは発行元によってトピックに発行されます。推奨される方法は、Zendeskチケットシステムで作成されたトリガーを使用し、POST呼び出しの一部として必要な情報を渡すことによってAPIを呼び出すことです。Salesforce Caseが閉じられた場合も同様で、SFDC Caseオブジェクトにトリガーが作成され、それによってAPIが呼び出されます。
注意:
- Salesforceからイベントコールを行うには、新しいサイトを許可リスト項目としてリモートサイト設定に追加する必要があります。
- Salesforce組織からイベントコールを行う場合は、ユースケースとSalesforce組織によって、スクリプトに必要な正確な構成が決定されます。このスクリプトはSalesforceを通じて処理されるため、Gainsightにはすべての組織のスクリプト例が網羅されているわけではありません。Gainsightは、Salesforce開発者コンソールのスクリプト処理構成で豊富な経験を持つSalesforce管理者を推奨しています。
- Zendeskシステムからのイベントコールの場合、ユースケースとZendesk orgによって、スクリプトに必要な正確な構成が決定されます。Gainsightは、システム管理者が必要なスクリプト構成をZendeskで処理することを推奨しています。
- トピックは、上記のトリガーの一部として投稿されたイベントを受信し、それを購読者にブロードキャストします。この場合の購読者はプログラムです。
- その後、プログラム機能はケース/チケットクローズイベントを受信し、それらを処理してプログラム構成に新しい参加者を追加し、これらの新しい参加者に電子メールを送信します。検証するために、参加者がプログラム内に追加されているかどうかを確認できます。
注:参加者ソースをイベントとして設定してプログラムを公開した後にのみ (上記の画像を参照) 、ZendeskシステムまたはSFDCケーストリガーから生成されたイベントが処理対象となります。プログラムによって受信された各イベントは、選択された一意の基準に基づいて新しい参加者を追加します。