開発ツールのスタート・ガイド

開発ツールについて

ADFデスクトップ統合には、Fusion Webアプリケーションと統合できるようにExcelワークブックを構成するためのツールがいくつかあります。

これらのツールを使用して、ワークブックおよび対応するワークシートを、統合ExcelワークブックでFusion Webアプリケーションからのデータを表示および編集するように構成します。ツールは「Oracle ADF」タブおよびADFデスクトップ統合デザイナの作業ウィンドウで使用できます。

ADFデスクトップ統合の開発ツールには、次のツールが含まれます。図5-1はこれらを示します。

バインディング・パレット
コンポーネント・パレット
プロパティ・インスペクタ
バインディングIDピッカー
式ビルダー
Webページ・ピッカー
ファイル・システム・フォルダ・ピッカー
ページ定義ピッカー
コレクション・エディタ

図5-1 ADFデスクトップ統合の開発ツール

「図5-1 ADFデスクトップ統合の開発ツール」の説明

ADFデスクトップ統合には設計モードとテスト・モードの2つのモードがあり、Excelワークブックを構成する際に使用できます。

設計モードでは、Oracle ADFで提供されるツールをExcelで使用して、統合Excelワークブックを設計および構成します。テスト・モードでは、エンド・ユーザーが公開された統合Excelワークブックで見るのと同じようにして、設計モードで行う変更を表示およびテストできます。

ADFデスクトップ統合開発ツールのユース・ケースと例

開発ツールを使用して、統合Excelワークブックを構成および設計します。たとえば、図5-2に示すように、EditCustomers-DT.xlsxでは、バインディング・パレットからCustomersバインディングを使用して、ADF表コンポーネントが統合Excelワークブックに挿入されます。

図5-2 ADFデスクトップ統合のコンポーネントとバインディング

ADF入力テキスト、ADF入力日、ADFラベルなど他のADFデスクトップ統合コンポーネントは、コンポーネント・パレットから挿入して、プロパティ・インスペクタと式ビルダーを使用して構成できます。

ADFデスクトップ統合開発ツールの追加機能

必要なコンポーネントを追加してワークブックを構成した後で、ワークブックの外観の変更やローカライズなど、追加の機能が必要となることがあります。次の各項では、使用可能なその他の機能について説明します。

対話性: Fusion Webアプリケーションと統合するために、1つ以上のアクション・セットを統合Excelワークブックに追加します。「統合Excelワークブックへの対話性の追加」を参照してください。
ローカライズ: Fusion Webアプリケーションでの国際化およびローカライズの処理の一部として、統合Excelワークブックをカスタマイズできます。「統合Excelワークブックの国際化」を参照してください。
スタイル: 事前定義済のExcelのスタイルをいくつか使用して、コンポーネントの表示を構成できます。「スタイルの使用」を参照してください。
EL式: EL式をADFデスクトップ統合コンポーネントとともに使用できます。「ADFデスクトップ統合のEL式」を参照してください。

デザイナ・リボン・タブ

統合ワークブックやワークシート・プロパティの構成、Oracle ADFコンポーネントの挿入およびそのプロパティの編集、テスト・モードでのワークブックの実行、ワークブックの公開など、様々なタスクで「Oracle ADF」タブ(デザイナ・リボン・タブとも呼ばれます)を使用します。

「Oracle ADF」タブ(図5-3)には、設計モードで様々なボタンが用意されています。

図5-3 設計モードの「Oracle ADF」タブ

「図5-3 設計モードの「Oracle ADF」タブ」の説明

ヒント:

[Alt]を押しながら[C]を押して、「Oracle ADF」タブにアクセスし、キーボードから「Oracle ADF」タブのリボン・コマンドのショートカット・キーを表示します。

「Oracle ADF」タブのボタンを使用して、表5-1に示すアクションを起動できます。

表5-1 「Oracle ADF」タブのオプション

