Webチャットデータからカスタムレポートを作成する方法
このチュートリアルでは、顧客がWebチャットを開始したWebページのデータを使用して、カスタムレポートを作成する方法を解説します。開始する前に、以下の準備が整っていることをご確認ください:
手順
お客様がナレッジベース内のどのページからでもウェブチャットを開始できる場合を想定し、お客様が通常チャットを開始するウェブページのURLを確認できるレポートを作成したいとします。
以下のステップでは、次の方法について説明します:
- チャットウィジェットの設定を編集し、現在のURLをチャットシナリオに送信するようにする
- カスタムレポートフィールドを追加する
- 「カスタムレポートフィールドの設定」シナリオブロックを使用して、レポートでURLデータを利用できるようにする
- Webチャットを開始して、カスタムフィールドにデータを入力する
- 各Webチャットが開始されたURLを表示するカスタムレポートテンプレートを作成する
- テンプレートに基づいてレポートを実行し、ダウンロードする
1. チャットウィジェットを設定する
チャットウィジェットを使用すると、設定時にJavaScript変数をシナリオに渡すことができます。JavaScriptでURLを取得する方法はいくつかありますが、この例ではwindow.location.hrefを使用して、URL文字列全体にアクセスします。
- 以下に示すように、
parametersキーを{pageURL:window.location.href}に設定し、window.location.hrefをチャットウィジェットの設定に組み込んでください:
<link type="text/css" rel="stylesheet" href="https://example.brightpattern.com/clientweb/chat-client-v4/css/form.css">
<script type="text/javascript">
SERVICE_PATTERN_CHAT_CONFIG = {
appId: '70a6624585ef2b0981fed84fcd12d4db',
apiUrl: 'https://example.brightpattern.com/clientweb/api/v1',
tenantUrl: 'example.brightpattern.com',
chatPath: 'https://example.brightpattern.com/clientweb/chat-client-v4/',
// 「pageURLnew」の値に、現在のページの完全なURLを設定します
parameters:{pageURL:window.location.href}
};
</script>
<script src="https://example.brightpattern.com/clientweb/chat-client-v4/js/init.js"></script>
appId、apiUrl、tenantUrl、およびchatPathが、お使いのチャットウィジェットに適した値に設定されていることをご確認ください。
- ウェブページを開き、チャットウィジェットが正しく読み込まれることをご確認ください。
2. カスタムレポートフィールドを追加する
カスタムレポートフィールドを使用すると、カスタムレポート用のフィールドを定義できます。各チャットが開始されたページのURLを保存するには、カスタムレポートフィールドを追加する必要があります。
- 「コンタクトセンター管理者」アプリケーションにログインし、[設定] > [カスタム] > [カスタムレポートフィールド]に移動し、フィールド1から5のいずれかをクリックしてください。なお、カスタムレポートに含めることができるのは、カスタムフィールド1から5のみです。

- フィールドにわかりやすい名前(この場合は「チャットが開かれたときのURL」)を付け、「有効にする」チェックボックスがオンになっていることを確認してください。

3. カスタムレポートフィールドの値を設定する
チャット設定のparametersキーに渡されたデータには、シナリオ変数$(item.externalChatData)を通じてアクセスできます。この例では、URLデータは次のように渡されました:
parameters: {pageURL:window.location.href}
したがって、チャットシナリオ内では、ページが開かれたときのURLに、以下のシナリオ変数を通じてアクセスできます:
$(item.externalChatData.pageURL)
次のステップでは、このシナリオ変数の値を「チャットが開かれたときのURL」というカスタムレポートフィールドに保存する方法を説明します。
- このチャットウィジェットに関連付けられているチャットシナリオを開きます。以下の3つのブロックを順に追加してください:
- カスタムレポートフィールドの設定ブロックを追加し、レポート用にURLを保存します。
- エージェントの検索(チャット)ブロックを、既定の値のまま追加します。
- チャットの接続ブロックを、既定の値のまま追加します。

