API プラグイン › API プラグインを作成して使用する方法

API プラグインを作成して使用する方法

API プラグインを作成して使用するには、以下のプロセスに従います。

1. プラグインの目的を定義します。たとえば、ユーザが指定の期間にわたって予約できる会議室が選択フィールドに自動的に入力されるようにするなどです。 他の例には、プロジェクター、ビデオ会議ユニット、マイクなどの会議室用オプションがあります。
2. 前提条件を満たします。 以下が実行できる必要があります。
   • Java のプログラミング
   • フォーム デザイナによるフォームの作成
   • フォーム デザイナ フォームで以下のフィールドの作成。
     • 単一選択 フィールド、複数選択フィールド、2 重リスト フィールド
     • 動的テーブル フィールド
3. 以下のように API プラグイン ドキュメントを確認します。
   1. CA Service Catalog にログインし、［管理］、［ツール］を選択します。
   2. 左のメニューで、［リンク］を選択します。
   3. ［ドキュメント］セクションまでスクロールし、［プラグイン ドキュメント］をクリックします。

   API ドキュメントは、プラグイン用に Java クラス メソッドに基づいて自動的に生成される Java ドキュメントです。 プラグインを実装するためにインターフェース、クラス、メソッドなどを使用します。

4. 以下のように、プラグインが適用されるフォーム デザイナ フィールドのタイプに合わせて Java クラスを作成します。
   • 単一選択フィールド、複数選択フィールド、2 重リスト フィールドの場合： com.ca.usm.plugins.apis.forms.FDSelectDataProvider という名前のインターフェースを実装する Java クラスを作成する
   • 動的テーブル フィールドの場合： com.ca.usm.plugins.apis.forms.FDTableDataProvider という名前のインターフェースを実装する Java クラスを作成する

   インターフェースおよびサンプル Java クラスは、どちらも API プラグ イン ドキュメントに表示されます。 Java クラス用のモデルとして、API プラグ イン ドキュメント内のサンプルを使用できます。

5. （オプション）コンテンツ設定フォームを使用する場合は、これらのフォーム上のフィールドから値を取得し、必要に応じてそれらを使用します。
6. プラグイン用のプロパティ ファイルを作成します。 プロパティ ファイル用のモデルとして、API プラグ イン ドキュメント内のサンプルを使用できます。
7. 必要に応じて、以下のいずれかを行います。
   • 静的テーブル用の並べ替えおよびページ付けパラメータの設定
   • 動的テーブル用の並べ替えおよびページ付けパラメータの設定
   • 選択ボックス用のページ付けを設定する［ページ サイズ］属性の設定
8. 以下を格納するためのフォルダを作成します。
   • プロパティ ファイル

     重要： プロパティ ファイルはフォルダの最上位レベルに格納します。 サブフォルダにプロパティ ファイルを格納しないでください。

   • クラスとサポート ライブラリを提供する JAR ファイル

     必要に応じて、サブフォルダにそれらを格納できます。

9. 以下の手順に従って、プラグインをアクティブにします。
   1. Service View 用の Windows サービスを停止します。 サービスは CAService View という名前です。
   2. フォルダ（存在する場合は、すべてのサブフォルダを含む）を %USM_HOME%¥filestore¥plug-in フォルダにコピーします。
   3. Service View 用の Windows サービスを再スタートします。
10. 以下の手順に従って、プラグインが正しく適用されたことを確認します。
    1. CA Service Catalog にログインし、［管理］、［ツール］を選択します。
    2. 左のメニューで、［プラグイン］を選択します。
    3. プラグインがリスト表示され、その詳細が正しく表示されることを確認します。

フォーム フィールドで使用されるこの API をテストする準備が整いました。