グループ	目的	ボタンが使用可能なモード
ワークブック	「ワークブック・プロパティの編集」ダイアログを表示して、統合Excelワークブックのプロパティを閲覧および編集します。このボタンは、ADFデスクトップ統合を統合Excel以外のワークブックで有効にするときにも使用します。	設計
ワークブック	「ワークシート・プロパティの編集」ダイアログを表示して、現在のワークシートのプロパティを閲覧および編集します。	設計
ワークブック	統合Excelワークブックのバージョンとプロパティ情報を提供する、「ADFデスクトップ統合について」ダイアログを開きます。ダイアログでは、「ADFデスクトップ統合診断レポートの生成」で説明されている診断レポートにもアクセスできます。このボタンは、ADFデスクトップ統合のインストール後は統合Excel以外のワークブックでも使用可能です。	設計、テスト
ワークブック	「ワークブック定義に名前を付けて保存」ダイアログを開き、現在のワークブック定義を`.xml`ファイルとしてエクスポートします。	設計
ワークブック	「インポートするワークブック定義ファイルの選択」ダイアログを開き、保存された`.xml`ファイルからワークブック統合メタデータをインポートします。	設計
ADFコンポーネント	選択したセルに挿入可能なOracle ADFコンポーネントのドロップダウン・リストを表示します。	設計
ADFコンポーネント	選択したコンポーネントのコンポーネント・プロパティを閲覧および編集する「プロパティ・インスペクタ」ウィンドウを表示します。	設計
ADFコンポーネント	選択したコンポーネントをExcelワークシートから削除します。	設計
ADFコンポーネント	統合Excelワークブックのワークブック・プロパティが参照するアプリケーション・ワークスペース・ファイル(`.jws`)およびプロジェクト・ファイル(`.jpr`)をリロードします。アクティブな統合Excelワークブックで使用されるページ定義ファイルからすべての情報をリフレッシュします。 JDeveloperプロジェクトのページ定義ファイルに加えたすべての変更が、Excelワークブックで使用可能になります。「Excelワークブックへのページ定義ファイルのリロード方法」を参照してください。	設計
テスト	Excelワークブックの構成をADFデスクトップ統合の検証ルールに対して検証します。ワークブックの検証の詳細は、「統合Excelワークブックの構成の検証」を参照してください。	設計
テスト	Excelワークブックを設計モードからテスト・モードに切り替えます。このボタンは、設計モードの場合のみアクティブになります。	設計
テスト	Excelワークブックをテスト・モードから設計モードに切り替えます。このボタンは、テスト・モードの場合のみアクティブになります。設計モードとテスト・モードの切替えの詳細は、「統合Excelワークブックのテスト」を参照してください。	テスト
ロギング	クライアント・サイドの最新のログ・エントリを表示するウィンドウを表示します。「クライアント・サイド・ロギングの概要」を参照してください。	設計、テスト
ロギング	クライアント・サイド・ログ出力レベルを選択する出力レベルの設定ダイアログを表示します。「クライアント・サイド・ロギングの概要」を参照してください。	設計、テスト
ロギング	クライアント・サイド・ログ出力ファイルとして機能する新しい一時ロギング・リスナーを作成します。「クライアント・サイド・ロギングの概要」を参照してください。	設計、テスト
ロギング	ADFデスクトップ統合の構成ファイルをリロードします。「クライアント・サイド・ロギングの概要」を参照してください。	設計、テスト
公開	ExcelワークブックとFusion Webアプリケーションの統合を完了した後に、Excelワークブックを公開します。統合されたExcelワークブックの公開の詳細は、「統合Excelワークブックのデプロイ」を参照してください。	設計

ヒント:

すばやく簡単にアクセスするには、Excelのクイック・アクセス・ツールバーに「Oracle ADF」タブ・ボタンを追加できます。

ADFデスクトップ統合デザイナの作業ウィンドウ

ADFデスクトップ統合デザイナの作業ウィンドウでは、開発ツールがバインディング・パレットとコンポーネント・パレットの2つのパレットにまとめられています。

ADFデスクトップ統合デザイナの作業ウィンドウのバインディング・パレットを使用して、事前定義済のバインディングを統合Excelワークブックに挿入します。ADFデスクトップ統合は、選択したバインディングを参照するOracle ADFコンポーネントを挿入し、Oracle ADFコンポーネントのプロパティに適切な値を移入します。同様に、コンポーネント・パレットを使用して、Oracle ADFコンポーネントを統合Excelワークブックに挿入します。図5-4に、ADFデスクトップ統合デザイナの作業ウィンドウを示します。

