Help Center
WalkMeヘルプセンターへようこそ

Please login in order to continue:

Work flows better with WalkMe
Work flows better with WalkMe.

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

Last Updated 8月 28, 2024

概要

WalkMeスニペットは、WalkMeをサイトで実行できるようにするものです。 スニペットを含むページまたはブラウザは、サーバーでパブリッシュされたWalkMeファイルにアクセスでき、これによりユーザーは、コンテンツにアクセスして再生できます。

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

以下の手順に従って、スニペットを使用して、WalkMeをデプロイします。

  • スニペットは、希望する機能用にウェブサイトに追加する必要があるコードの一部です
  • スニペットをサイトに直接インストールするには、アプリケーションのコードにアクセスする必要があります。

デプロイメントガイド

1. スニペットコードを取得する

展開

スニペットコードは、WalkMeエディタから利用できます。 エディタをインストールする方法を学びます。

  1. エディタで設定アイコンをクリックしてシステム設定を開きます

  2. スニペットタブに移動します
  3. ドロップダウンから正しい環境を選択します(テスト/本番)
    • 各環境には微妙に異なるスニペットコードがあります
    • テスト/サンドボックス/ステージングサイトがある場合は、テストスニペットを選択します
    • エンドユーザーに公開するためのスニペットを希望する場合は、本番スニペットを選択します。スニペット

      環境はエディタで開いた環境を自動的に選択します

  4. コードをコピーをクリックして、スニペットをコピーします

スニペットコードを取得できない場合は、サポートチームにお問い合わせください。

2. ウェブサイトのバックエンドにアクセスする

展開

  • ウェブサイトのバックエンドまたはコンテンツ管理システム(CMS)にログインします

バックエンドにアクセスする方法に精通していない場合は、ウェブサイト開発者または管理者に相談する必要があります。

3. ヘッダー/フッターセクションを探す

展開

  • ウェブサイトのヘッダーまたはフッターを編集できるCMSのセクションに移動します
ヒント

このセクションは通常、設定、外観、またはテーマのカスタマイズエリアにあります。

4. ヘッダー/フッターを編集する

展開

  • ヘッダー/フッターセクションで、カスタムコードまたはスクリプトを追加できるセクションを見つけます
ヒント

このセクションは、「カスタムスクリプト」、「ヘッダースクリプト」、「フッタースクリプト」、またはそれらと類似したもので表示されている場合があります。

5. スニペットコードを追加する

展開

  • スニペットコード(ステップ1でコピーされたもの)を、CMSのヘッダー/フッターセクションの指定された領域に貼り付けます
必須

  • WalkMeスニペットは、WalkMeに読み込むすべてのページのHTMLに配置する必要があります
  • WalkMeは、ページの読み込み時に、ユニークなユーザーID(UUID)をチェックします

ベストプラクティス:ログインページの後にスニペットを配置する

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

重要な注意事項

  • ページごとにスニペットを 1 つだけ追加する必要があります
  • スニペットを追加する場合、何も変更しないようにしてください
  • 変更を行うと、意図しない問題が発生する可能性があり、WalkMeが実装をサポートできません

6. 変更を保存する

展開

CMSとWalkMeエディタで変更内容を保存します。

  1. スニペットコードをヘッダー/フッターセクションに貼り付けた後、CMSで変更内容を保存します
    • このアクションには、「保存」、「更新」、「公開」ボタンを押すことが含まれる場合があります
  2. エディタでシステム設定に移動します
  3. 一般タブで、設定の公開をクリックします

WalkMeがサイトで正しく読み込むためには、エディタから設定をパブリッシュする必要があります。 これにより、必要なファイルが生成され、WalkMeが適切に機能できるようになります。

7. インストールを確認する

展開

  1. ウェブサイトにアクセスし、スニペットコードを動作させたい特定のページに移動します
  2. ページを調べて、希望の機能がアクティブになったことを確認します
  3. スニペットコードが期待通りに動作していないことに気づいた場合、コードの配置を再度確認してください
  4. それでも問題がある場合は、サポートチームに問い合わせることができます

スニペットが配置されると、エディタからパブリッシュされたコンテンツ を確認できるようになります。 スニペットをテストし、それが正しく設定されていることを確認するには:

  1. サイトを開きます
  2. 右クリックして、ページの検査を選択します
  3. コンソールを開きます
  4. 以下のテキストクエリを入力します : _walkMe.getEnvId()
  5. このコマンドは、どの環境が読み込まれているかを示す値を返します。
    1. 0 = 本番
    2. 1 = プレビュー
    3. 2 = 再生
    4. 3 = テスト
    5. 未定義 = スニペットが適切に設定されていないため、サポートに連絡する必要があります

これで完了です。 ウェブサイトにスニペットコードを正常にインストールしました。 さらに質問がある場合、またはサポートが必要な場合は、お気軽にお問い合わせください。

🎓 Digital Adoption Institute

この記事は役に立ちましたか?

ご意見ありがとうございます!

Be part of something bigger.

Engage with peers, ask questions, share ideas

Ask the Community
×