JavaScriptスニペットを使用してWalkMeをデプロイ

Download as PDF

概要

WalkMeのスニペットはWalkMeをサイトで実行できるようにするものです。 スニペットを含むページまたはブラウザーはサーバー上にパブリッシュされたWalkMeファイルにアクセスできるため、エンドユーザーはWalkMeエディタで作成したものにアクセス、再生することができます。

スニペットはWalkMeがページで動作するためにエンドユーザーのブラウザーで実行する必要があるJavaScriptコードです。 各スニペットは特定のWalkMeエディタのアカウントに関連付けられています。 WalkMeエディタでアイテムがパブリッシュされると、関連付けられたスニペットをブラウザーで実行しているエンドユーザーがアイテムにアクセスすることができます。

環境

テストサイトがある場合、WalkMeアイテムを本番サイトでエンドユーザーにパブリッシュする前に、まずはテストサイトにパブリッシュすることができます。 各環境は異なるスニペットを使用しているため、それぞれに個別にデプロイする必要があります。

テスト（サンドボックスまたはステージング）サイトにテストスニペットをデプロイすると、WalkMeエディタ内のTest環境に公開されたアイテムがテストサイトに表示されます。 同様に、サイトに本番環境スニペットをデプロイすると、Production環境へ公開されたアイテムが本番環境サイトに表示されます。

個々のビジネスニーズに適したカスタム環境を作成することもできます。カスタム環境の詳細については、こちらをご覧ください。

スニペットを見つけるには

1. エディタメニュー内で［スニペット］を選択します
2. 環境を選択します
   • 各環境には微妙に異なるスニペットコードがあります。 テスト/サンドボックス/ステージングサイトがある場合は、テスト用のスニペットをコピーします。 エンドユーザー向けにパブリッシュするためのスニペットが必要な場合は、本番用のスニペットをコピーします。
     
3. スニペットコードをコピーします。
   
4. WalkMe Enabledトグルの切り替え
   • 緊急の理由から、あらゆる環境のWalkMeを無効にする必要がある場合は、［WalkMe Enabled（WalkMeの有効化）］トグルをクリックするだけで対応できます。 オフに切り替えると、WalkMeスニペットは非アクティブ化されます。

スニペットをデプロイするための方法

デプロイはITチームが行う簡単な1回限りのタスクです。

WalkMeスニペットをデプロイする方法はいくつかあります。 正しい方法はアプリケーションの仕様により異なります：

1. アプリケーションのHTMLにアクセスできる場合は、WalkMeコンテンツを表示する各ページのヘッドタグにスニペットを貼り付けます。
   • スニペットを配置することで、すべてのユーザーがすべてのページ読み込みでWalkMeを使用できるようになります。 これはエンドユーザーがWalkMeを表示するために何かをダウンロードしたり、インストールしたりする必要がないため、外部向けアプリケーションにおける推奨オプションになります。
   • スニペットをデプロイするには、WalkMeエディタアカウントからスニペットをコピーしてそのコードをウェブサイトまたはアプリケーションのheadタグの間に貼り付けます。
   • WalkMeがiframe内にロードするには、スニペットをiframe自体にも注入する必要があります。
2. アプリケーションのHTMLにアクセスできない場合（または何らかの理由でHTMLを変更したくない場合）は、ブラウザー拡張機能を大量にデプロイしてスニペットを挿入してください。詳細はこちらをご覧ください。
3. スニペット挿入プロセスを迅速に進める3つめのオプションは、Googleタグマネージャーを使用することです。詳細はこちらをご覧ください。

スニペットを追加した後、WalkMeエディタから関連するすべての環境に対して設定のパブリッシュ（［Settings（設定）］>［Publish Settings（設定をパブリッシュ）］）を行ってファイルを生成し、WalkMeがサイトに正しく読み込まれるようにします。 設定をパブリッシュしないと、WalkMeファイルは正しく読み込まれず、コードのネットワークリクエストに403エラーが表示されます。

スニペットを使用する際に考慮すべきこと

• WalkMeスニペットは、WalkMeにロードしたいすべてのページのHTMLに配置する必要があります
• WalkMeは、ページロード時に一意のユーザーID（UUID）を確認します

• ユーザーがログインするまで、UUIDは利用できません。 希望のUUIDが利用できない場合は、ランダムに生成されたセッションIDが作成されます。
• ログインページで特定のコンテンツを構築する必要がある場合は、UUIDをキャプチャできるように、フルページロード後のログインがあることを確認してください
• シングルページアプリケーションの場合：WalkMeがログインページでロードする場合は、UUIDがロードできることを確認するために、ログイン後のページを更新する必要があります

スニペットが機能していることを確認するにはどうすればよいですか？

スニペットを配置すると、パブリッシュされたコンテンツがエディタに表示されます。 スニペットをテストして、正しく設定されていることを確認するには以下を実行します。

1. サイトを開きます。
2. 右クリックして、ページの検証を選択します。
3. コンソールを開きます。
4. 以下のテキストクエリを入力します。 _walkMe.getEnvId()
   • このコマンドは、どの環境が読み込まれているかを示す値を返します。
     0=本番
     1=プレビュー
     2=再生
     3=テスト
   • 未定義が返ってくる場合、スニペットが正しく設定されていません。サポートにお問い合わせください