図5-4 ADFデスクトップ統合デザイナの作業ウィンドウ

「図5-4 ADFデスクトップ統合デザイナの作業ウィンドウ」の説明

ADFデスクトップ統合デザイナの作業ウィンドウは、「Oracle ADF」タブのワークブックおよびADFコンポーネント・グループの右下にあるランチャ・ボタン(図5-5では赤線の枠で強調表示されている)から表示または非表示にできます。

図5-5 ADFデスクトップ統合デザイナの作業ウィンドウのランチャ・ボタン

「図5-5 ADFデスクトップ統合デザイナの作業ウィンドウのランチャ・ボタン」の説明

表5-2は、作業ウィンドウに表示されるビュー・タブおよびリンクの一覧と各項目の簡単な説明です。

表5-2 ADFデスクトップ統合デザイナの作業ウィンドウの概要

作業ウィンドウのUI要素	説明
ワークブック・プロパティ	クリックすると、「ワークブック・プロパティの編集」ダイアログが表示されます。このダイアログでは、ワークブック全体に影響するプロパティを表示、編集できます。たとえば、ページ定義ファイルへのディレクトリ・パスを参照するプロパティ、Fusion WebアプリケーションのURLなどがあります。
ワークシート・プロパティ	クリックすると、「ワークシート・プロパティの編集」ダイアログが表示されます。このダイアログでは、アクティブなワークシートに固有のプロパティを表示、編集できます。たとえば、ワークシートに関連付けるページ定義ファイルのファイル名などです。
概要	クリックすると、「情報」ダイアログが表示されます。このダイアログは、統合Excelワークブックのトラブルシューティングで役に立ちそうなバージョンやプロパティの情報を提供します。たとえば、統合ExcelワークブックをサポートするMicrosoft .NETおよびOracle ADFフレームワークの基底にある情報などです。ダイアログでは、「ADFデスクトップ統合診断レポートの生成」で説明されている診断レポートにもアクセスできます。ログインに成功すると、サーバーの現在のクライアント・インストーラにもアクセスできます。

バインディング・パレットの使用

バインディング・パレットには、Excelワークシートに挿入できるOracle ADFバインディングが表示されます。

現在のExcelワークシートのページ定義ファイルによって、バインディング・パレットに表示されるOracle ADFバインディングが決まります。図5-6に、Oracle ADFバインディングが移入された、ADFデスクトップ統合デザイナの作業ウィンドウのバインディング・パレットを示します。バインディング・パレットには統合Excelワークブックで使用できないバインディングは表示されないため、ここに表示されるバインディングは、JDeveloperに表示されるページ定義ファイル内のバインディングとは異なることがあります。無視されたバインディングのログを確認します(「統合Excelワークブックのログ・ファイルの生成」を参照)。

図5-6 ADFデスクトップ統合デザイナの作業ウィンドウのOracle ADFバインディング・パレット

バインディングを挿入するには、設計モードでバインディング・パレットを使用します。バインディングを挿入しようとする際、ADFデスクトップ統合により、選択したバインディングに適切なOracle ADFコンポーネントを選択および挿入するように求められます。また、ADFデスクトップ統合もOracle ADFコンポーネントのプロパティに適切な値を移入します。たとえば、図5-6に示すようにCustomers (tree)のようなバインディングを挿入する場合、「コンポーネントの選択」ダイアログが表示され、ADF表コンポーネントを選択および挿入できます。

Oracle ADFバインディングを挿入するには、Excelワークシート内のバインディングを参照する、Oracle ADFコンポーネントを配置するセルを選択し、次のいずれかの方法でバインディングを挿入します。

挿入するOracle ADFコントロール・バインディングをダブルクリックします。
挿入するバインディングを選択し、それを目的のセルにドラッグします。
コントロール・バインディングを選択して、ADFデスクトップ統合デザイナの作業ウィンドウで「バインディングの挿入」をクリックします。

「コンポーネントの選択」ダイアログが表示され、複数のOracle ADFコンポーネントをバインディングと関連付けることが可能なOracle ADFコンポーネントのリストから、Oracle ADFコンポーネントを1つ選択するよう求められます。リストからOracle ADFコンポーネントを1つ選択すると、プロパティ・インスペクタが表示されます

