UI 拡張ポイントの作成と追加

アプリケーションを開発するときは、UI 拡張ポイントを作成し、HTML 拡張などのサーバー側 UI マクロ、またはベースアプリケーションコードの UI ページに追加します。

UI 拡張ポイントを使用して、登録されたカスタム UI マクロにデータまたはオブジェクトを送信でき、返された結果が処理される特定の場所を指定します。

UI 拡張ポイントの作成

アプリケーションコードの HTML 拡張などの UI マクロに配置できる UI 拡張ポイントを作成します。UI 拡張ポイントを配置することで、データまたはオブジェクトをカスタマイズに送信でき、データが返されるアプリケーションコード内の特定の場所を指定します。

始める前に

必要なロール：admin、またはアプリケーションの開発者またはアドミニストレーター向けの特定のロール

注:

アプリケーション固有のアドミンロールと委託開発については、「アプリケーション管理アプリのアクセス制御ルール」および「委託開発と展開」を参照してください。

このタスクについて

定義 拡張ポイントのコンテンツと構造。この定義では、カスタマイズの構成方法、アプリケーションコードとのやり取りの方法、および拡張ポイントでカスタマイズによって返されるデータを処理する方法について説明します。

適切な定義を作成することで、拡張の機能の構造を提供できます。

手順

1. 移動先 すべて > システム拡張ポイント > UI 拡張ポイント.
2. [新規] をクリックします。
3. フォームで、フィールドに入力します。

   表 : 1. UI 拡張ポイントフォーム

   フィールド	説明
   名前	拡張ポイントの一意の名前。名前は最長 100 文字の英数字 (特殊文字を含む) です。
   API 名	拡張ポイント API の名前。適用先のアプリケーションスコープが先頭に付加されます。これはシステムによって割り当てられた名前であり、変更することはできません。
   アプリケーション	拡張ポイントがアサインされているアプリケーションスコープ。これはシステムによって割り当てられ、変更することはできません。スコーピングを使用することで提供される保護の詳細については、「Application scope」を参照してください。
   このスコープに制限	拡張ポイントをアプリケーションスコープのみに制限するためのオプション。
   AJAX/REST 経由のアクセスを許可	AJAX または REST を介した UI 拡張ポイントへのアクセスを有効または無効にするためのオプション。 これらの開発アーキテクチャと手法の詳細については、「 AJAX と REST API」を参照してください。
   説明	カスタムスクリプトの要件 UI マクロ、 UI スクリプトの構成方法やアプリケーションコードでの動作方法などが含まれます。
   例	カスタム UI マクロの例 この拡張ポイントとやり取りする場合は、アプリケーションコードで動作するように構成する必要があります。

4. [送信] をクリックします。

ベースアプリケーションコードに UI 拡張ポイントを追加する

ベースアプリケーションコードの UI マクロまたは HTML 拡張に UI 拡張ポイントを追加します。拡張ポイントを追加するには、登録済みカスタムアーティファクトが実行される場所を識別する API 呼び出しを行います。

始める前に

必要なロール：admin、またはアプリケーションの開発者またはアドミニストレーター向けの特定のロール

アプリケーションコードで UI マクロまたは UI ページに追加する前に、まず UI 拡張ポイントを作成する必要があります。

注:

アプリケーション固有のアドミンロールと委託開発については、「アプリケーション管理アプリのアクセス制御ルール」および「委託開発と展開」を参照してください。

手順

1. アプリケーションコードで、スクリプト拡張ポイントを追加する既存の UI マクロにアクセスするか、新しい UI マクロを作成します。
   jelly タグを使用した UI マクロの作成の詳細については、「 UI マクロ と Jelly のタグ」を参照してください。
2. UI マクロで、カスタム UI マクロ出力を収集して処理する場所にコード行を含む jelly タグを追加します。
   通常、このコード行には次のものが含まれます。

   • UI 拡張ポイントの名前を識別する call_extension コマンド ( 例:extension="global.KMArticle.ViewHeader") で、カスタム UI マクロが登録されます。
   • レンダリング時に UI マクロに渡される引数。たとえば、 ナレッジベース 記事の場合、 knowledgerecord="${knowledgeRecord}" は現在のナレッジレコードを渡します。
   • (オプション)この拡張ポイントの実装が複数ある場合、 limit コマンドを使用して、x 個の実装を返すように指定します ( たとえば、limit="1")。この図は、これらのコマンドを含む UI マクロを示しています。