| Oracle® Application Expressアプリケーション・ビルダー・ユーザーズ・ガイド リリース4.2 for Oracle Database 12c B71338-03 |
|
 前 |
 次 |
| Oracle® Application Expressアプリケーション・ビルダー・ユーザーズ・ガイド リリース4.2 for Oracle Database 12c B71338-03 |
|
前 |
次 |
このセクションでは、プラグインをアプリケーションに追加する方法と、再利用および共有を管理する方法について説明します。プラグインの例はOracle Technology NetworkのOracle Application Expressプラグイン・リポジトリから入手可能で、「サンプル・データベース・アプリケーション」に含まれています。
内容は次のとおりです。
開発者はプラグインを使用して、Oracle Application Expressで使用可能な組込みタイプを宣言的に拡張、共有および再利用できます。
Oracle Application Expressは、認証スキーム、認可スキーム、アイテム、リージョン、動的アクションとプロセス・タイプのグループ・セットをサポートします。プラグインによってアプリケーション内で新しいタイプを宣言的に作成および使用することによって、これらの組込みタイプを拡張する手段が提供されます。プラグインは再利用を目的として設計されているため、開発者はプラグインを別のワークスペースにエクスポートおよびインポートしたり、プラグイン・リポジトリを使用してプラグインをOracle Application Expressプラグイン・コミュニティと共有できます。
プラグインを実装するプロセスには、次のステップがあります。
アプリケーション・ワークスペースでプラグインを作成するか、またはインポートします。
プラグインを使用するための認可スキーム、アイテム、リージョン、プロセスまたは動的アクション・タイプを編集または作成します。
プラグインをテストするためにアプリケーションを実行します。
プラグインの実装例については、次のURLのOracleプラグイン・リポジトリを参照してください。
http://apex.oracle.com/plugins
追加のプラグインの実装例については、次の場所にあるOracle Learning Libraryに移動し、ページの下部にあるリンクをクリックしてライブラリにアクセスし、Oracle Application Express (APEX)製品OBEの検索基準を入力します。
プラグインにアクセスするには、次の手順を実行します。
プラグイン・ページにナビゲートします。
「ワークスペース」ホームページにナビゲートします。
「アプリケーション・ビルダー」をクリックします。
アプリケーションを選択します。
「共有コンポーネント」をクリックします。
「ユーザー・インタフェース」で、「プラグイン」を選択します。
プラグイン・ページが表示され、「プラグイン」タブがデフォルトで選択されます。使用可能なすべてのプラグインが表示されます。
ページの外観は、ページ上部にある検索バーを使用してカスタマイズできます。使用可能なコントロールは次のとおりです。
「検索」アイコン: 虫めがねに似ています。このアイコンをクリックして、検索を特定の列のみに絞ります。すべての列を検索するには、「すべての列」を選択します。
テキスト・フィールド: 大/小文字を区別しない検索基準(ワイルドカード文字は暗黙的に定義される)を入力し、「実行」をクリックします。
「実行」ボタン: 検索を実行したり、フィルタを適用します。
アイコンの表示(デフォルト): 各プラグインを大きいアイコンとして表示します。プラグインを編集するには、該当するアイコンをクリックします。
レポートの表示: 各プラグインをレポートで1行に表示します。
アクション・メニュー: アクション・メニューを表示します。レポート・ビューをカスタマイズするにはこのメニューを使用します。「「アクション」メニューについて」を参照してください。
プラグインを編集するには、次のようにします。
プラグイン・ページにナビゲートします。「プラグインへのアクセス」を参照してください。
編集または表示するプラグインをクリックします。
プラグインの作成/編集ページが表示されます。
変更を加えます。
各オプションの詳細は、アイテム・ヘルプ、「プラグインの作成」、「プラグインへのカスタム属性の追加」、「プラグインに関連付けるファイルのアップロード」および「プラグインへのイベントの追加」を参照してください
「変更の適用」をクリックします。
|
ヒント: 次のステップの実行中、特定のフィールドに関する詳細を見るには、アイテム・ヘルプを参照してください。 |
プラグインを作成するには、次のようにします。
プラグイン・ページにナビゲートします。「プラグインへのアクセス」を参照してください。
「作成」をクリックします。
プラグインの作成/編集ページが表示されます。
「名前」で、次の項目を指定します。
名前(必須): プラグインの名前を入力します。
内部名(必須): プラグインの内部名を入力します。この名前は、現在のアプリケーション内で一意である必要があります。
|
ヒント: 内部名をワールドワイドでグローバルな一意名とするために、組織のドメイン名を内部プラグイン名の接頭辞として使用することをお薦めします。たとえば、ドメイン名mycompany.comをSliderという名前のプラグインに接頭辞として付けると、内部名はCOM.MYCOMPANY.SLIDERとなります。 |
タイプ(必須): このプラグインを使用するコンポーネントのタイプを選択します。「コールバック」と「標準属性」の設定は選択されるプラグイン・タイプによって異なります。詳細は、次の項を参照してください。
カテゴリ (タイプが動的アクションの場合に必要): UIでプラグインを表示するカテゴリを選択します。
「サブスクリプション」で、次の項目を指定します。
マスター・プラグインの参照元: このプラグインを、このワークスペースの別のプラグインに基づくようにするには、ポップアップ・リストからプラグインを選択します。それ以外の場合、このフィールドをブランクのままにし、これをこのプラグインのマスター・コピーとします。
「ソース」で、次の項目を指定します。
「PL/SQLコード」: このプラグインのレンダリング、検証、実行およびAJAXコールバックの実行用のプロシージャを含むコードのPL/SQL無名ブロックを入力します。
PL/SQLコードを検証しない(実行時にのみPL/SQLコードを解析)。 - PL/SQLコードを実行時にのみ解析する場合は、このオプションを選択します。選択しない場合、コードはプラグインが作成されるときに解析されます。
「コールバック」で、次の項目を指定します。
レンダリング・ファンクション名(リージョン、アイテムおよび動的アクション・タイプのプラグインの場合のみ使用可能): プラグインをレンダリングするためにコールされるPL/SQLファンクションの名前を入力します。
AJAXファンクション名(認証、リージョン、アイテムおよび動的アクション・タイプのプラグインの場合のみ使用可能): AJAXのコールで追加データをロードするためにプラグインによって使用されるPL/SQLファンクションの名前を入力します。
検証ファンクション名(アイテム・タイプのプラグインの場合のみ使用可能): 送信済データについて基本検証を実行するためにプラグインが使用できるPL/SQLファンクションの名前を入力します。
実行ファンクション名(認可とプロセス・タイプのプラグインの場合のみ使用可能): プラグインを実行するためにコールされるPL/SQLファンクションの名前を入力します。
セッション監視ファンクション名(認証タイプのプラグインの場合のみ使用可能): セッション監視検証を実行するためにプラグインが使用するPL/SQLファンクションの名前を入力します。
セッション・ファンクション名が無効です。(認証タイプのプラグインの場合のみ使用可能): 無効なセッションが検出された場合にプラグインがコールするPL/SQLファンクションの名前を入力します。たとえば、このファンクションを使用してシングル・サインオン・サーバーをコールします。
認証ファンクション名(認証タイプのプラグインの場合のみ使用可能): 入力されたユーザー資格証明の検証を実行するためにプラグインが使用するPL/SQLファンクションの名前を入力します。
ログアウト後ファンクション名(認証タイプのプラグインの場合のみ使用可能): Application Expressがカレント・セッションを終了した後にプラグインがコールするPL/SQLファンクションの名前を入力します。このファンクションを使用して、シングル・サインオン・サーバーなどの他のシステムからログアウトしてください。
|
注意: すべてのコールバック・ファンクション名は、無名PL/SQLコード・ブロックのファンクション、パッケージ内のファンクションまたはデータベース内のスタンドアロン・ファンクションを参照できます。詳細情報と例についてはアイテム・ヘルプを参照してください。 |
「ユーザー・インタフェース」で、このプラグインでアプリケーション・ビルダーがサポートする必要のある表示デバイスを選択します。
サポート対象:
デスクトップ: プラグインがデスクトップに表示される場合、このオプションを選択します。
jQuery Mobileスマートフォン: プラグインがMobileスマートフォンで表示される場合にこのオプションを選択します。
「標準属性」(認可スキームとプロセス・タイプのプラグインでは使用不可)で、次の項目を指定します。
認証スキーム・タイプのプラグインでは、次の属性を指定します。
エラー時に実行停止: 選択された場合、アクションの「エラー時に実行停止」フィールドが使用できます。
動的アクション・タイプのプラグインでは、このプラグインに適用される属性を次のように指定します。
アイテムの場合: 動的アクションでは、影響を受ける要素としてアイテムの選択がサポートされます。
ボタン用: 動的アクションでは、影響を受ける要素としてボタンの選択がサポートされます。
リージョンの場合: 動的アクションでは、影響を受ける要素としてリージョンの選択がサポートされます。
DOMオブジェクトの場合: 動的アクションでは、影響を受ける要素としてDOMオブジェクトの選択がサポートされます。
jQueryセレクタの場合: 動的アクションでは、影響を受ける要素としてjQueryセレクタの選択がサポートされます。
トリガー要素: 動的アクションでは、影響を受ける要素としてトリガー要素の選択がサポートされます。
イベント・ソース: 動的アクションでは、影響を受ける要素としてイベント・ソースの選択がサポートされます。
影響を受ける要素が必要です: 動的アクションでは、影響を受ける要素の指定が必要となります。
「ページ・ロード時に実行」を選択: アクションの「ページのロード時に実行」フィールドのデフォルト値を定義します。
エラー時に実行停止属性を指定: アクションの「エラー時に実行停止」フィールドが使用できます。
「結果を待機」属性を指定: アクションに「結果を待機」フィールドを使用できます。
アイテム・タイプのプラグインでは、このプラグインに適用される属性を次のように指定します。
ウィジェットの表示: ウィジェットが表示されます。
セッション・ステート変更可能: アイテムの値をセッション・ステート中に変更できます。「ウィジェットの表示」属性が選択されている必要があります。
読取り専用属性を指定: ユーザーはアイテムの読取り専用条件を指定できます。この属性を有効にするには「ウィジェットの表示」属性が選択されている必要があります。
「特殊文字をエスケープ」属性がある: アイテムの編集時に、アイテムの「セキュリティ」セクションに「特殊文字をエスケープ」フィールドが存在します。「ウィジェットの表示」属性が選択されている必要があります。
クイック選択属性を指定: アイテムにクイック選択属性が存在します。「ウィジェットの表示」属性が選択されている必要があります。
ソース属性を指定: 「使用されるソース」、「ソース・タイプ」、「書式マスク」などのソースに関連した属性がアイテムに表示されます。
日付のみの書式マスク: 日付情報を処理するアイテムについて、「書式マスク」フィールド・ポップアップで選択する日付値を表示することによって日付の選択を制限します。「ソース属性を指定」が選択されている必要があります。
数値のみの書式マスク: 数値情報を処理するアイテムについて、「書式マスク」フィールド・ポップアップで選択する数値を表示することによって数値の選択を制限します。
要素属性を指定: アイテムには、「横/縦の位置合せ」、「HTMLフォームの要素属性」、「要素の前のテキスト」、「要素の後のテキスト」などの要素属性が存在します。
幅属性を指定: アイテムの幅を制御できます。
高さ属性を指定: アイテムの高さを制御できます。
要素オプション属性を指定: チェック・ボックスのラジオ・グループなどの複数の選択要素をレンダリングするときに、アイテムで追加のオプション属性を指定できます。
プレースホルダ属性を指定: アイテムで、要素に表示されるプレースホルダ・テキストの仕様をサポートします。
暗号化セッション・ステート属性を指定: アイテムを編集するとき、「セキュリティ」リージョンの下に「セッション・ステートに暗号化された値を保存」が表示されます。
LOVを指定: アイテムに関連付けられたLOVが存在します。「ウィジェットの表示」属性が選択されている必要があります。
LOVが必須: LOVを処理するアイテムで、LOVを定義する必要があります。「LOVを指定」属性が選択されている必要があります。
LOVのNULL表示属性を指定: アイテムは、null値を含むことが可能なLOVに関連付けられます。「LOVを指定」属性が選択されている必要があります。
カスケードLOV属性を指定: アイテムにカスケードLOV関連の属性が存在します。「LOVを指定」属性が選択されている必要があります。
リージョン・タイプ・プラグインでは、次のオプションを選択して有効化します。
リージョン・ソースはSQL文です: リージョン・ソースはSQL文です。選択すると、問合せによって戻すことができる最小と最大の列数を指定でき、ユーザーを支援するために、SQLの例が表示されます。
リージョン・ソースはプレーン・テキストです: リージョン・ソースはプレーン・テキストです。
リージョン・ソースが必要です: リージョン・ソースがSQL文の場合は、この属性が必須の値になります。
「送信するページ・アイテム」属性がある: リージョン・ソースがSQL文の場合、この属性により、そのリージョンに対してAJAXコールを実行する際にセッション・ステート内に設定する必要があるそれらのページ・アイテムを指定できます。
「フェッチされた行数」属性を指定: リージョンの編集時に、リージョンの「詳細」セクションに「フェッチされた行数」フィールドがあります。
「データが見つからなかった場合のメッセージ」属性を指定: リージョンの編集時に、リージョンの「詳細」セクションに「データが見つからなかった場合のメッセージ」フィールドがあります。
「特殊文字をエスケープ」属性がある: リージョンの編集時に、リージョンの「セキュリティ」セクションに「特殊文字をエスケープ」フィールドが存在します。
「情報」で、次の項目を指定します。
バージョン: プラグインのバージョンを識別する文字列を入力します。
URL情報: プラグイン作成者のホームページのURL、またはプラグインに関する追加情報のURLです。
「ヘルプ・テキスト」に、ユーザーがプラグインの機能を理解するのに使用するヘルプ・テキストを入力します。
「コメント」に、アプリケーションが実行されているときに表示されないコメントおよび注意を入力します。
各オプションの詳細は、アイテムのヘルプを参照してください。
「作成」をクリックします。
プラグインが作成されたら、追加のカスタム属性の指定、プラグインと関連付けるイメージ、CSSおよびJavaScriptファイルなどのファイルのアップロードおよびイベントの追加を実行できます。「プラグインへのカスタム属性の追加」、「プラグインと関連付けるファイルのアップロード」および「プラグインへのイベントの追加」を参照してください。
プラグイン属性は、プラグインが使用されるとき、開発者に追加データの入力を求めるプロンプトをアプリケーション・ビルダー内で表示するために使用します。
|
ヒント: 次のステップの実行中、特定のフィールドに関する詳細を見るには、アイテム・ヘルプを参照してください。 |
プラグインにカスタム属性を追加するには、次の手順を実行します。
プラグイン・ページにナビゲートします。「プラグインへのアクセス」を参照してください。
変更するプラグインをクリックします。
プラグインの作成/編集ページが表示されます。
「カスタム属性」で、属性値の置換を有効化または無効化します。
代替属性値: 開発者が指定するカスタム属性値には、&P1_DNAMEなどの置換構文で参照されるアイテムが含まれる場合があります。
「はい」に設定すると、Application Expressにより自動的に置換構文が実際の値で置き換えられます。
「いいえ」に設定すると、p_plugin、p_item、p_regionなどのattribute_01からattribute_15までのレコード・タイプ属性に置換構文が変更されずに書き込まれます。プラグインの開発者は、これらの置換構文の参照をapex_plugin_util.replace_substitutionsのコールで置換するか、同様の置換を行う必要があります。詳細は、アイテム・ヘルプを参照してください。
「カスタム属性」で、「属性の追加」をクリックします。
属性の編集ページが表示されます。
「名前」で、次の項目を指定します。
有効範囲: 属性がアプリケーションについて1回のみ定義される場合は「アプリケーション」を選択します。プラグインがコンポーネント内で参照されるたびに属性が定義される場合は「コンポーネント」を選択します。
属性: ATTRBUTE_XX列に関連付けられ、APEX_PLUGINパッケージに定義されたPL/SQLタイプと関連する順序を入力します。
表示順序: アプリケーション・ビルダー内でのこのプラグイン属性の表示順序を入力します。
ラベル: アプリケーション・ビルダー内でのこの属性に表示されるラベルを入力します。
「設定」で、次の項目を指定します。
タイプ: 属性タイプを選択します。
必須: この属性を指定する必要がある場合は、「はい」を選択します。そうでない場合は、「いいえ」を選択します。
翻訳可能: この属性を翻訳ファイルに含める場合は「はい」を選択します。それ以外の場合は、「いいえ」を選択します。
表示幅: アプリケーション・ビルダー内でこの属性に表示する長さを文字数で入力します。
最大幅: アプリケーション・ビルダー内でこの属性に対してユーザーが入力できる最大の文字数を入力します。
「デフォルト値」で、このプラグインを使用する新しいコンポーネントが作成されるときにこのプラグイン属性について使用する値を指定します。Yes/Noタイプの属性ではYとNを使用します。
「条件」で、次の項目を指定します。
依存先: 現在の属性が依存する属性を選択します。
条件タイプ(依存属性の場合のみ表示): この属性がレンダリングされるために満たされる必要がある条件のタイプを選択します。
式(条件タイプで必要な場合のみ表示): 選択された条件タイプを満たす必要がある式を入力します。詳細は、アイテム・ヘルプを参照してください。
「ヘルプ・テキスト」で、アプリケーション・ビルダー内でこの属性の状況依存ヘルプとして表示されるヘルプ・テキストを指定します。
「コメント」に、アプリケーションが実行されているときに表示されないコメントまたは注意を入力します。
属性を作成して編集ページに戻るために「作成」をクリックするか、属性を作成して別の属性の作成を続行するために「作成後、さらに作成」をクリックします。
|
注意: 「作成」または「作成後、さらに作成」をクリックするとき、右側のパネルの「プラグイン」の下の「ページに戻る」チェック・ボックスが選択されていると、同じ属性の編集ページが表示されます。 |
プラグインに関連付けるイメージ、CSSおよびJavaScriptファイルをアップロードします。アップロードする別のファイルを参照するには、アップロードするCSSファイルおよびJavaScriptファイル内で#PLUGIN_PREFIX#を使用します。詳細は、新規ファイルのアップロード・ページの右側の「プラグイン・ファイル」リージョンを参照してください。
たとえばCSSファイルでは、参照は次のようになります。
.sidebar{
background-image:url(#PLUGIN_PREFIX#flowers.png);
}
ファイルをアップロードする手順は、次のとおりです。
プラグイン・ページにナビゲートします。「プラグインへのアクセス」を参照してください。
アップロード先のプラグインをクリックします。
プラグインの作成/編集ページが表示されます。
「ファイル」をクリックします。
「ファイル」オプションが表示されます。
ファイルの接頭辞: データベースのプラグイン定義とともに格納されたファイルを参照するには、デフォルトの#PLUGIN_PREFIX#を使用します。この接頭辞は、Webサーバーがプラグインのファイルを指定する場合に使用する仮想パスを特定します。パフォーマンスを向上するために、プラグイン・ファイルをWebサーバーに格納し、#IMAGE_PREFIX#または任意の有効なURLを使用してプラグイン・ファイルを参照することもできます。
「新規ファイルのアップロード」をクリックします。
新規ファイルのアップロード・ページが表示されます。
「ファイル」で、アップロードするファイルを参照して選択します。
「アップロード」をクリックします。
作成/編集ページが表示されます。アップロード対象ファイルの名前が「ファイル」の下に表示されます。
「変更の適用」をクリックします。
アイテム、リージョンまたは動的アクション・タイプのプラグインにイベントを追加すると、イベントを動的アクションに公開できます。たとえば、Start Slide、Sliding、Stop Slideなどのイベントを公開するSliderプラグインによって、これらのイベントが発生したときに応答できる動的アクションを作成できます。
プラグインにイベントを追加するには、次の手順を実行します。
プラグイン・ページにナビゲートします。「プラグインへのアクセス」を参照してください。
編集するプラグインをクリックします。
プラグインの作成/編集ページが表示されます。
「イベント」までスクロールし、「イベントの追加」をクリックします。
「イベント」の下に新しい行が表示されます。
「イベント」で、次のように指定します。
名前: 動的アクション内でプラグイン・イベントが表示される表示名(例: Start Slide)。
内部名: 動的アクションをトリガーする割り当てられたJavaScriptイベントの名前。例: slidestart。
「イベントの追加」をクリックします。
手順3から4を繰り返して、別のイベントを追加します。
「変更の適用」をクリックします。
プラグインは使用中でなければ削除できます。プラグインを使用中の場合、「削除」ボタンは表示されません。
プラグインを削除するには、次のようにします。
プラグイン・ページにナビゲートします。「プラグインへのアクセス」を参照してください。
削除するプラグインをクリックします。
プラグインの作成/編集ページが表示されます。
「削除」をクリックします。
確認して、「OK」をクリックします。
プラグイン・リポジトリの目的は、開発者がプラグインを共有およびダウンロードできる一元的な場所を提供することです。リポジトリはOracle Technology Networkにあります。
プラグイン・リポジトリを表示するには、次の手順を実行します。
プラグイン・ページにナビゲートします。「プラグインへのアクセス」を参照してください。
「プラグイン・リポジトリの表示」をクリックします。
Oracle Application Expressプラグイン・リポジトリが表示されます。
エクスポートされたプラグインをアプリケーションにインポートするにはこのオプションを使用します。プラグインのインポートは、ここで説明するように、プラグイン・ページの「共有コンポーネント」からか、アプリケーション・ビルダーのホームページから実行できます。「プラグインのインポート」を参照してください。
プラグインをインポートするには、次の手順を実行します。
プラグイン・ページにナビゲートします。「プラグインへのアクセス」を参照してください。
「インポート」をクリックします。
プラグインのインポート・ページが表示されます。
「ファイルの指定」で、次の選択を行い、「次へ」をクリックします。
インポート・ファイル: インポート・ファイルの名前を入力または参照します。
ファイル・タイプ: 「プラグイン」を選択します。
ファイルのキャラクタ・セット: インポート・ファイルのキャラクタ・セット・エンコードを選択します。
「ファイルのインポートの確認」で、「次へ」をクリックします。
「インストール」で、「プラグインのインストール」をクリックします。
プラグイン定義をファイルにエクスポートするにはこのオプションを使用します。このファイルは任意のAPEXアプリケーションにインポートできます。プラグインのエクスポートは、ここで説明するように、プラグイン・ページの「共有コンポーネント」からか、「ワークスペース」ホームページから実行できます。「プラグインのエクスポート」を参照してください。
プラグイン・ページにナビゲートします。「プラグインへのアクセス」を参照してください。
「タスク」で、「プラグインのエクスポート」をクリックします。
プラグインのエクスポート・ページが表示されます。
「アプリケーション」で、プラグインのエクスポート元のアプリケーションを選択します。
「アプリケーションの設定」をクリックします。
「プラグインのエクスポート」で、次の項目を指定します。
プラグイン: プラグインを選択します。
ファイル形式: プラグイン・エクスポートのファイル形式を選択します。
「プラグインのエクスポート」をクリックします。
「ファイルを保存」を選択して、「OK」をクリックします。
ダウンロード完了メッセージが表示されます。
プラグインの対話モード・レポートをリセットして、現在レポートに適用されているすべてのフィルタをクリアします。
対話モード・レポートをリセットするには、次の手順を実行します。
プラグイン・ページにナビゲートします。「プラグインへのアクセス」を参照してください。
「リセット」をクリックします。
|
関連項目: |
プラグインの使用状況ページには、各プラグインを使用するページ、コンポーネントおよびリージョンが表示されます。
プラグインの使用状況を表示するには、次の手順を実行します。
プラグイン・ページにナビゲートします。「プラグインへのアクセス」を参照してください。
「使用状況」をクリックします。
使用状況ページが表示されます。
プラグイン履歴ページには、各プラグインで実行されたアクション、アクションを実行した開発者および各アクションの日付が表示されます。
プラグインの履歴を表示するには、次の手順を実行します。
プラグイン・ページにナビゲートします。「プラグインへのアクセス」を参照してください。
「履歴」をクリックします。
履歴ページが表示されます。