ADF入力テキスト、ADF出力テキストまたはADFラベルなどのOracle ADFコンポーネントを選択すると、バインディング名がValueプロパティに割り当てられます。ADFリボン・コマンドなどのOracle ADFコンポーネントを選択すると、バインディング名がLabelプロパティに割り当てられます。ADF表またはADF読取り専用表などのOracle ADFコンポーネントを選択すると、バインディング名がTreeIDプロパティに割り当てられます。

コンポーネント・パレットの使用

コンポーネント・パレットには、Excelワークシートに挿入できるADFデスクトップ統合コンポーネントが表示されます。

図5-7に、ADFデスクトップ統合デザイナの作業ウィンドウで表示されるコンポーネント・パレットを示します。

図5-7 ADFデスクトップ統合デザイナの作業ウィンドウのOracle ADFコンポーネント・パレット

「図5-7 ADFデスクトップ統合デザイナの作業ウィンドウのOracle ADFコンポーネント・パレット」の説明

Oracle ADFコンポーネントを挿入するには、設計モードでコンポーネント・パレットを使用します。まず、Excelワークシート内でOracle ADFコンポーネントを配置するセルを選択し、次のいずれかの方法でOracle ADFコンポーネントを挿入します。

挿入するOracle ADFコンポーネントをダブルクリックします。
挿入するコンポーネントを選択し、それを目的のセルにドラッグします。
コンポーネントを選択して、ADFデスクトップ統合デザイナの作業ウィンドウで「コンポーネントの挿入」をクリックします。

前述のすべての場合で、Oracle ADFコンポーネントのプロパティ・インスペクタが表示されます。プロパティ・インスペクタを使用して、Excelワークシートへの挿入を完了する前にコンポーネントに値を指定します。

注意:

ADFデスクトップ統合コンポーネントは、「Oracle ADF」タブの「コンポーネントの挿入」ドロップダウン・リストからも使用できます。

プロパティ・インスペクタの使用

プロパティ・インスペクタは、Oracle ADFコンポーネント、ExcelワークシートまたはExcelワークブックのプロパティを表示および編集できるダイアログです。

プロパティ・インスペクタは次のいずれかの方法で開くことができます。

コンポーネントまたはバインディングを選択し、「Oracle ADF」タブで「プロパティの編集」アイコンをクリックします。
コンポーネントまたはバインディングを選択し、右クリックして「ADFコンポーネント・プロパティの編集」を選択します。
コンポーネントまたはバインディングをダブルクリックします。

ADF表またはADF読取り専用表の適切なインスペクタを開くには、表の部分の任意のセルをダブルクリックします。

ExcelワークシートにOracle ADFバインディングまたはコンポーネントを挿入した後にも、プロパティ・インスペクタが自動的に表示されます。図5-8に、ADFラベル・コンポーネントのプロパティを表示および編集できるプロパティ・インスペクタを示します。

設計時には、コンポーネントが表示されるExcelのセルを編集することにより、特定のOracle ADFコンポーネントの主要なプロパティを編集できます。たとえば、ADF LabelコンポーネントおよびADF Input TextコンポーネントのValueプロパティの編集は、セルに表示された値を編集すれば実行できます。

注意:

プロパティ・インスペクタは、プロパティまたはプロパティの組合せに入力した値の検証は実行しません。無効な値があると、実行時にエラーが発生します。実行時のエラーを回避するには、プロパティ・インスペクタでプロパティに有効な値を指定してください。

プロパティは、アルファベット順、またはカテゴリ(動作、データなど)別にグループ化されたリストで表示できます。表5-3は、プロパティ・インスペクタでのプロパティの表示を変更するときに使用可能なボタンを示します。

表5-3 プロパティ・インスペクタでのプロパティ表示を構成するボタン

ボタン	説明
	このボタンを使用すると、プロパティがカテゴリに応じて表示されます。
	このボタンを使用すると、プロパティがアルファベット順に表示されます。

図5-8のプロパティ・インスペクタには、カテゴリ別にグループ化されたプロパティが表示されています。

図5-8 ADFラベル・コンポーネントのプロパティ・インスペクタ・ウィンドウ

バインディングIDピッカーの使用

バインディングIDピッカーは、実行時のOracle ADFコンポーネントの動作を構成するために、設計時にOracle ADFバインディングを選択できるダイアログです。

