18.2 プラグインの実装

この項では、プラグインを追加、管理、再利用および共有する方法について説明します。プラグインの例はOracle Technology NetworkのOracle Application Expressプラグイン・リポジトリにあり、サンプル・データベース・アプリケーションに含まれています。

トピック:

関連項目:

「プラグインの例の表示」
「プラグイン・リポジトリの表示」

18.2.1 プラグインについて

開発者はプラグインを使用して、Oracle Application Expressで使用可能な組込みタイプを宣言的に拡張、共有および再利用できます。

Oracle Application Expressは、認証スキーム、認可スキーム、アイテム、リージョン、動的アクションとプロセス・タイプのグループ・セットをサポートします。プラグインによってアプリケーション内で新しいタイプを宣言的に作成および使用することによって、これらの組込みタイプを拡張する手段が提供されます。プラグインは再利用を目的として設計されているため、開発者はプラグインを別のワークスペースにエクスポートおよびインポートしたり、プラグイン・リポジトリを使用してプラグインをOracle Application Expressプラグイン・コミュニティと共有できます。

プラグインを実装するプロセスには、次のステップがあります。

アプリケーション・ワークスペースでプラグインを作成するか、またはインポートします。
プラグインを使用するための認可スキーム、アイテム、リージョン、プロセスまたは動的アクション・タイプを編集または作成します。
プラグインをテストするためにアプリケーションを実行します。

18.2.2 プラグインの例の表示

次の場所で、プラグインの実装例を表示できます。

Oracleプラグイン・リポジトリに移動します。

プラグイン・リポジトリの表示を参照してください。
パッケージ・アプリケーションであるサンプル・データベース・アプリケーションをインストールします。

