コンテンツにスキップ
「プリザンター入門」発売中！

拡張スタートガイド

概要

スタートガイドへのコンテンツ追加、コンテンツ削除等を行うための拡張機能です。

注意事項

  1. パラメータ変更時はパラメータ変更時の確認事項を確認してください。

制限事項

  1. 拡張スタートガイドのJSONファイルを更新した後は「プリザンターを再起動」するまで反映しません。
  2. スタートガイドで使用する画像はImplem.Pleasanter\wwwroot\images\フォルダ内に配置してください。
  3. 画像ファイル名の拡張子を省略することはできません。

設定方法

.\Pleasanter\App_Data\Parameters\ExtendedStartGuides 配下に以下の内容を含むJSONファイルを作成し、「アプリケーションを再起動」してください。JSONファイルの拡張子は必ずjsonにしてください。

ExtendedStartGuides配下はフォルダで階層化できます。この場合、ExtendedStartGuidesフォルダ配下の全てのJSONファイルが設定ファイルとして読み込まれます。

パラメータリスト

JSONファイルに指定するパラメータは以下の通りです。

パラメータリスト
パラメータ名 設定例 説明
Description "この拡張スタートガイドは…を表示します" 拡張スタートガイドの説明です。動作には影響しません。
Disabled false trueの場合、拡張スタートガイドの設定は無効化されます。
DeptIdList [1,2,3] 対象となる組織IDを配列形式で指定します。このパラメータは省略可能です。
GroupIdList [1,2,3] 対象となるグループIDを配列形式で指定します。このパラメータは省略可能です。
UserIdList [1,2,3] 対象となるユーザIDを配列形式で指定します。このパラメータは省略可能です。
TargetId "SgManual" Actionで指定した操作をするときの操作対象IDを指定します。操作対象IDについては「TargetIdとして指定できるid属性値」を参考にしてください。
Action "Append" 下記Actionパラメータの説明を確認してください。
StartGuides [{…},{…},{…}] 下記StartGuidesパラメータの説明を確認してください。
TargetIdとして指定できるid属性値
機能解説
ユーザマニュアル		 実践解説
アプリ作成ガイド		 活用促進
お役立ちコンテンツ		 機能拡張
Enterprise edition		 安心運用
課題解決支援
SgManual SgGoHandsOn SgMaterials SgExtensions SgSupport

スタートガイドに並ぶ各項目

Actionパラメータ

スタートガイドの追加、削除などの操作を、拡張ナビゲーションメニューと同じ書式で指定します。

変数 説明
Append TargetIdで指定したIDのスタートガイドの後ろにスタートガイドを追加します。
Prepend TargetIdで指定したIDのスタートガイドの前にスタートガイドを追加します。
Remove TargetIdで指定したIDのスタートガイドを削除します。
Replace TargetIdで指定したIDのスタートガイドを置換します。
ReplaceAll スタートガイドをすべて置換します。

StartGuidesパラメータ

拡張するスタートガイドの定義を指定します。

パラメータ名 設定例 説明
Id "SgStartGuide" 変更不可（スタートガイドのid属性の値を表します）
Text "ヘルプはこちら" リンクテキストを指定します。
Url "https://pleasanter.net" リンク先のURLを指定します。
ImgNameLight "image.svg" リンクテキストとともに表示する画像のファイル名を指定します。この画像は、テーマが「midnight」以外の場合に使用されます。※1
ImgNameDark "image-d.svg" リンクテキストとともに表示する画像のファイル名を指定します。この画像は、テーマが「midnight」の場合に使用されます。※1　※2
Target _blank スタートガイドクリック時のターゲット属性を指定します。例の場合、遷移先の画面を別タブで表示します。
Disabled true スタートガイドを無効化します。

※1　ファイル名は拡張子を含めて指定してください。
※2　省略した場合、ImgNameLightと同じ画像が表示されます。

サンプルコード

JSON（Append操作）
{
    "Disabled": "false",
    "TargetId": "SgExtensions",
    "Action": "Append",
    "StartGuides": [
        {
            "Id": "sg-01-append",
            "Text": "テストガイド01",
            "Url": "https://pleasanter.net/",
            "ImgNameLight": "hayato2.png",
            "ImgNameDark": "hayato3.png",
            "Target": "_blank",
            "Disabled": "false"
        },
        {
            "Id": "sg-02-append",
            "Text": "テストガイド02",
            "Url": "https://pleasanter.org/ja/manual",
            "ImgNameLight": "hayato1.png",
            "ImgNameDark": "",
            "Target": "_blank",
            "Disabled": "false"
        },
        {
            "Id": "sg-03-append",
            "Text": "テストガイド03",
            "Url": "https://implem.co.jp/",
            "ImgNameLight": "",
            "ImgNameDark": "",
            "Target": "_blank",
            "Disabled": "false"
        },
        {
            "Id": "sg-04-append",
            "Text": "テストガイド04",
            "Url": "https://pleasanter.org/",
            "ImgNameLight": "",
            "ImgNameDark": "",
            "Target": "_blank",
            "Disabled": "true"
        }
    ]
}

関連情報