バインディングIDピッカーは、「プロパティ・インスペクタ」から起動します。また、バインディングIDピッカーはOracle ADFコンポーネントのプロパティが受け入れるバインディングのタイプに基づいて、表示されるOracle ADFバインディングをフィルタ処理します。たとえば、ADF値リスト・コンポーネントのListIDプロパティは、リスト・バインディングをサポートします。したがって、図5-9に示すように、バインディングIDピッカーは、ページ定義ファイルのバインディングをフィルタ処理して、リスト・バインディングのみが表示されるようにします。

図5-9 バインディングIDピッカー

「図5-9 バインディングIDピッカー」の説明

ADFデスクトップ統合コンポーネントのプロパティ、およびそれらがサポートするバインディングの詳細は、「ADFデスクトップ統合コンポーネントのプロパティとアクション」を参照してください。

式ビルダーの使用

式ビルダーを使用して、Excelワークブックでの実行時のコンポーネントの動作を構成する式言語(EL)または式を記述します。

式ビルダーは、EL式をサポートするコンポーネント・プロパティのプロパティ・インスペクタから起動します。たとえば、図5-10のプロパティLabelはEL式をサポートするため、このプロパティの値を設定する式ビルダーを起動できます。

記述するEL式内のバインディングを参照できます。式ビルダーではバインディングのフィルタ処理は行われません。ページ定義ファイルが公開するすべてのバインディングが表示されます。それぞれのADFデスクトップ統合コンポーネントがサポートするバインディングのタイプの詳細は、表4-1を参照してください。

「式」ボックスに式を追加するには、項目を選択して「式に挿入」をクリックします。また、項目をダブルクリックして、「式」ボックスに追加することもできます。表5-4は、式ビルダーで使用可能なフォルダを示します。

図5-10 式ビルダー

「図5-10 式ビルダー」の説明

表5-4 式ビルダーのフォルダ

フォルダ名	説明
バインディング	現在のワークシートのページ定義からADFデスクトップ統合でサポートされるバインディングの一覧を表示します。
コンポーネント	現在のワークシートで使用可能なADFコンポーネントを一覧表示します。
リソース	`Workbook.Resources`で登録されたリソース・バンドル、ならびに内蔵のリソース・バンドル`_ADFDIres.`を一覧表示します。
スタイル	現在のワークブックに定義されたすべてのExcelのスタイルを一覧表示します。「スタイルの使用」を参照してください。
ワークブック	`Workbook.Parameters`で定義されているパラメータを一覧表示します。
ワークシート	`errors`式を一覧表示します。
Excel関数	ADFデスクトップ統合で使用可能なサンプルのExcel関数を一覧表示します。Excelのドキュメントを参照してください。

式ビルダーの使用の詳細は、「EL式を使用した動的なスタイルの適用」を参照してください。ADFデスクトップ統合のEL式の構文と、これらの式を記述するガイドラインの詳細は、「ADFデスクトップ統合のEL式」を参照してください。

Webページ・ピッカーの使用

Webページ・ピッカーを使用して、Fusion WebアプリケーションからWebページを選択します。実行時にOracle ADFコンポーネント(リボン・コマンドなど)によって、そのOracle ADFコンポーネントに関連付けられているWebページを起動できます。

Webページ・ピッカーは、アクション・コレクタ・エディタで設定されたアクションにDialogアクションを追加するときに起動できます。図5-11に示すように、Webページ・ピッカーを使用して、DialogアクションのPageプロパティにWebページを指定します。

図5-11 Webページ・ピッカーのダイアログ

「図5-11 Webページ・ピッカーのダイアログ」の説明

統合ExcelワークブックでのWebページの表示の詳細は、「Fusion WebアプリケーションからのWebページの表示」を参照してください。

ファイル・システム・フォルダ・ピッカーの使用

ファイル・システム・フォルダ・ピッカーを使用して、Windowsファイル・システム内を移動し、フォルダを選択できます。

このピッカーを使用して、次のワークブックのプロパティの値を指定します。

ApplicationHomeFolder
WebPagesFolder

初めてExcelワークブックを開くときにピッカーが表示され、前述のプロパティの値を設定できます。初めてExcelワークブックを開くときに設定するプロパティの詳細は、「新しい統合Excelワークブックの構成方法」を参照してください。