- 「カスタムレポートフィールドの設定」ブロックを選択し、以下のフィールドを指示通りに設定してください:
- フィールド:URLデータを保存するカスタムフィールドの名前を選択します。この場合は「チャットが開かれたときのURL」
- 値:フィールドに保存する値を指定します。変数
$(item.externalChatData.pageURL)を使用してください。これには、顧客がWebチャットを開始したURLが含まれます。

- 「エージェントの検索」および「チャットの接続」ブロックは、既定の設定のままにしておいてください。シナリオを保存してください。
4. ウェブチャットを数回開始する
カスタムレポートで参照できるデータが確実に存在するように、チャットウィジェットが設定されているウェブページに移動し、いくつかのウェブチャットを開始してください。可能であれば、異なるURLのページからチャットを開始してください。
5. レポートテンプレートの作成
カスタムフィールド「チャットが開かれたときのURL」のデータを使用してレポートを生成するには、レポートテンプレートを作成する必要があります。レポート作成の詳細な手順については、カスタムレポートのチュートリアルをご参照ください。以下のステップでは、CSVファイルとしてダウンロード可能な最小限のレポートの作成方法について説明します。
- レポートに表示したいフィールドを決定します。詳細は、call_detailデータベースで利用可能な指標の一覧をご参照ください。なお、call_detailテーブルには、チャットを含むすべてのメディアタイプのインタラクションに関するデータが含まれています。この例では、以下のメトリクスを使用します:
- start_time:チャットインタラクションがシステムに受信された時刻(UTC表記)。
- callee_login_id:チャットインタラクションを受信したエージェントのログインID
- custom1: カスタムフィールド「チャットが開かれたときのURL」がカスタム「field1」として定義されているため、対応するデータベースフィールドは「custom1」となります
- 選択したフィールド(メトリクス)に基づいて、BPXML形式のレポートテンプレートを作成してください。以下の例をファイルにコピーし、
.bpxmlという拡張子で保存することができます。
<?xml version="1.0" encoding="UTF-8"?>
<BPcsvReport version="1.0" resourceBundle="com.brightpattern.reports.oob_reports">
<parameters><!-- Defines the report parameter that will be used when generating the report. -->
<parameter name="start_time" type="timeframe" subtype="start" />
</parameters>
<queryString><!-- Contains the SQL query to generate the report data -->
<![CDATA[
SELECT
start_time,
callee_login_id,
custom1
FROM
call_detail
WHERE
start_time > $P{start_time}
]]>
</queryString>
</BPcsvReport>
- 管理者アプリケーションで[設定] > [レポート] > [レポートテンプレート]に移動し、「+」をクリックして新規レポートを作成し、以下のプロパティを設定してください:
- 名前:レポートの説明的な名前です。次のステップでレポートを生成する際、このテンプレートを見つけるために使用されます。
- カテゴリー:レポートを生成する際に、このレポートテンプレートが表示されるカテゴリーを選択してください。
- レポートテンプレート:前のステップで作成した
.bpxmlファイルをアップロードしてください。

- [適用]をクリックして、レポートテンプレートを保存します。
6. レポートの実行とダウンロード
レポートテンプレートからデータをCSVファイルとしてダウンロードするには、希望する期間を指定してレポートを実行する必要があります。
- [レポート] > [レポート] > [すべて]に移動し、前のステップで作成したレポートテンプレートを選択します。「レポートを実行」をクリックします。

- レポートは、1つのCSVファイルを含むZIPアーカイブとして自動的にダウンロードされます。アーカイブを解凍し、CSVファイルを開いてください。この例では、以下のファイルが生成されました:
"start_time","callee_login_id","custom1"
"11/17/24 10:39:03 PM PST","administrator","https://knowledge-base.example.com/interesting-article"
"11/17/24 10:43:27 PM PST","administrator","https://knowledge-base.example.com/difficult-article"
"11/17/24 10:44:01 PM PST","administrator","https://www.example.com/homepage"その他のアイデアや関連チュートリアル
URLのクエリパラメータから取得したデータを使用してレポートを作成したり、取得したURLを使用してAsk a Botから自動応答を取得したり、AIエージェント向けにカスタマイズされた指示を作成することもご検討ください。