データ収集フォーム

この機能を使用すると、モバイル SDK とウェブ SDK の消費者データの収集用のフォームを設定して管理できます。CCAI Platform は、セルフホスト型 HTML フォーム（ブラウザ フォーム）と、SDK によってレンダリングされるポータル定義フォーム（カスタム フォーム）の両方をサポートしています。消費者はアクティブなチャット セッション中にフォームに記入できます。送信されたフォームデータは、構成に基づいて CRM と外部ストレージに転送できます。

この機能を有効にする前に、SDK が要件を満たしていることを確認してください。詳細については、始める前にをご覧ください。

フォームのタイプ

このページでは、チャット中にエージェントがエンドユーザーに送信できるデータの収集フォームを設定する方法について説明します。

CCAI Platform は、ウェブ SDK とモバイル SDK でフォームを表示する 2 つの方法をサポートしています。

  • ブラウザ フォーム: HTML フォームを独自のウェブサーバーでホストします。CCAI Platform は、SDK 内の埋め込みブラウザ ビューにフォームを読み込みます。これには、ホストされているフォームを指す有効なフォーム外部 ID とフォーム プレビュー URL が必要です。ブラウザ フォームは Widget Web SDK でのみサポートされています。Headless SDK ではサポートされていません。ウェブ チャネルで Headless を使用している場合は、代わりにカスタム フォームを使用します。

    詳細については、ブラウザ フォームを追加するをご覧ください。

  • カスタム フォーム: フォーム（フィールド、レイアウト、オプション）を CCAI プラットフォーム ポータルで直接定義します。CCAI プラットフォームはウェブとモバイルの SDK でフォームをレンダリングするため、顧客がホストするフォーム インフラストラクチャは必要ありません。フォームデータは、構成に応じて CRM（チケットのコメントとして）や外部ストレージに送信できます。

    詳しくは、カスタム フォームを追加するをご覧ください。

始める前に

フォームを有効にするには、認証用の会社の秘密コードが必要です。

会社のシークレット コードを取得する手順は次のとおりです。

  1. CCAI Platform ポータルで、[設定 > デベロッパー設定] をクリックします。[設定] メニューが表示されない場合は、 [メニュー] をクリックします。

  2. [Company Key & Secret Code] ペインに移動します。会社のひみつのコードが表示されます。このコードは、フォームを有効にするときに必要になります。

フォームをオンにする

フォームを有効にする手順は次のとおりです。

  1. CCAI Platform ポータルで、[設定> フォーム] をクリックします。[設定] メニューが表示されない場合は、 [メニュー] をクリックします。[フォーム] ページが表示されます。

  2. [フォームを有効にする] 切り替えボタンをクリックしてオンにします。

  3. [フォームの設定] で [構成] をクリックします。[ブラウザ フォームの設定] ペインが表示されます。

  4. [Secret] フィールドに会社の秘密コードを入力し、[Save] をクリックします。

  5. [戻る] をクリックして [フォーム] ページに戻ります。

ブラウザ フォームを追加する

ブラウザ フォームを追加する手順は次のとおりです。

  1. フォームを有効にするの手順に沿って操作します。

  2. [フォーム] ページで、[テンプレートを追加] をクリックします。[フォーム テンプレートの追加] ページが表示されます。

  3. フォームの設定を構成する手順は次のとおりです。

    1. [タイプ] で [ブラウザ フォーム] を選択します。

    2. [チャンネル] で、フォームを有効にするチャンネルを選択します。

    3. [キューの言語] で、フォームを利用可能にするキューの言語を選択します。たとえば、[チャネル] = [ウェブチャット]、[キューの言語] = [ドイツ語] を選択すると、ウェブチャネルとドイツ語のキューを使用しているエンドユーザーがフォームを利用できるようになります。

  4. フォームの詳細を構成するには、次の操作を行います。

    1. [フォーム テンプレート名] フィールドに、社内向けのフォーム テンプレート名を入力します。エージェントは、チャット アダプタでフォームを選択するときにフォーム テンプレート名を確認できます。

    2. [フォームのタイトル] フィールドに、フォームのタイトルを入力します。エンドユーザーには、チャット中に連絡先カードにフォームのタイトルが表示されます。詳細については、エンドユーザー エクスペリエンスをご覧ください。

    3. [フォームのサブタイトル（省略可）] フィールドに、必要に応じてフォームのサブタイトルを入力します。エンドユーザーには、チャット中に連絡先カードにフォームのサブタイトルが表示されます。

    4. [Form External ID] フィールドに、フォームサーバー上のフォームの識別子を入力します。

    5. [プレビュー URL] フィールドに、エージェント アダプタに表示されるフォーム プレビューの URL を入力します。フォームのプレビューには、実際のフォームまたは汎用フォームを使用できます。フォームに PII が含まれている場合、エージェントが PII を表示せずに正しいフォームを特定できるように、汎用フォームのプレビューを使用することをおすすめします。

    6. フォームの画像を追加する手順は次のとおりです。

      1. [フォームの画像（省略可）] フィールドに、必要に応じて画像を入力します。

      2. 画像を切り抜き、[切り抜き] をクリックします。

    エンドユーザーは、チャット中に連絡先カードにフォームの画像を表示できます。

  5. [保存してプレビュー] をクリックします。[テンプレートのプレビュー] ダイアログが表示されます。

  6. 次のいずれかを行います。

    • フォームが想定どおりに表示されない場合は、[編集] をクリックします。[フォーム テンプレートの編集] ページが再度表示され、編集内容を変更できます。

    • フォームが想定どおりに表示されたら、[完了] をクリックします。