図5-12に、ワークブックのプロパティWebPagesFolderの値を選択するファイル・システム・フォルダ・ピッカーを示します。

図5-12 ファイル・システム・フォルダ・ピッカー

ページ定義ピッカーの使用

ページ定義ピッカーを使用して、ページ定義ファイルのページ定義IDを選択し、ファイルをワークシートに関連付けます。

ピッカーは、統合Excelワークブックで統合されていないワークシートを初めて有効にしたときに表示されます。また、図5-13に示すように、ワークシートのプロパティPageDefinitionの値を設定する際にも起動できます。

図5-13 ページ定義ピッカー

ページ定義ファイルの詳細は、「統合Excelワークブックのページ定義ファイルの使用」を参照してください。

コレクション・エディタの使用

ADFデスクトップ統合では、コレクション・エディタを使用してコレクション内の要素のプロパティを管理します。

コレクション・エディタのタイトル・バーに表示されるタイトルは、コレクション・エディタにより構成可能な対象を示します。コレクション・エディタのタイトルの例としては、CachedAttributesの編集、列の編集、アクションの編集などがあります。これらのコレクション・エディタを使用して、キャッシュされたデータ、ADF表コンポーネントの表列、アクション・セットのアクションのコレクションを構成できます。図5-14は、コレクション・エディタを示しています。

図5-14 コレクション・エディタ

「図5-14 コレクション・エディタ」の説明

ヒント:

アクションの編集ダイアログに追加する各要素の「注釈」フィールドで、説明を記述してください。記述する説明は「メンバー」リスト・ビューに表示されます。記述する説明によっては、ADFデスクトップ統合が生成するデフォルトのエントリよりも意味をなす場合があります。

セルのコンテキスト・メニューの使用

ADFデスクトップ統合には、統合ExcelワークブックでADFコンポーネントを編集できるセル・コンテキスト・メニューが用意されています。

設計時にADFコンポーネントを使用する際、コンポーネントのいずれかのセルを右クリックすると、コンポーネントを編集または削除するメニュー・オプションを表示できます。一部のキーボードには、コンテキスト・メニューを起動するキーがあります。このキーを使用しても、編集および削除のメニュー・オプションが表示されます。図5-15は、ADF表コンポーネントのコンテキスト・メニュー・オプション(「編集」および「削除」)を示しています。

図5-15 ADF表コンポーネントのコンテキスト・メニュー・オプション

ADFデスクトップ統合コンポーネントの削除

設計時に、「削除」リボン・コマンド、または「ADFコンポーネントの削除」コンテキスト・メニュー・オプションを使用して、挿入したADFデスクトップ統合コンポーネント(またはバインディング)を統合ワークブックから削除できます。

コンポーネントを削除する場合、図5-16に示すように、ADFデスクトップ統合では、アクションを確認するよう求められます。「ADFコンポーネントの削除」コンテキスト・メニュー・オプションについては、図5-15を参照してください。

図5-16 ADFデスクトップ統合コンポーネントの削除

コンポーネントのアンカーとなるセルの範囲を選択(図5-17参照)、または[Ctrl]キーを使用して個別のコンポーネントのセルを選択し、「削除」リボン・ボタンをクリックすることにより、複数のコンポーネントを削除することもできます。

図5-17 複数のADFデスクトップ統合コンポーネントの削除

コンポーネントの削除時には、次のことに注意してください。

複数のセルがあるコンポーネント(表コンポーネントまたはマージされたセルのコンポーネントなど)を削除するには、コンポーネント全体を選択する必要はありません。選択した範囲がコンポーネントのセルと交差すれば削除されます。
選択した中に1つまたは複数のADFデスクトップ統合コンポーネントが含まれている場合、ワークブックのセルを削除またはクリアできません。必ず「削除」リボン・コマンドを使用してADFデスクトップ統合コンポーネントを削除します。
ADFコンポーネントを含むセルに隣接するセルを削除し、削除したセルの位置にこのセルをシフトすると、ADFデスクトップ統合はADFコンポーネントを削除するよう提案します。
ADFデスクトップ統合のコンテキスト・メニュー・オプションは、コンテキスト・メニューが起動されたときに複数のセルが選択されている場合には使用できません。
ADFデスクトップ統合コンポーネントを削除したら、削除したコンポーネントへの参照を見つけるために、統合Excelワークブック構成を検証するようにしてください。ワークブックの検証の詳細は、「統合Excelワークブックの構成の検証」を参照してください。

