埋め込みヘルプ のシステム プロパティ

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む3読むのに数分
  • 埋め込みヘルプは、インスタンスでデフォルトで有効になっています。管理者は、システムプロパティを変更して、インスタンスと埋め込みヘルプとのやり取りを変更することができます。

    管理者は、次の場所に移動します。 埋め込みヘルプ > プロパティ をクリックして、これらのプロパティを変更します。

    表 : 1. 埋め込みヘルプシステムプロパティ
    名前 説明
    com.glide.embedded_help.auto_close ユーザーが [ ツアーを開始 ] または [ Guided Setup に戻る] をクリックすると、ヘルプペインが自動的に閉じます。
    • タイプ:true | false
    • デフォルト値:true
    com.glide.embedded_help.cdn_timeout コンテンツ配信ネットワーク (CDN) からのコンテンツのプルがタイムアウトするまでの時間 (ミリ秒単位)。
    • タイプ:整数
    • デフォルト値:2000
    com.glide.embedded_help.enabled 埋め込みヘルププラグインを有効にしてアクティブ化します。
    • タイプ:true | false
    • デフォルト値:true
    com.glide.embedded_help.enable_video ユーザーがヘルプコンテンツ内の埋め込みビデオを表示できるようにします。管理者はビデオと説明を埋め込むことができますが、このプロパティが false の場合、ビデオと説明はヘルプペインで非表示になります。
    • タイプ:true | false
    • デフォルト値:true
    注:
    ビデオコンテンツを埋め込む場合は、ビデオ埋め込みコードと説明をタグで囲 <div class="video"> みます。このプロパティを無効にすると、コンテンツが表示されるときにタグ内の <div class="video"> コンテンツが非表示になります。
    com.glide.embedded_help.sync ユーザーが UI ページにアクセスしたときに、インスタンスが CDN で更新されたコンテンツを検索できるようにします。インスタンスは、指定された頻度に対してトピックの最終 同期 日をチェックし、更新されたコンテンツを CDN で検索するかどうかを決定します。
    • タイプ:true | false
    • デフォルト値:true

    このプロパティが無効 (false) の場合、埋め込みヘルプコンテンツは CDN トピックの更新と同期されません。

    com.glide.embedded_help.sync_frequency CDN で更新されたコンテンツを検索するために、埋め込みヘルププロセスのトピックの最終 同期 日から何日経過する必要があるかを指定します。
    • タイプ:整数
    • デフォルト値:15
    com.glide.embedded_help.sync_self_hosted セルフホストインスタンスがコンテンツを CDN と同期するかどうかを指定します。
    • タイプ:true | false
    • デフォルト値:false
    com.glide.embedded_help.url 埋め込みヘルプが動的に取得される場所を一覧表示します。
    • タイプ:文字列
    • デフォルト値:場合による
    com.glide.embedded_help.version ヘルプを表示するインスタンスのバージョンを指定します。
    • タイプ:文字列
    • デフォルト値:Jakarta

    空白の場合は、インスタンスが現在実行しているバージョンのヘルプが表示されます。

    [sys_properties] テーブルに移動すると、次のシステムプロパティを使用できます。

    名前 説明
    com.glide.embedded_help.guided_setup.persist_actions すべてのページに表示するステータスに基づくガイド付き設定アクションを埋め込みヘルプパネルで有効にします。例として、[ 完了としてマーク ] アクションがあります。デフォルトの動作 (false) では、アクションは最初の [Guided Setup] ページにのみ表示されます。
    • タイプ:true | false
    • デフォルト値:false