カスタム フォームを追加する

カスタム フォームを追加する手順は次のとおりです。

  1. フォームを有効にするの手順に沿って操作します。

  2. [フォーム] ページで、[テンプレートを追加] をクリックします。[フォーム テンプレートを追加] ページが表示されます。

  3. フォームの設定を構成する手順は次のとおりです。

    1. [Type] で [Custom form] を選択します。

    2. [カテゴリ] で [チャット] を選択したままにします。

    3. [チャネル] で、[ウェブチャット] チェックボックスをオンにします。

    4. [キューの言語] で、フォームを利用可能にするキューの言語を選択します。たとえば、[チャネル] = [ウェブチャット]、[キューの言語] = [ドイツ語] を選択すると、ウェブチャネルとドイツ語のキューを使用しているエンドユーザーがフォームを利用できるようになります。

    5. 省略可: [データ ストレージ] で、[フォーム送信データを CRM チケットのコメントとして含める] チェックボックスをオンにして、フォームデータをチケットのコメントとして CRM に送信します。

  4. フォームの詳細を構成するには、次の操作を行います。

    1. [フォーム テンプレート名] フィールドに、社内向けのフォーム テンプレート名を入力します。エージェントは、チャット アダプタでフォームを選択するときにフォーム テンプレート名を確認できます。

    2. [フォームのタイトル] フィールドに、フォームのタイトルを入力します。エンドユーザーには、チャット中に連絡先カードにフォームのタイトルが表示されます。詳細については、エンドユーザー エクスペリエンスをご覧ください。

    3. [フォームのサブタイトル（省略可）] フィールドに、必要に応じてフォームのサブタイトルを入力します。エンドユーザーには、チャット中に連絡先カードにフォームのサブタイトルが表示されます。

    4. フォームの画像を追加する手順は次のとおりです。

      1. [フォーム画像] フィールドに画像を入力します。

      2. 画像を切り抜き、[切り抜き] をクリックします。

    エンドユーザーは、チャット中に連絡先カードにフォームの画像を表示できます。

  5. [フォームのヘッダー] フィールドに、フォームの先頭に表示するテキストを入力します。

  6. [Form footer (Optional)]（フォームのフッター（省略可））フィールドに、フォームの最後に表示するテキストを入力します（省略可）。

  7. [次へ] をクリックします。[質問] セクションが表示されます。

  8. フォームに質問を追加する手順は次のとおりです。

    1. [質問を追加] をクリックします。[質問を追加] ページが表示されます。

    2. [質問の形式] リストで、質問の形式を選択します。表示されるオプションは、選択した質問の種類によって異なります。

    3. [質問文] フィールドに質問を入力します。

    4. [必須] 切り替えを構成する手順は次のとおりです。

      • [質問のタイプ] リストで Toggle button を選択した場合: フォームを送信する前にエンドユーザーがこの切り替えをオンにする必要があるようにするには、[必須] 切り替えをオンにします。

      • [質問のタイプ] リストで Toggle button 以外の値を選択している場合: フォームを送信する前にエンドユーザーにこの質問への回答を求めるには、[必須] 切り替えボタンをクリックしてオンにします。

    5. 省略可: エンドユーザーがテキスト フィールドに入力したテキストをマスクするには、[マスキング] 切り替えボタンをオンにします。マスキングの切り替えは、[質問のタイプ] リストで Text Entry を選択した場合にのみ表示されます。

    6. 省略可: [プレースホルダ テキスト] フィールドに、プレースホルダ テキストを入力します。この機能はすべての質問タイプで利用できるわけではありません。

    7. 省略可: ヘルプテキストとヘルプ画像を追加します。この機能は、すべての質問タイプで利用できるわけではありません。

    8. [文字数制限] フィールドに、テキスト フィールドの文字数制限を入力します。これは、[質問のタイプ] = Text Entry の場合にのみ使用できます。

    9. [入力タイプ] リストで、入力タイプを選択します。質問のタイプが Text Entry の場合にのみ使用できます。

    10. 残りのフィールドを構成して、[追加] をクリックします。

  9. 別の質問を追加するには、[質問を追加] をクリックして、フォームに別の質問を設定します。

  10. [保存] をクリックします。