Excelワークブック統合メタデータのエクスポートおよびインポート

ワークブック定義として知られるワークブック統合メタデータは、指定のワークブックを特定のFusion Webアプリケーションに統合する方法を示す一連の情報です。

コンポーネントの配置と構成、およびワークブック・レベルとワークシート・レベルのプロパティが含まれています。ワークブック統合メタデータは、Oracle ADFによって定義されます。Excelに元からあるワークブックの設定は含まれません。

Excelワークブック統合メタデータを、指定した名前と場所のXMLファイルにエクスポートできます。XMLファイルには、ワークブックの各ワークシートの子要素、リモート・サーブレットの相対パスのようなリソースなどが含まれます。エクスポートされたXMLファイルを使用すると、次のアクションを実行できます。

Excelワークブック統合メタデータを編集または分析します。たとえば、xmlファイルを検索してカスタム・ポリシー違反を確認するプログラムを作成する場合などがあります。
XMLエディタを使用した、ワークシートとワークブックの間のコンポーネントのコピーまたは移動。
ボタン間またはイベント間のアクション・セット定義のコピー。
グローバルな検索および置換操作の実行。
表コンポーネントの列の素早い再配置またはコピー。

ワークブック統合メタデータのエクスポート方法

次の手順では、統合ExcelワークブックからXML構成メタデータをエクスポートする方法を説明します。

始める前に:

ワークブック統合メタデータを理解しておくと役立ちます。「Excelワークブック統合メタデータのエクスポートおよびインポート」を参照してください。

統合Excelワークブックからワークブック統合メタデータをエクスポートするには:

統合Excelワークブックを開きます。
「Oracle ADF」タブで、「エクスポート」をクリックします。

「ワークブック定義に名前を付けて保存」ダイアログ・ボックスが開きます。
エクスポートされたメタデータを格納するXMLファイルの名前と場所を指定し、「保存」をクリックします。ADFデスクトップ統合によって、ワークブック定義が指定されたファイルに書き込まれます。
「ワークブック・メタデータのエクスポート」ダイアログで、「OK」をクリックしてエクスポート・プロセスを完了します。

注意:

エクスポートされたXMLファイルには、名前付きスタイル、名前付き範囲、セル・プロパティ、バインドなしセル内のコンテンツなど、ネイティブなExcel設定は含まれません。ファイル名は、-workbook-defintion.xmlという接尾辞が付いた設計時ワークブックの完全な名前から構成されます。たとえば、EditCustomers-DT.xlsxのエクスポートされたXMLファイル名はEditCustomers-DT.xlsx-workbook-definition.xmlです。

ワークブックの公開によっても、ワークブック定義がエクスポートされます。ワークブックの公開の詳細は、「統合Excelワークブックの公開」を参照してください。

ワークブック定義をエクスポートしたら、JDeveloperなどのXMLエディタでXMLファイルを編集できます。図5-18は、JDeveloperでのEditCustomers-DT.xlsxのワークブック定義を示しています。JDeveloperでワークブック定義ファイルを編集する際、JDeveloperはワークブック定義スキーマと照らしあわせて変更を自動的に検証します。後で問題の回避に役立つ警告も表示します。

図5-18 JDeveloperでのワークブック定義の編集

ワークブック統合メタデータのインポート方法

編集後は、エクスポート元のオリジナルのワークブックまたは空の統合ワークブックにワークブック定義ファイルをインポートして、ソースの統合Excelワークブックのコピーを作成できます。メタデータをインポートする前に、ADFデスクトップ統合で空のワークブックを有効にする必要があります。

次の手順では、統合ExcelワークブックにXML構成メタデータをインポートする方法を説明します。

始める前に:

ワークブック統合メタデータを理解しておくと役立ちます。「Excelワークブック統合メタデータのエクスポートおよびインポート」を参照してください。