完全開発環境でのパッケージ・アプリケーションの管理およびサンプル・データベース・アプリケーションのインストールおよび実行を参照してください。
Oracle Learning Library (http://www.oracle.com/oll/apex)に移動します。表示されたフィールドに検索基準を入力し、「検索」をクリックします。

18.2.3 プラグイン・ページへのアクセス

プラグイン・ページにアクセスするには、次のステップを実行します

共有コンポーネント・ページにナビゲートします。
1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。
2. アプリケーションを選択します。
3. アプリケーションのホームページで、「共有コンポーネント」をクリックします。
  共有コンポーネント・ページが表示されます。
「他のコンポーネント」で、「プラグイン」をクリックします。
プラグイン・ページが表示され、「プラグイン」タブがデフォルトで選択されます。使用可能なすべてのプラグインが表示されます。

ページの外観は、ページ上部にある検索バーを使用してカスタマイズできます。

関連項目:

「実行中のアプリケーションでの対話モード・レポートのカスタマイズ」

18.2.4 プラグインの作成

プラグインを作成するには、次のようにします。

ヒント:

この項で説明する属性の詳細は、フィールドレベル・ヘルプを参照してください。Oracle Application Expressでのフィールドレベル・ヘルプの表示を参照してください。

プラグイン・ページにナビゲートします。
「作成」をクリックします。
プラグインの作成ウィザードが表示されます。
「プラグインの作成」で、プラグインを作成する方法を選択し、「次へ」をクリックします。
「名前」で、次の項目を指定します。
1. 名前(必須): プラグインの名前を入力します。
2. 内部名(必須): プラグインの内部名を入力します。この名前は、現在のアプリケーション内で一意である必要があります。
  注意:
  内部名をワールドワイドでグローバルな一意名とするために、組織のドメイン名を内部プラグイン名の接頭辞として使用することをお薦めします。たとえば、ドメイン名example.com.comをSliderという名前のプラグインに接頭辞として付けると、内部名はCOM.EXAMPLE.SLIDERとなります。
3. タイプ(必須): このプラグインを使用するコンポーネントのタイプを選択します。選択したプラグイン・タイプに応じて、「コールバック」および「標準属性」の下のオプションが変わります。詳細は、フィールドレベル・ヘルプを参照してください。
4. カテゴリ: 選択したタイプが「動的アクション」の場合にのみ表示されます。ユーザー・インタフェースでプラグインが表示されるカテゴリを選択します。
「サブスクリプション」で、次のようにします。
- マスター・プラグインの参照元 - このプラグインを、このワークスペースの別のプラグインに基づくようにするには、リストからプラグインを選択します。それ以外の場合、このフィールドをブランクのままにし、これをこのプラグインのマスター・コピーとします。
「ソース」で、次のようにします。
1. PL/SQLコード - このプラグインのレンダリング、検証、実行およびAJAXコールバックの実行用のプロシージャを含むコードのPL/SQL無名ブロックを入力します。パフォーマンス上の理由から、このコードはデータベース内のPL/SQLパッケージに格納することもできます。
2. PL/SQLコードを検証しない(実行時にのみPL/SQLコードを解析)。 - PL/SQLコードを実行時にのみ解析する場合は、このオプションを選択します。選択しない場合、コードはプラグインが作成されるときに解析されます。
「コールバック」で、該当する属性を構成します。表示される属性はプラグイン・タイプに応じて決まります。属性の詳細および例を確認するには、フィールドレベル・ヘルプを参照してください。
ヒント:
すべてのコールバック・ファンクション名は、無名PL/SQLコード・ブロックのファンクション、パッケージ内のファンクションまたはデータベース内のスタンドアロン・ファンクションを参照できます。
「ユーザー・インタフェース」で、このプラグインに対してアプリケーション・ビルダーでサポートする必要のある表示デバイスを選択します。オプションは次のとおりです。
- デスクトップ
- モバイル
「標準属性」で、このプラグインに適用する属性を選択します。「標準属性」は、一部のプラグインには表示されません。詳細は、フィールドレベル・ヘルプを参照してください。
「情報」で、次のステップを実行します。
1. バージョン: プラグインのバージョンを識別する文字列を入力します。
2. URL情報: プラグイン作成者のホームページのURL、またはプラグインに関する追加情報のURLです。
「ヘルプ・テキスト」に、ユーザーがプラグインの機能を理解するのに使用するヘルプ・テキストを入力します。
「コメント」に、アプリケーションが実行されているときに表示されないコメントおよび注意を入力します。
各オプションの詳細は、フィールドレベル・ヘルプを参照してください。
「プラグインの作成」をクリックします。
プラグインが作成されたら、追加のカスタム属性の指定、プラグインと関連付けるイメージ、CSSおよびJavaScriptファイルなどのファイルのアップロードおよびイベントの追加を実行できます。

関連項目:

18.2.5 プラグインの編集

プラグインを編集するには、次のようにします。

プラグイン・ページにナビゲートします。
編集または表示するプラグインをクリックします。
プラグインの作成/編集ページが表示されます。
変更を加えます。
各オプションの詳細は、フィールドレベル・ヘルプを参照してください。
「変更の適用」をクリックします。

関連項目:

18.2.6 プラグインへのカスタム属性の追加

プラグイン属性は、プラグインが使用されるとき、開発者に追加データの入力を求めるプロンプトをアプリケーション・ビルダー内で表示するために使用します。

プラグインにカスタム属性を追加するには、次の手順を実行します。

プラグイン・ページにナビゲートします。
変更するプラグインをクリックします。
プラグインの作成/編集ページが表示されます。
「カスタム属性」で、属性値の置換を有効化または無効化します。
- 代替属性値: 開発者が指定するカスタム属性値には、&P1_DNAMEなどの置換構文で参照されるアイテムが含まれる場合があります。
  
  「はい」に設定すると、Application Expressにより自動的に置換構文が実際の値で置き換えられます。
  
  「いいえ」に設定すると、p_plugin、p_item、p_regionなどのattribute_01からattribute_15までのレコード・タイプ属性に置換構文が変更されずに書き込まれます。プラグインの開発者は、これらの置換構文の参照をapex_plugin_util.replace_substitutionsのコールで置換するか、同様の置換を行う必要があります。詳細は、アイテム・ヘルプを参照してください。
  
  詳細は、フィールドレベル・ヘルプを参照してください。
属性を追加するには、「属性の追加」をクリックします。
属性の編集ページが表示されます。対象となる属性を編集します。

特定の属性の詳細は、フィールドレベル・ヘルプを参照してください。
属性を作成して編集ページに戻るために「作成」をクリックするか、属性を作成して別の属性の作成を続行するために「作成後、さらに作成」をクリックします。

注意:

「作成」または「作成後、さらに作成」をクリックするとき、右側のパネルの「プラグイン」の下の「ページに戻る」チェック・ボックスが選択されていると、同じ属性の編集ページが表示されます。

関連項目:

「プラグイン・ページへのアクセス」」

18.2.7 プラグインに関連付けられたファイルのアップロード

この項では、プラグインに関連付けられたファイルをアップロードする方法について説明します。

トピック:

18.2.7.1 プラグインに関連付けられたファイルのアップロード

ファイルをアップロードする手順は、次のとおりです。

プラグイン・ページにナビゲートします。
プラグインを選択します。
プラグインの作成/編集ページが表示されます。
「ファイル」セクションを見つけます。
「ファイルの接頭辞」は、Webサーバーがプラグインのファイルを指す場合に使用する仮想パスを特定します。プラグイン定義とともにデータベースに格納されているファイルを参照する場合は、何も指定しないでください。
ファイルをアップロードする手順は、次のとおりです。
1. 「ファイルのアップロード」をクリックします。
2. アップロードするファイルを参照して選択します。
3. 「アップロード」をクリックします
  作成/編集ページが表示されます。アップロード対象ファイルの名前が「ファイル」の下に表示されます。
「変更の適用」をクリックします。

関連項目:

「プラグイン・ページへのアクセス」」

18.2.7.2 CSSおよびJavaScriptファイルの自動ロード

「ロードするファイルURL」属性を構成すると、ページでプラグインが使用されるときに、CSSおよびJavaScriptファイルをOracle Application Expressで自動的にロードできます。どのアップロード済ファイルをどの順序でロードする必要があるかを指定するには、次のステップを実行します。

CSSまたはJavaScriptファイルを自動ロードするには、次のステップを実行します。

プラグイン・ページにナビゲートします。
プラグインを選択します。
プラグインの作成/編集ページが表示されます。
「ロードするファイルURL」で、次のステップを実行します。
1. カスケード・スタイルシート - このプラグインでロードするカスケード・スタイルシート・ファイルURLを入力します。
2. JavaScript - このプラグインでロードするコードのJavaScriptファイルURLを入力します。
置換文字列#PLUGIN_FILES#を使用することで、プラグインのファイル接頭辞の値を置換できます。次に例を示します。
```
#PLUGIN_FILES#my_plugin.css
```
詳細および例を確認するには、フィールドレベル・ヘルプを参照してください。
「変更の適用」をクリックします。

関連項目:

「プラグイン・ページへのアクセス」」

18.2.8 プラグインへのイベントの追加

この項では、アイテム、リージョンまたは動的アクション・タイプのプラグインにイベントを追加して、動的アクションに公開できるようにする方法について説明します。たとえば、Start Slide、Sliding、Stop Slideなどのイベントを公開するSliderプラグインによって、これらのイベントが発生したときに応答できる動的アクションを作成できます。

プラグインにイベントを追加するには、次の手順を実行します。

プラグイン・ページにナビゲートします。
編集するプラグインをクリックします。
プラグインの作成/編集ページが表示されます
「イベント」で、「イベントの追加」をクリックします。
「イベント」の下に新しい行が表示されます。
「イベント」で、次のように入力します。
1. 名前: 動的アクション内でプラグイン・イベントが表示される表示名(例: Start Slide)。
2. 内部名: 動的アクションをトリガーする割り当てられたJavaScriptイベントの名前。例: slidestart。
「イベントの追加」をクリックします。
手順3から4を繰り返して、別のイベントを追加します。
「変更の適用」をクリックします。

関連項目:

「プラグイン・ページへのアクセス」」

18.2.9 プラグインの削除

プラグインは使用中でなければ削除できます。プラグインを使用中の場合、「削除」ボタンは表示されません。

プラグインを削除するには、次のようにします。

プラグイン・ページにナビゲートします。
削除するプラグインをクリックします。
プラグインの作成/編集ページが表示されます。
「削除」をクリックします。
確認して、「OK」をクリックします。

関連項目:

「プラグイン・ページへのアクセス」」

18.2.10 プラグイン・リポジトリの表示

プラグイン・リポジトリによって、開発者がプラグインを共有およびダウンロードできる一元的な場所が提供されます。リポジトリはOracle Technology Networkにあります。

プラグイン・リポジトリを表示するには、次の手順を実行します。

プラグイン・ページにナビゲートします。プラグイン・ページへのアクセスを参照してください。
「プラグイン・リポジトリの表示」をクリックします。
Oracle Application Expressプラグイン・リポジトリが表示されます。

18.2.11 プラグイン・ページからのプラグインのインポート

エクスポートされたプラグインをアプリケーションにインポートするにはこのオプションを使用します。プラグインのインポートは、ここで説明するように、プラグイン・ページの「共有コンポーネント」からか、アプリケーション・ビルダーのホームページから実行できます。

プラグインをインポートするには、次の手順を実行します。

プラグイン・ページにナビゲートします。
「インポート」をクリックします。
プラグインのインポート・ページが表示されます。
「ファイルの指定」で、次のステップを実行します。
1. インポート・ファイル: インポート・ファイルの名前を入力または参照します。
2. ファイル・タイプ: 「プラグイン」を選択します。
3. ファイルのキャラクタ・セット: インポート・ファイルのキャラクタ・セット・エンコードを選択します。
4. 「次へ」をクリックします。
「ファイルのインポートの確認」で、「次へ」をクリックします。
「インストール」で、「プラグインのインストール」をクリックします。

関連項目:

18.2.12 プラグイン・ページからのプラグインのエクスポート

プラグイン定義をファイルにエクスポートするにはこのオプションを使用します。このファイルは任意のAPEXアプリケーションにインポートできます。プラグインのエクスポートは、ここで説明するように、プラグイン・ページの「共有コンポーネント」からか、「ワークスペース」ホームページから実行できます。

プラグイン・ページからプラグインをエクスポートするには、次のステップを実行します。

プラグイン・ページにナビゲートします。
「タスク」で、「プラグインのエクスポート」をクリックします。
プラグインのエクスポート・ページが表示されます。
プラグインのエクスポート・ページで、次のステップを実行します。
1. アプリケーション: プラグインのエクスポート元のアプリケーションを選択します。
2. プラグイン - プラグインを選択します。
3. ファイル形式: プラグイン・エクスポートのファイル形式を選択します。
4. 「エクスポート」をクリックします
「エクスポート」をクリックします。
ダウンロード完了メッセージが表示されます。