プラグイン管理

プラグインは、プラットフォーム外のWebページをサイドバーの入口として取り込みます。プラットフォームはプラグインのアドレスをiframeで読み込み、アドレスの後ろにapiクエリパラメータ（値はプラットフォーム自身のアドレス）を付加します。プラグインのページはこれを使ってプラットフォームのAPIを呼び出します。プラグインの認証とデータアクセスはプラグインのページ側で実装し、プラットフォームは役割とプロジェクトに応じて入口の表示範囲を制御します。

前提条件

項目	内容
メニュー入口	管理 → プラグイン
ルート	/plugins
ページ権限	「プラグインを表示」
インターフェース権限	「プラグインを表示」（一覧と詳細）、「プラグインを管理」（作成、編集、削除）
ロール	管理者とプロジェクトマネージャーは作成・編集でき、削除ボタンは管理者だけに表示されます
依存	プラグインのページが、アドレスでアクセスできる独立したページとしてデプロイ済みであること

プラグインの設定と仕組み

プラグインのフィールド

フィールド	タイプ	必須	既定値	説明
プラグイン名	テキスト	はい	なし	一意。サイドバー入口の名前として使います
プラグイン説明	テキスト	いいえ	空	最大500文字
プラグインアドレス	テキスト	はい	なし	完全なアドレス（例：https://example.com/plugin）
メニューグループ	列挙	はい	データ	データ、モデル、管理の3グループ
有効化	スイッチ	いいえ	オン	オフにすると入口がサイドバーから外れ、ページに無効のメッセージを表示します
全プロジェクトに開放	スイッチ	いいえ	オフ	オンにすると全プロジェクトで表示します
プロジェクト権限	複数選択	条件付き	空	全体開放がオフの場合は必須。選択したプロジェクト内だけに表示します
ロール権限	複数選択	いいえ	空	入口は選択したロールだけに表示します。空の場合、どのロールにも入口を表示しません

プラグインのタイプ

プラグインは2つの軸で分類します。

軸	値	作用範囲
メニューグループ	データ、モデル、管理	入口がサイドバーのどのグループに現れるかを決めます
プロジェクト範囲	全体、プロジェクト	全体は全プロジェクトに開放し、プロジェクトは選択したプロジェクト内だけに表示します

プラグインの仕組み

段階	動作
メニュー入口の生成	「有効化」「ロールに現在のユーザーが含まれる」「全体、または所属プロジェクトがユーザーの表示可能プロジェクト内」を同時に満たすとき、入口が対応するメニューグループに現れます
開き方	サイドバーの入口をクリックすると/plugins/{id}を開き、プラットフォームはプラグインのアドレスをiframeで読み込みます
パラメータの受け渡し	プラットフォームはプラグインのアドレスの後ろにapi=<プラットフォームのアドレス>を付加し、プラグインのページはこのパラメータをAPIの基点として読み取ります
無効化の動作	プラグインを無効化すると入口はサイドバーから外れ、開いていたページには「このプラグインは無効です」と表示します

独自開発

プラグインは独立してデプロイするWebページで、開発と公開はプラットフォームの外で行います。

1. HTTPSでアクセスできるページを実装し、プラグインのページとします。
2. アドレスバーのapiクエリパラメータを読み取り、プラットフォームAPIの基点とします。
3. その基点でプラットフォームのRESTful APIを呼び出し、クロスオリジン要求ではセッション資格情報を付けます。
4. プラグイン管理でプラグインを作成し、ページのアドレス、メニューグループ、ロールとプロジェクトの範囲を入力して、保存し有効化します。

制約と制限

項目	値	説明
名前の一意性	同名のプラグインは重複して作成できません	保存時に検証します
説明の長さ	500文字以下	超過時は保存を拒否します
アドレス形式	有効な完全アドレスであること	検証に失敗すると保存を拒否します
ロール権限が空	入口をどのロールにも表示しません	少なくとも1つのロールを選択します
プロジェクト範囲	全体開放でないプラグインは少なくとも1つのプロジェクトが必要です	そうでないとユーザーに入口が表示されません
削除方式	論理削除	管理者の操作です
メニュー更新	変更後は現在のセッションを更新します。他のユーザーは再ログイン後に反映されます	入口はセッション単位で生成します

トラブルシューティング

現象	考えられる原因	対処	担当
プラグイン一覧が空	プラグインがない、または現在のアカウントに表示可能なプロジェクトがありません	プラグインを作成するか、全プロジェクトに開放します	管理者、プロジェクトマネージャー
保存時に名前が存在すると表示される	プラグイン名が重複しています	名前を変更します	管理者、プロジェクトマネージャー
保存時にアドレス形式が正しくないと表示される	アドレスが不完全、またはプロトコルがありません	プロトコルを含む完全なアドレスを入力します	管理者、プロジェクトマネージャー
作成後にサイドバーへ入口が表示されない	未アクティブ、ロール権限が空、またはプロジェクト範囲に現在のプロジェクトが含まれません	有効化の状態、ロール権限、プロジェクト権限を確認します	管理者、プロジェクトマネージャー
開くと「このプラグインは無効です」と表示される	プラグインが無効になっています	プラグインを有効化します	管理者、プロジェクトマネージャー
ページが空白、または読み込みに失敗する	プラグインのページに到達できない、またはiframeへの埋め込みが禁止されています	プラグインのページがアクセス可能で埋め込みを許可しているか確認します	プラグイン開発者、管理者

関連ページ

ページ	用途
モジュール権限	「プラグインを表示」と「プラグインを管理」を設定します
プロジェクト	プラグインを表示するプロジェクトを管理します
ユーザー	役割とモジュール権限を割り当てます
システム設定	システムパラメータとメニュー関連の設定