ガイド付きツアーの有効化

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:4分
  • サービスポータルページと標準プラットフォーム UI のガイド付きツアーを有効にします。

    始める前に

    必要なロール:admin

    このタスクについて

    ガイド付きツアーデザイナーJakarta リリースで初めて導入されました。Jakarta以降に作成された新しいインスタンスの場合、ガイド付きツアーはデフォルトでアクティブになっています。Jakarta前のインスタンスの場合、ガイド付きツアーはデフォルトで非アクティブになっています。

    Xanadu リリースでは、サービスポータルページでガイド付きツアーを実行することもできます。インスタンスを Xanadu にアップグレードすると、次の結果になります。
    • Xanadu の新機能であるインスタンスでは、サービスポータル のガイド付きツアー機能がデフォルトで有効になっています。
    • Xanadu にアップグレードしたXanadu前のインスタンスの場合、サービスポータル 機能のガイド付きツアーはデフォルトで非アクティブになっています。
    注:
    サービスポータルアプリケーションは、ユーザーがカスタムコンテキストで特定のプラットフォーム機能にアクセスできるように、ポータルをカスタマイズできるフレームワークを提供します。サービスポータルページのガイド付きツアーを作成して、そのコンテンツをユーザーに順を追って説明できます。

    手順

    1. アプリケーションナビゲーターで、「sys_properties.list」と入力します。
    2. [System Properties (システムプロパティ)] リストから次のプロパティを見つけて、その値を True に設定します。
      プロパティ 説明
      com.snc.guided_tours.standard_ui.enable インスタンス全体のガイド付きツアーを標準プラットフォーム UI およびワークスペースで実行できるようにします。
      com.snc.guided_tours.sp.enable インスタンス全体のガイド付きツアーをサービスポータルページで実行できるようにします。このプロパティ設定に関係なく、標準 UI ページのツアーを作成して公開できます。
      com.snc.guided_tours.custom_ui.enable インスタンス全体のガイド付きツアーをカスタム UI ページで実行できるようにします。

    タスクの結果

    標準プラットフォーム UI 要素と、 サービスポータル ページ上のカスタム UI 要素を参照するツアーの両方を参照するガイド付きツアーを作成、更新、および再生できます。ユーザーはこれらのツアーを再生できます。

    次のタスク

    ガイド付きツアーの計画、概要作成、下書きを開始します。サービスポータルガイド付きツアーのドラフトを作成する場合は、これらのアイテムを参照してください。
    アイテム 詳細
    ガイド付きツアーの吹き出しのステップ ガイド付きツアーは、要素に吹き出しステップが作成された後にその場所を特定できるように、指し示すすべての要素を認識できる必要があります。したがって、サービスポータルページ作成者は、作成するすべてのカスタム要素に一意の名前を付けて、データベース内のレコードとして検証できるようにする必要があります。たとえば、サービスポータルページに 2 つのウィジェットを作成する場合は、Widget1 と Widget2 のように一意の名前を割り当てる必要があります。

    HTML に属性を追加し、プロパティに一意の値を追加することで、要素をさらにカスタマイズできます。たとえば、システムは現在、 data-gtd-eid 属性と data-id 属性を使用して、要素を一意として識別します。

    サービスポータル ページ

    ベースシステムでは、SP ヘッダーメニューを使用するページからのみツアーを起動できます。手動で起動したチュートリアルは、カスタムヘッダーメニューのあるページには表示されません。

    ガイド付きツアーが SP ヘッダーメニューを使用しない サービスポータル ページにある場合は、ツアーがユーザーに表示されるように、自動起動用にツアーを構成する必要があります。このタイプのツアーがユーザーに表示されるようにするには、「 ガイド付きツアーの自動起動の設定」を参照してください。

    サービスポータルがページルートマップを使用している場合、ツアーが期待どおりに表示されないことがあります。たとえば、リダイレクトされたページに対してツアーが構成されている場合、ユーザーに想定どおりにツアーが表示されないことがあります。詳しくは、 ページ ID への参照のリダイレクト を参照してください。

    サービスポータルの自社用カスタム設定 サービスポータルページのブランディングを更新すると、それに応じてそのページのガイド付きツアーの吹き出しも更新されます。例: サービスポータル パネルのテーマの背景色を黄色に更新し、プライマリ色を赤に更新します。結果:ガイド付きツアー吹き出しパネルの背景が黄色になり、吹き出しテキストフィールドが赤色になります。
    サービスポータル ガイド付きツアー吹き出しの色
    ガイド付きツアーの吹き出しの色をカスタマイズすることも、ガイド付きツアーのデフォルトを使用することもできます。
    パラメーター デフォルト カスタム
    ガイド付きツアーの吹き出しでは、次の サービスポータル プロパティを使用します。 サービスポータルの色とは無関係にコールアウトの色を設定するには、次の CSS 変数を適用します。
    吹き出しの背景色 パネルの背景色 $gtd-callout-background
    吹き出しテキストの色 テキストの色 $gtd-callout-content-color
    吹き出し番号の色 (例:2/5) 控え目に示すテキスト $gtd-callout-number-color
    吹き出しの閉じるボタン (X) の色 控え目に示すテキスト $gtd-callout-close-color
    吹き出しのプライマリボタンの色 プライマリボタンの背景色 $gtd-callout-active-color