ウェブとモバイル用のカスタム フォームを構成する

エージェントがウェブとモバイルの SDK を使用してフォームを送信できるようにするには、次の手順に沿って、これらのチャネルをフォーム テンプレートに明示的に割り当てる必要があります。

  1. フォーム テンプレートに移動します。ポータルにログインし、[フォーム テンプレートの追加 / 編集] ページに移動します。

  2. カテゴリを選択: フォームの設定で、カテゴリとして [チャット] を選択します。[チャット] を選択すると、ウェブチャットとモバイルチャットのチャネル チェックボックスが使用可能になります。

  3. チャンネルを有効にする: チャンネル選択のチェックボックスを探します。[Web chat] を選択して、このフォームを Web SDK で使用できるようにします。[モバイルチャット] を選択すると、このフォームが Mobile SDK で利用できるようになります。

  4. フォームをデザインする:

    • 質問: Text、List、Toggle の質問タイプを追加します。
    • ヘルプ コンテキスト: 必要に応じて、特定の質問にヘルプ テキストまたはヘルプ画像を追加して、ユーザーをガイドします。
    • 画像: フォームの画像をアップロードする場合は、8:3 のアスペクト比に収まるようにしてください。ポータル内で画像を切り抜くことができます。
    • CRM の設定: フォームの回答をチケットのコメントとして CRM に送信するには、[フォームの送信データを CRM チケットのコメントとして含める] を [フォームの設定] で有効にします。

    有効にすると、フォームのアクティビティ（フォームの送信時や完了時など）を CRM チケットのコメントに追加できます。また、このオプションを有効にすると、送信されたフィールドの値を完了コメントに追加できます。

  5. プレビューして保存する: [保存してプレビュー] をクリックして、フォームのレイアウトが想定されるユーザー エクスペリエンスと一致していることを確認します。

    • ポータルに表示されるプレビューはエージェント プレビューのみであり、SDK に表示されるフォームと完全に一致しない場合があります。

フォーム データの保存を構成する

フォームデータを外部ストレージに保存するように CCAI Platform を構成します。

外部ストレージを設定する

フォームデータを保存できる外部ストレージの場所を設定します。詳しくは、外部ストレージをご覧ください。

カスタムフォームから収集したデータを外部ストレージ（S3 など）に直接プッシュするようにシステムを設定できます。

フォームデータを外部ストレージに送信するようにインスタンスを構成する

フォームデータを外部ストレージに送信するようにインスタンスを構成する手順は次のとおりです。

  1. CCAI Platform ポータルで、[設定 > デベロッパー設定] をクリックします。[設定] メニューが表示されない場合は、 [メニュー] をクリックします。

  2. [外部ストレージ] ペインに移動し、切り替えボタンをクリックしてオンにします。

  3. [カスタム フォーム] チェックボックスをオンにします。外部ストレージの場所にあるフォーム データファイルへのデフォルトのパスが表示されます。パスは編集できます。

  4. [保存] をクリックします。

権限

セキュリティを確保するため、外部ストレージ内のフォームデータへのアクセスは特定の権限によって制御されます。

この権限がない場合、ポータル ユーザーはパスや UUID を知っていても、外部ストレージ内のカスタム フォーム データにアクセスできません。

権限を構成する

関連するユーザーロール（管理者、マネージャー データなど）に [表示] オプションを割り当てます。

エンドユーザーのデータを保護するため、外部ストレージでのフォームデータの表示は CCAI Platform のユーザーロールによって制御されます。外部ストレージのフォームデータを表示する権限があるのは、管理者、マネージャー、マネージャー管理者、マネージャー チーム、マネージャー データのデフォルトのロールのみです。

デフォルトのロールがニーズに合わない場合は、フォームデータを表示する権限を持つカスタムロールを追加できます。カスタムロールの権限は、[設定] > [ユーザーとチーム] > [ロールと権限] > [ロールを追加] の [ロールを追加] ダイアログで構成できます。

権限の場所

[役割を追加] ダイアログで、フォームデータの次の設定を行います。

  • セクション: 外部ストレージ

  • ページ: フォーム

  • 機能: フォームデータ

次のステップ