Oracle® Fusion Middleware Oracle Application Development Frameworkデスクトップ統合開発者ガイド 11gリリース1 (11.1.1.9.0) B66694-04 |
|
前 |
次 |
この付録では、開発中に問題が発生した場合に統合Excelワークブックのトラブルシューティングを行い、ログ・ファイルを生成する方法について説明します。また、発生する可能性のあるいくつかのエラーと問題(バージョンの不一致、404エラー、「Oracle ADF」タブが統合Excelワークブックに表示されないなど)についても説明します。
この付録の内容は次のとおりです。
注意: プロパティ・インスペクタは、プロパティまたはプロパティの組合せに入力した値が有効かどうかの検証は実行しません。無効な値があると、実行時にエラーが発生します。実行時のエラーを回避するには、プロパティ・インスペクタでプロパティに有効な値を指定してください。プロパティ・インスペクタの詳細は、5.6項「プロパティ・インスペクタの使用」を参照してください。 |
サーバーのpingテストを使用して、Fusion WebアプリケーションによってADFデスクトップ統合のリモート・サーブレット(adfdiRemote
)が実行されていることを確認し、ADFデスクトップ統合のバージョンを確認できます。この情報は、統合Excelワークブックに関連するエラーが発生した場合に役立ちます。たとえば、統合Excelワークブックのトラブルシューティングを行う際に、ADFデスクトップ統合のリモート・サーブレットが稼働しているかどうかを判断できます。
認証を実施するFusion Webアプリケーションの場合、サーバーのpingテストを使用して、ADFデスクトップ統合サーブレットURLに対して適切な認証構成が完了していることを確認できます。
ADFデスクトップ検証は、Internet Explorer固有の様々な設定に依存します。このような理由から、Internet Explorerを使用して検証テストを実行してください。
ADFデスクトップ統合のリモート・サーブレットが稼働していることを検証するには:
Webブラウザのアドレス・バーに、ワークブックのプロパティWebAppRoot
およびRemoteServletPath
を連結した値を入力します。これは、次のようなURLに相当します。
http://hostname:7101/FusionApp/adfdiRemoteServlet
ADFデスクトップ統合のリモート・サーブレットが稼働している場合、Webページが元に戻って図C-1のようなメッセージが表示されます。
サポート、トラブルシューティング、および診断中の状況で、エンド・ユーザーにADFデスクトップ統合診断レポートを提供するように求める場合があります。
エンド・ユーザーは、「情報」ダイアログからレポートを生成できます。
ADFデスクトップ統合レポートを生成する手順:
統合Excelワークブックを開きます。
統合Excelワークブックを設計モードで開いた場合は、「Oracle ADF」タブの「ワークブック」グループの「情報」ボタンをクリックします。
統合Excelワークブックを実行時モードで開いた場合は、実行時リボン・タブの「情報」ボタンをクリックします。
「情報」ダイアログの「診断レポート」ボタンをクリックします。
診断レポートのテキスト・ファイルを保存します。デフォルトでは、ファイルは、adfdi-diagnostic-report.txt
としてDesktop
ディレクトリ(例: C:\Users\<USER_NAME>\Desktop
)に保存されます。
保存したファイルの場所を示す「診断レポート」ダイアログが開きます。「OK」をクリックして、デフォルトのテキスト・エディタでファイルを開きます。
診断レポートは、次のような様々な情報を含むテキスト・ファイルです。
ADFデスクトップ統合アドインのバージョン
Microsoft Windowsのバージョン
Microsoft Excelのバージョン
「情報」ダイアログの「バージョン」タブからのすべてのプロパティの値
「情報」ダイアログの「プロパティ」タブにリストされるすべてのプロパティの値
Excel COMアドインのリスト
「情報」からのブランディング項目(レポートが実行時に生成される場合)
ADFデスクトップ統合サーブレットのバージョン(有効なログイン後にレポートが生成される場合)
テキスト・ファイルは、任意のテキスト・エディタまたはExcelで開いて編集できます。ファイルの各行は、タブで区切られたキーと値のペアで構成されます。
エンド・ユーザーが診断ファイルを送信する前に、レポートを見直して、共有したくない機密情報があれば削除するようにエンド・ユーザーに求めます。
統合Excelワークブックのエンド・ユーザーが、ADFセキュリティを使用して構成されているFusion Webアプリケーションと相互作用するアクションを起動する際にユーザー資格証明を要求されない場合、統合ExcelワークブックまたはFusion Webアプリケーションのどちらかでセキュリティが正しく構成されていない可能性があります。次の手順を実行して、セキュアなFusion Webアプリケーションによってエンド・ユーザーが認証されること、およびセキュリティが有効であることを検証できます。
セキュアなFusion Webアプリケーションによってエンド・ユーザーが認証されることを検証するには、ADFデスクトップ統合のリモート・サーブレットが稼働中かどうかを検証するために使用したURLを、ブラウザのアドレス・バーに入力します。詳細は、C.1項「Fusion WebアプリケーションによるADFデスクトップ統合のサポートの検証」を参照してください。Fusion Webアプリケーションのセキュリティが有効である場合は、ユーザー資格証明を入力するよう求められます。
統合Excelワークブックの保護の詳細は、第12章「統合Excelワークブックの保護」を参照してください。
ADFデスクトップ統合では、ログ・ファイルを生成して、次のソフトウェアによってADFデスクトップ統合内でトリガーされるイベントに基づいて情報を取得できます。
Webサーバー上にある、HTTPフィルタおよびADFデスクトップ統合のリモート・サーブレット(サーバー・サイド・ロギング)
サーバー・サイド・ロギングの詳細は、C.4.1項「サーバー・サイド・ロギングの概要」を参照してください。
Fusion Webアプリケーションと統合するExcelワークブック(クライアント・サイド・ロギング)
クライアント・サイド・ロギングの詳細は、C.4.3項「クライアント・サイド・ロギングの概要」を参照してください。
ADFデスクトップ統合のサーバー・サイド・ログ・ファイルの生成は、他のOracle ADFモジュールの場合と同じように構成します。構成するには、logging.xml
という構成ファイルで冗長レベルと出力場所を指定する値を設定する必要があります。また、JDeveloperのOracle Diagnostic Logging構成を使用して、logging.xml
ファイルで指定されるロギング・レベルを構成することもできます。JDeveloperのデバッグ・ツールおよびADFログ出力の使用の詳細は、『Oracle Application Development Framework Fusion開発者ガイド』のADFログ出力の使用に関する項を参照してください。
表C-1に、ADFデスクトップ統合のログ・ファイルの生成を構成するために、logging.xml
ファイルの<logger>
要素に属性パラメータとして指定するパッケージ名を示します。
Oracle Diagnostics Log Analyzerを使用すると、各ADFデスクトップ統合サーブレット・リクエストの実行に費やされた経過時間の階層ブレークダウンを表示できます。階層ブレークダウンには、ADFモデル・レイヤーなどのその他のADFコンポーネントで費やされた時間も含まれます。Log Analyzerを使用してWebリクエストを表示する方法の詳細は、『Oracle Application Development Framework Fusion開発者ガイド』のLog Analyzerを使用してログ・メッセージを表示する方法に関する項を参照してください。
ヒント: 階層ブレークダウンは、異常に長い実行時間によるパフォーマンスのボトルネックを特定する際に役に立ちます。 |
ADFデスクトップ統合イベントなどのADFイベント・メッセージの完全な階層ツリーを記録するために、oracle.adfdiagnostics
パッケージにログ・レベルCONFIG
を指定します。oracle.adfdiagnostics
ロガーの詳細は、『Oracle Application Development Framework Fusion開発者ガイド』のOracle ADFデバッグ構成の作成方法に関する項を参照してください。
ADFデスクトップ統合を構成して、ADFデスクトップ統合アドイン内で発生するアクティビティのログを様々なレベルで詳細に作成できます。デフォルトでは、ログ・ファイルは生成されません。ログを保存するためのADFデスクトップ統合モジュールの構成方法は、C.4.3.1項「ADFデスクトップ統合でログを保存するための構成方法」を参照してください。
ADFデスクトップ統合には、イベント・ログを生成し、ログに簡単にアクセスするためのロギング・ツールが用意されています。このロギング・ツールは、「Oracle ADF」タブの「ロギング」グループに含まれており、設計モードとテスト・モードの両方で使用できます。
図C-2に、「Oracle ADF」タブのロギング・ツールを示します。
「ロギング」グループには次のボタンがあります。
コンソール
統合Excelワークブックを開発およびテストしながら最新のログ・エントリを確認できる、ロギング・コンソール・ウィンドウを表示します。このコンソールには、コンソールが開いている間に記録されたエントリが表示されます。図C-3に示すロギング・コンソール・ウィンドウには、情報およびエラーのログ・エントリが表示されています。
このコンソールは、サイズ変更が可能でバッファ・サイズが64,000文字の非モーダル・ウィンドウです。バッファがいっぱいになると、古いエントリは削除されます。
このダイアログには次のボタンがあります。
レベルの設定: ログ出力レベルを設定する場合は、これをクリックします。このボタンをクリックすると、目的のログ出力レベルを選択できるロギング出力レベル・ダイアログが開きます。
クリア: ログ・バッファをクリアする場合にクリックします。
閉じる: ダイアログを閉じる場合にクリックします。
注意: 一般的なロギング・コンソール・ウィンドウでは、開いているすべての統合Excelワークブックのエントリが記録されます。 |
出力レベルの設定
ログ出力のレベルを選択するよう求められます。表C-2に、クライアント・サイド・ロギングがサポートするログ・レベルを示します。ログ・レベルは、表C-2のリストの下方向に累積されます。つまり、Information
レベルにはCritical
、Error
およびWarning
レベルでログされたデータは含まれますが、Verbose
レベルでログされたデータは含まれません。
表C-2 クライアント・サイド・ロギングのレベル
レベル | 説明 |
---|---|
|
クリティカルな情報を取得します。 |
|
重度のエラーと例外に関する情報を取得します。 |
|
警告に関する情報を取得します。 |
|
ライフ・サイクル・イベントとコントロール・フロー・イベントを取得します。 |
|
アプリケーションの実行フローに関する詳細を取得します。 |
|
ログは取得されません。これがデフォルト値です。 |
注意: ログ出力のレベルは、指定されたロガーのすべてのリスナーに適用されます。 |
ログ出力ファイルの追加
指定のファイルまたは形式にロギング出力を送るための、一時ロギング・リスナーを作成します。「新規一時ロギング出力ファイルの追加」ダイアログで、目的のファイル出力形式(テキストまたはXML)を選択し、ログ出力ファイルのパスとファイル名を指定します。
一時リスナーは、現在のExcelセッションのロギング出力のみを送り、ADFデスクトップ統合の構成ファイルには登録されません。Excelを終了すると、一時リスナーは削除されます。
注意: 「ログ出力ファイルの追加」ボタンをクリックすると、新しいリスナーが作成されます。新しいリスナーによって、ADFデスクトップ統合の構成ファイルで定義された既存のリスナー、または他の一時リスナーは置換されません。 |
構成のリフレッシュ
ADFデスクトップ統合の構成ファイルをリロードします。ADFデスクトップ統合の構成ファイルによって、ADFデスクトップ統合アドインで記録される情報のレベルを決定できます。
ADFデスクトップ統合の構成ファイルの作成および構成の詳細は、C.C.4.3.2項「ADFデスクトップ統合の構成ファイルについて」を参照してください。
ADFデスクトップ統合の構成ファイルは、adfdi-excel-addin.dll.config
として保存されます。ファイルの正しい名前および場所を調べるには、「Oracle ADF」タブの「ワークブック」グループにある「バージョン情報」ボタンをクリックします。表示されるダイアログで「プロパティ」タブをクリックし、「構成」エントリで構成ファイルのファイル名および場所を調べます。
構成ファイルの要素の詳細は、Microsoft Developer Networkのドキュメントの「Configuration File Schema for the .NET Framework」の項を参照してください。トレースおよびデバッグの設定の詳細は、Microsoft Developer Networkのドキュメントの「Trace and Debug Settings Schema」の項を参照してください。
クライアント・サイド・ロギングの有効な構成方法は多数ありますが、例C-1に示す構成ファイルのサンプルはその1つで、.xml
ログ・ファイルが生成されます。このファイルでは、様々な情報(ThreadId
、ProcessId
およびDateTime
など)がVerbose
ロギング・レベルで取得されます。
例C-1 サンプル構成ファイル
<?xml version="1.0"?> <configuration> <system.diagnostics> <sources> <source name="adfdi-common" switchValue="Verbose"> <listeners> <add type="System.Diagnostics.XmlWriterTraceListener" name="adfdi-common-excel.xml" initializeData="c:\logs\adfdi-common-excel.xml" traceOutputOptions="ThreadId, ProcessId, DateTime"/> </listeners> </source> </sources> </system.diagnostics> </configuration>
ADFデスクトップ統合の構成ファイルを格納するディレクトリにアクセスできないユーザーは、ユーザー環境変数の値を設定してログ・ファイルの保存場所とロギング・レベルを変更できます。ロギング・レベルとXMLログ・ファイルの場所を構成するための、2つのユーザー環境変数を追加できます。
Windowsでユーザー環境変数を追加または構成するには:
Windowsの「スタート」ボタン、「コントロール パネル」の順にクリックします。
「コントロール パネル」で、「システム」、「システムの詳細設定」の順にクリックします。
「システムのプロパティ」ダイアログの「詳細設定」タブで、「環境変数」をクリックします。
「環境変数」ダイアログで「usernameのユーザー環境変数」入力フィールドの下方にある「新規」をクリックし、表C-3の説明に従って変数を追加します。
表C-3 ロギングを構成するためのユーザー環境変数
入力する変数の名前 | 指定する値 |
---|---|
|
ロギング情報を取得するXMLファイルのディレクトリ・パスおよびファイル名を定義する値。 ここで指定するディレクトリは、 |
|
ロギングのレベルを指定する値。有効な値は表C-2を参照してください。 |
「OK」をクリックします。
adfdi-common
オブジェクトは、Microsoft .NET FrameworkのSystem.Diagnostics
名前空間のTraceSource
クラスのインスタンスです。このオブジェクトを使用してログ・ファイルを生成すると、Fusion Webアプリケーションと統合するExcelワークブックでトリガーされるイベントの情報を取得できます。ログ・ファイルの場所を知るには、「情報」ダイアログの「プロパティ」タブの「ログ・ファイル」属性を確認します。
TraceSource
クラスの詳細は、Microsoft Developer Networkのドキュメントを参照してください。
ADFデスクトップ統合対応のFusion Webアプリケーションまたはワークブックを使用または構成しているとき、エラー・メッセージが表示されたり、問題が発生する場合があります。次のリストは、最も一般的なエラー・メッセージとそれらの原因および解決策を説明しています。
ADFデスクトップ統合のすべてのエラー・メッセージの詳細は、エラー・メッセージ・リファレンスを参照してください。
システム管理者の場合、『Oracle Application Development Framework管理者ガイド』のADFデスクトップ統合の一般的なエラー・メッセージと問題に関する項を参照する必要があります。