XMLファイルから統合メタデータをインポートする前に、XMLコードが適切に形成されているかどうか、XMLファイルにルート要素が含まれているかどうかなど、基本的なXML検証を実行します。ワークブック定義は、ワークブック定義のエクスポート元のワークブックにインポートすることも、新しいワークブックにインポートすることもできます。

統合Excelワークブックにワークブック統合メタデータをインポートするには:

統合Excelワークブックを開きます。
「Oracle ADF」タブで、「インポート」をクリックします。

「インポートするワークブック定義ファイルの選択」ダイアログ・ボックスが表示されます。
ワークブック統合メタデータを格納するXMLファイルを選択し、「開く」をクリックします。
「ワークブック・メタデータのインポート」ダイアログで、「OK」をクリックしてインポート・プロセスを完了します。

ワークブック定義内の変更は、統合Excelワークブックに自動的に表示されます。この方法を使用して、新しい(および個別の)統合Excelワークブックを既存のワークブックから作成する場合は、2つの統合Excelワークブックが同じワークブックIDを共有しないように、インポートの完了後に、ワークブックIDを必ずリセットしてください。「ワークブックIDのリセット方法」を参照してください。

たとえば図5-19は、ワークブック定義ファイルでEdit Customers New Workbookに変更されたワークブックのブランド値を示しています。

図5-19 ワークブック定義内のブランド値の編集

図5-20は、ワークブック定義のインポート後に、「ワークブック・プロパティの編集」ダイアログで変更されたワークブックのブランド値を示しています。

図5-20 「ワークブック・プロパティの編集」ダイアログで更新されたブランド値

Excelワークブック統合メタデータのエクスポートおよびインポートに関する必知事項

ワークブック統合メタデータのXMLファイルでは、adfdi-workbook-definition.xsd XMLスキーマ・ドキュメントが使用されます。このドキュメントでは、XMLネームスペースがhttp://xmlns.oracle.com/adf/desktopintegration/workbookと定義されています。スキーマは、ADFデスクトップ統合アドインによりJDeveloperに統合されます。スキーマのコピーは、<MW_HOME>\jdeveloper\adfdi\etc\adfdi-workbook-definition.xsdにあります。MW_HOMEは、ミドルウェア・ホーム・ディレクトリです。

ワークブック統合メタデータのインポート中は、次の点に注意してください。

インポート・プロセスが開始されると、XMLファイルのスキーマ・バージョン番号(<workbook>のschema-version属性)が、インストールされているADFデスクトップ統合クライアントのスキーマ・バージョン番号と比較されます。

両方の値が一致すると、ワークブック統合メタデータがワークブックにインポートされます。XMLファイルのスキーマ・バージョンがインストールされているクライアントのスキーマ・バージョンより小さい場合は、インストールされているクライアントのスキーマを使用するためにXMLファイルが移行されます。ファイルの移行中はプロンプトは表示されませんが、ログは維持されます。XMLファイルのスキーマ・バージョンがインストールされているクライアントのスキーマ・バージョンより大きい場合は、インポート・プロセスが失敗し、エラー・メッセージが表示されます。
スキーマ・バージョンの検証後に、インストールされているクライアントのスキーマと照らしあわせて、インポートされたXMLファイルが検証されます。検証に失敗すると、検証失敗の詳細情報が記録され、エラーがユーザーに報告され、インポート・プロセスが中止されます。スキーマの検証に成功すると、インポート・プロセスが続行します。
インポートされたXMLファイルに要素がない場合は、統合Excelワークブックで要素のデフォルト値が使用されます。
既存のすべてのワークシートとコンポーネントのメタデータは、インポート前に削除されます。
インポートされたワークシートの名前が統合ワークブック内の既存のワークシートの名前と一致する場合は、そのワークシートが使用されます。それ以外の場合は、新しいワークシートが作成されます。
統合Excelワークブックの統合されていないすべてのワークシートは、インポートによる影響は受けません。
インポートされたコンポーネントに有効な元情報がない場合は、インポート・プロセスは、そのコンポーネントをターゲット統合ワークシート内の最初の未使用行に配置しようとします。
XMLファイルがインポートされたら、統合ExcelワークブックのワークブックIDがXMLファイルのワークブックIDに置換されます。XMLファイルにワークブックIDが存在しない場合は、新しいIDが生成されます。