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

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:3分
  • 埋め込みヘルプは、インスタンスではデフォルトで有効になっています。アドミニストレーターは、システムプロパティを変更して、インスタンスが埋め込みヘルプとやり取りする方法を変更できます。

    管理者が 埋め込みヘルプ > Properties (プロパティ) これらのプロパティを変更します。

    表 : 1. 埋め込みヘルプシステムプロパティ
    名前 説明
    com.glide.embedded_help.auto_close ユーザーが [ ツアーを開始 ] または [ ガイド付きセットアップに戻る] をクリックすると、ヘルプペインが自動的に閉じます。
    • タイプ: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) では、アクションは最初のガイド付きセットアップページにのみ表示されます。
    • タイプ:true | false
    • デフォルト値:false