イベントフレームワーク

概要

Gainsight イベントフレームワークを使用すると、プログラムおよびルールエンジンで使用できるイベントを作成できます。イベントは、他のアクティビティの結果であるトリガーとして定義できます。

次に、イベントフレームワークを使用できるいくつかのユースケースを示します。

• Zendeskチケットがある場合、またはSalesforceのケースが閉じられた場合に、プログラムをトリガーして参加者に調査を送信できます。
• 新しいユーザーが非Gainsightシステムでアカウントを作成したときに、プログラムをトリガーしてウェルカムメールを送信できます。
• 参加者が調査に回答するたびに通知メールが送信されます。
• イベントは、その後ルールエンジンでルールをトリガーするために使用できるデータロードの完了である場合があります。

ルールエンジンでは、スケジュールタイプをイベントとして使用し、cURLコマンドを使用してルールを実行できます。cURLコマンドは、Gainsight以外でルールをトリガーする便利な方法です。より広い意味では、開発者サポートがあれば、Gainsight以外のサービスとルールをより深く統合することができます。

この記事では、Gainsight管理ページからトピックとトピック内のイベントを作成する方法について説明します。Gainsightでは、次のサブスクライバでパブリッシャによってトリガーされるイベントを使用します。

• ルールスケジューラ: イベントがパブリッシャによってトリガーされ、Gainsightに到達すると、設定されたルールの実行が開始されます。このユースケースでは、イベントはスケジューラとして機能します。
• JOプログラム-参加者の構成: イベントがパブリッシャによってトリガーされ、Gainsightに到達すると、Gainsightのイベントで設定されたフィールドマッピングに従って、新しい参加者が公開されたプログラムに追加されます。

イベントフレームワークには、次のコンポーネントが含まれます。

• 公開者: イベントの送信者は発行者として定義されます。例として: プログラムのCSAT調査モデルでは、ZendeskまたはSalesforceが、クローズされたすべてのケースのケースクローズイベントの発行元になることができます。
• 加入者:  加入者は、イベントが発生したときにどのアクションを実行するかを決定する処理エンティティ/アプリケーションです。Gainsightは、パブリッシャーから送信されたイベントに対して利用可能な加入者として機能できるアプリケーションを制御します。プログラムとルールは利用可能な加入者です。
• トピックとイベント: トピックは、類似するイベント間の論理的な分離として定義できます。イベントはトピック内で定義され、特定の発生を表します。たとえば、イベント 「Ticket Closed」 と 「Ticket Reopened」 は、トピック 「Zendesk Tickets」 に属することができます。最大20個のトピックと、各トピックに100個のイベントを作成できます。

イベントAPI契約

次に示すのは、イベント処理API契約のサンプルであり、スクリプトの豊富な経験を持つ管理者や、イベントAPIコールをスクリプトする開発者が、イベントをGainsightに送信する方法について説明するのに役立ちます。

https://app.gainsight.com/v1.0/api/イベントManager/イベント

{ 
"hello":"world"
}

応答成功のサンプル

{
 "result": true,
 "data": {
   "イベントId": "259d8882-8b13-4ded-b2b0-39c43359739d"
 },
 "message": "Successfully received イベント, please keep the イベント Id for further reference",
 "messages": [   "Successfully received イベント, please keep the イベント Id for further reference"
 ]
}

応答失敗のサンプル 

{
 "result": false,
 "errorCode": "1001",
 "errorDesc": "Oops, something went wrong! Please contact Tech Support to report. ",
 "requestId": "4e1f3665-eb88-4017-8dff-2c8d400c9111",
 "message": "イベント is not registered",
 "messages": [
   "イベント is not registered"
 ]
}

パブリッシャとして登録

Gainsightからイベント (その他のシステム基盤) の送信者を登録できます。Gainsightは、パブリッシャの設定時に使用されるこの登録用の一意のキーを生成します。このキーは常に特定の組織に対して一意であり、セキュリティで保護する必要があります。

イベントの送信者をPublisherとして登録するには、次のアクションを実行します:

1. Webブラウザで次のリンクを開きます:
   https://<Salesforce instance url>/apex/JBCXM__EventsV2#/events-dashboard/topics/list

または、 [Administration] > [イベント] に移動します。

2. [Register As Publisher] をクリックして、他のシステムインフラストラクチャに現在の組織を登録するために使用される一意のキーを生成し、そこからイベントがGainsightに送信されます。このキーは、パブリッシャの設定中に使用されます。このキーは特定の組織に対して常に一意であり、セキュリティで保護する必要があります。
3. 共有秘密キーギアの表示アイコンをクリックし、いつでもキーをコピーします。

イベントの作成

トピックを作成し、同様のイベントをトピックに追加できます。トピックは、ビジネスニーズに応じてイベントを分離するメカニズムを提供します。組織ごとに最大20のトピックを作成し、各トピックに最大100のイベントを追加できます。

プログラムイベントのワークフロー

プログラムのイベントのサンプルワークフローを次の図に示します。

上の図は、SalesforceのケースクローズイベントまたはZendeskのチケットクローズイベントがそれぞれの加入者に発行される方法を示しています。(また、この8分 ビデオでは、 「プログラム」 で参加者ソースとしてイベントを設定する方法を説明しています。)

ここでの使用例は次のとおりです。ユーザーは、チケットが閉じられた直後にチケット満足度調査を送信したいと考えています。これは、チケットが閉じられた後にトリガーを設定し、イベントフレームワークを使用してこの情報をプログラムに送信することで実現できます。トリガーを設定するときに行われるさまざまなプロセスを以下に説明します。

1. 「イベントの作成」 セクションに記載されている手順を使用して、トピック+イベントを作成します。

次の詳細を含むイベントを作成します:
イベント名: チケットの閉鎖
イベントのバージョン: 1.0
イベント構造: イベント構造のフィールド:

• ContactEmail (連絡先)
• ContactName (連絡先)
• 会社名
• SFDCAccountIdとは
• SFDCContactIdとは

2. Zendeskチケットが閉じられると、イベントは発行元によってトピックに発行されます。推奨される方法は、Zendeskチケットシステムで作成されたトリガーを使用し、POST呼び出しの一部として必要な情報を渡すことによってAPIを呼び出すことです。Salesforce Caseが閉じられた場合も同様で、SFDC Caseオブジェクトにトリガーが作成され、それによってAPIが呼び出されます。
   注意:

• Salesforceからイベントコールを行うには、新しいサイトを許可リスト項目としてリモートサイト設定に追加する必要があります。
• Salesforce組織からイベントコールを行う場合は、ユースケースとSalesforce組織によって、スクリプトに必要な正確な構成が決定されます。このスクリプトはSalesforceを通じて処理されるため、Gainsightにはすべての組織のスクリプト例が網羅されているわけではありません。Gainsightは、Salesforce開発者コンソールのスクリプト処理構成で豊富な経験を持つSalesforce管理者を推奨しています。
• Zendeskシステムからのイベントコールの場合、ユースケースとZendesk orgによって、スクリプトに必要な正確な構成が決定されます。Gainsightは、システム管理者が必要なスクリプト構成をZendeskで処理することを推奨しています。

3. トピックは、上記のトリガーの一部として投稿されたイベントを受信し、それを購読者にブロードキャストします。この場合の購読者はプログラムです。
4. その後、プログラム機能はケース/チケットクローズイベントを受信し、それらを処理してプログラム構成に新しい参加者を追加し、これらの新しい参加者に電子メールを送信します。検証するために、参加者がプログラム内に追加されているかどうかを確認できます。

注意: 参加者ソースをイベントとして設定してプログラムを公開した後にのみ (上記の画像を参照) 、ZendeskシステムまたはSFDCケーストリガーから生成されたイベントが処理対象となります。プログラムによって受信された各イベントは、選択された一意の基準に基づいて新しい参加者を追加します。

GSイベント用のSalesforce Apexクラス

Salesforce Apex Classを使用して、SalesforceからGainsightへのイベントを作成し、それらをGainsightシステムにトリガーできます。SalesforceでGainsight イベントを作成する前に、Salesforce Remoteサイトにhttps://ep.gainsight.comを追加します。リモートサイトを追加する方法の詳細については、 「リモートサイト設定の構成」 のSalesforce記事を参照してください。

SalesforceからGSイベントを作成するには:

1. Salesforce Apexクラスを作成します。Salesforce Apexクラスの作成方法の詳細については、Apex Salesforceの記事を理解するためのシンプルクラスを参照してください。
2. 以下からGSイベント構造体をコピーし、特定のイベントにカスタマイズします。

public class GSイベント{


@future(callout=true)
public static void calloutFromFuture(string records, string sharedSecret, string tenantId, string イベントName,string topicName, string イベントVersion){
System.debug('Welcome to Apex Case Closure Trigger!');
Http http = new Http();
HttpRequest request = new HttpRequest();
request.setEndpoint('https://ep.gainsight.com/api/v0.1/イベントManager/イベント');
request.setMethod('POST');




request.setHeader('sharedSecret',sharedSecret);
request.setHeader('tenantId',tenantId);
request.setHeader('イベントName',イベントName);
request.setHeader('topicName',topicName);
request.setHeader('イベントVersion',イベントVersion);
request.setHeader('Content-Type','application/json');






Map<String,Object> data = new Map<String,Object>();
    data.put('participantInformationList',JSON.deserializeUntyped(records));
    
    request.setBody(JSON.serialize(data));
    HttpResponse response = http.send(request);
    if (response.getStatusCode() != 201) {
    System.debug('The status code returned was not expected: ' +
        response.getStatusCode() + ' ' + response.getStatus());
    } else {
    System.debug(response.getBody());
    }
}


}

Caseのステータスがエスカレート済みに変更されたときにイベントを生成するには、次のGSEイベントサンプル構造要求のSalesforceトリガーを使用します:

trigger CaseClosure on Case (after update) {
{


string イベントName = ‘copy_value_from_gainsight_イベント_page’;
string  イベントVersion = 'copy_value_from_gainsight_イベント_page';
string topicName = 'copy_value_from_gainsight_イベント_page';
string tenantId = ‘contact your csm to get your tenantId’;
string sharedSecret=‘’copy_value_from_gainsight_イベント_page;


if(Trigger.isUpdate)
{
    List<Map<string,Object>> records = new List<Map<String,Object>>();
    List<String> caseids = new List<String>();
    for(Case updatedCase : Trigger.new) 
    {
        if(updatedCase.status.equals('Escalated')) 
        {
            caseids.add(updatedCase.Id);
        }
    }
       List<case> cases = [Select CaseNumber, Contact.Name, ContactEmail, AccountId, Subject, Reason, Account.Name, Type from Case where id in :caseids];
    for(Case updatedCase : cases)
    {
       Map<String,Object> record = new Map<String,Object>();
       record.put('Recipient Email', updatedCase.ContactEmail);
       record.put('Account Id', updatedCase.AccountId);
       record.put('Account Name', updatedCase.Account.Name);
       record.put('Case Number', updatedCase.CaseNumber);
       record.put('Reason', updatedCase.Reason);
       record.put('Type', updatedCase.Type);
       record.put('Contact',updatedCase.Contact.Name);
       record.put('Subject',updatedCase.Subject);
       records.add(record);
    }
    if(records.size() > 0) {
    GSイベント.calloutFromFuture(JSON.serialize(records), sharedSecret,tenantId, イベントName,topicName,イベントVersion); }
}

追加リソース 

• マッピングの詳細については、 「プログラムへの参加者の追加」 を参照してください。