Oracle® Fusion Middleware Oracle Business Intelligence Discoverer WebサービスAPIユーザーズ・ガイド 11g リリース1(11.1.1) E51913-01 |
|
戻る |
次へ |
この章では、次のDiscoverer WebサービスAPIのリファレンス情報について詳細に説明します。
このAPIは、Oracle E-Business Suite (EBS)ユーザーがDiscoverer Webサービスへのセキュアな接続を確立するために使用します。
このAPIコールは、APP_SECUREチケット、接続文字列、EULの名前およびLocaleBean情報を受け付け、一意なSessionKeyを返します。その後、SessionKeyは他のすべてのAPIコールに渡されます。
API | 詳細 |
---|---|
メソッド |
Public SessionKey AppsConnect(ticket,ConnectStr,eul,locale) { } |
入力: |
|
出力 |
|
例外 |
|
次の表は、構造のフィールドを示しています。
構造 | フィールド |
---|---|
Ticket |
|
ConnectString |
|
DiscoEulName |
|
LocaleBean |
|
このAPIコールは接続のリストを取得します。SessionKeyを受け付け、Connectionリスト・オブジェクトを返します。シングル・サインオン・モードでは、パブリック接続とプライベート接続のリストが返されます。使用できる接続タイプはリレーショナル、OLAPまたはAPPSです。
API | 詳細 |
---|---|
メソッド |
Public ConnectionList getConnectionList(SessionKey aSessionKey) { } |
入力: |
|
出力 |
|
例外 |
|
次の表は、構造のフィールドを示しています。
構造 | フィールド |
---|---|
ConnectionList |
|
Connection |
|
ConnectionName |
|
ConnectionKey |
|
ConnectionDescription |
|
ConnectionEUL |
|
ConnectionDBIdentifier |
|
ConnectionAccessType |
|
このAPIコールは接続を使用して非スケジュール・ワークブックとFolderEntriesのリストを取得します。SessionKey、ConnectionKey、およびFolderEntrypathを受け付け、FolderEntrypathの接続からアクセス可能な非スケジュール・ワークブックとFolderEntriesデータを提供します。非スケジュール・ワークブックのリストには、接続で使用されているデータベース・ユーザーのすべての共有ワークブックが含まれます。
リレーショナル・データへの接続の場合、ワークブックはEULの単一レベルに格納されます。FolderEntrypathの有効値は“”のみです。空白の文字列は、Discoverer Plus RelationalとDiscoverer Plus OLAPの両方のルート・フォルダ・エントリを示します。
OLAPデータへの接続の場合、FolderEntriesとワークブックはDiscovererカタログに格納されます。FolderEntriesは複数のレベルで構成されている可能性があり、適切なFolderEntryPathを指定してクエリーできます。クライアントは、FolderEntriesを参照するために、このWebサービスを連続してコールする必要があります。
API | 詳細 |
---|---|
メソッド |
Public FolderEntryList getFolderEntryList(SessionKey aSessionKey, ConnectionKey aCkey, FolderEntrypath fpath ) { } |
入力: |
|
出力 |
|
例外 |
|
次の表は、構造のフィールドを示しています。
構造 | フィールド |
---|---|
FolderEntryList |
|
FolderEntry |
|
FolderEntryName |
|
FolderEntryPath |
|
FolderEntryDescription |
|
FolderEntryType |
|
WorkbookKey |
|
このAPIコールは、選択したワークシートのレイアウト・メタデータを取得します。このAPIコールは、SessionKeyおよびWorksheetKeyを受け付け、WorksheetKeyで識別されるワークシートのレイアウト情報を提供します。
API | 詳細 |
---|---|
メソッド |
Public Layout getLayoutMetaData(SessionKey aSessionKey, WorksheetKey aWorksheetKey ) {} |
入力: |
|
出力 |
|
例外 |
|
次の表は、構造のフィールドを示しています。
構造 | フィールド |
---|---|
Layout |
|
Dimension |
|
Measure |
|
このAPIコールは、選択したワークシートのパラメータ・メタデータを取得します。SessionKeyおよびWorksheetKeyを受け付け、WorksheetKeyで識別されるワークシートのパラメータ・リストを提供します。
API | 詳細 |
---|---|
メソッド |
Public ParameterList getParameterMetaData(SessionKey aSessionKey, WorksheetKey aWorksheetKey ) {} |
入力: |
|
出力 |
|
例外 |
|
次の表は、構造のフィールドを示しています。
構造 | フィールド |
---|---|
ParameterList |
|
このAPIコールは、ParameterKeyを使用してパラメータLOVを取得します。SessionKey、ParameterKeyおよびnumValuesを受け付け、値リスト(LOV)を提供します。このメソッドはLOVを持つパラメータに対してコールします。LOVはまとまりで取得され(サイズはnumValuesで指定されます)、先頭から末尾への1方向にのみページングできます(パラメータの双方向ページングはサポートされていません)。パラメータはクライアント・アプリケーションがキャッシュします。
API | 詳細 |
---|---|
メソッド |
Public ParameterValueList getParameterValueList(SessionKey aSessionKey, ParameterKey aParamKey, int numValues){ } |
入力: |
|
出力 |
|
例外 |
|
注記 |
|
次の表は、構造のフィールドを示しています。
構造 | フィールド |
---|---|
ParameterValueList |
|
このAPIコールは、ParameterKeyおよびParameterSelectListを使用してパラメータLOVを取得します。SessionKey、ParameterKey、numValuesおよびParameterSelectListを受け付け、値リスト(LOV)をカスケード・スタイルで提供します。カスケード・パラメータでは、1つのパラメータのLOVは、ワークシートの前のパラメータに選択された値に依存します。LOVはまとまりで取得され(サイズはnumValuesで指定されます)、先頭から末尾への1方向にのみページングできます(パラメータの双方向ページングはサポートされていません)。パラメータはクライアント・アプリケーションがキャッシュします。
API | 詳細 |
---|---|
メソッド |
Public ParameterValueList getCascadeParameterValueList(SessionKey aSessionKey, ParameterKey aParamKey, int numValues, ParameterSelectList pselectList){ } |
入力: |
|
出力 | ParameterValueList |
例外 |
|
次の表は、構造のフィールドを示しています。
構造 | フィールド |
---|---|
ParameterValueList |
|
このAPIコールは、クエリーのステータス(実行中、取消など)を返します。このAPIコールはSessionKeyおよびQueryKeyを受け付けます。
API | 詳細 |
---|---|
メソッド |
Public QueryStatus getQueryStatus(SessionKey aSessionKey, QueryKey aQueryKey){ } |
入力: |
|
出力 |
|
例外 |
|
次の表は、構造のフィールドを示しています。
構造 | フィールド |
---|---|
QueryStatus |
ステータスは次のいずれかです。
|
このAPIコールはWebサービス・コンポーネントのバージョンを提供します。Webサービス・インタフェースまたはAPIになんらかの変更が加えられると、バージョン番号が変更されます。バージョン番号を使用して、Webサービスで使用可能な機能を特定できます。
API | 詳細 |
---|---|
メソッド |
Public String getVersion( ) { } |
入力: |
|
出力 |
バージョン1.0には、Oracle BI Publisherとの統合のサポートが含まれます。 バージョン2.0には、Oracle BI Publisherとの統合およびOracle BI Enterprise Editionとの相互運用のサポートが含まれます。 |
例外 |
|
このAPIコールは、同一マシン上にWebサービスとしてホストされたDiscoverer ViewerインスタンスのURLを提供します。クライアントはこのURLを使用して、それぞれのアプリケーションからDiscoverer Viewerを起動できます。
API | 詳細 |
---|---|
メソッド |
Public String getViewerURL(SessionKey aSessionKey, WorksheetKey aWorksheetkey, List aParameteSelectList){ } |
入力: |
|
出力 |
|
例外 |
|
このAPIコールは、SessionKeyおよびQueryKeyを受け付け、SubmitWorksheetQueryメソッドのQueryOptionで指定されたフォーマット・タイプでワークシート・データを提供します。結果セットが大きく、かつRowset XMLの場合、デフォルトで25行のデータが返されます。他のフォーマット・タイプの場合は、1MBのデータが返されます。残りのデータは、このメソッドを繰り返しコールすることによってページングできます。QueryResultsの終了フラグがFALSEの場合、このメソッドを再度コールして、データのページングを続行します。ページングは先頭から末尾への1方向のみ可能です。双方向のページングはサポートされていません。
API | 詳細 |
---|---|
メソッド |
Public QueryResult getWorksheetData(SessionKey aSessionKey, QueryKey aQueryKey){ } |
入力: |
|
出力 |
|
例外 |
|
次の表は、構造のフィールドを示しています。
構造 | フィールド |
---|---|
QueryResult |
|
次の表に、エクスポート・タイプを示します。
エキスポート・タイプ | リレーショナル | OLAP |
---|---|---|
HTML | HTMLファイルは、転送する前に圧縮されbase64でエンコードされます。 | HTMLファイルは、転送する前に圧縮されbase64でエンコードされます。 |
PDFファイルは、転送する前にbase64でエンコードされます。 | PDFファイルは、転送する前にbase64でエンコードされます。 | |
XLS | XLSファイルは、転送する前にbase64でエンコードされます。Discoverer Viewerの場合と同様、グラフはエクスポートされません。 | XLSファイルは、転送する前にbase64で圧縮されます。グラフはエクスポートされます。 |
エクスポート・タイプがHTML、PDFまたはXLSの場合は次のとおりです。
ワークシートにページ・アイテムがない場合、すべてのデータがエクスポートされます。
ワークシートにページ・アイテムがある場合、OLAP接続とリレーショナル接続とでは、出力が次のように異なります。
リレーショナル接続の場合
エクスポート・タイプがHTML、PDFまたはXLSの場合、ワークシートで選択されたページ・アイテムのワークシート・データが返されます。
OLAP接続の場合
エクスポート・タイプがXLSの場合、ページ・アイテム値のすべての組合せについてワークシート・データが返されます。
エクスポート・タイプがHTMLまたはPDFの場合、選択されたページ・アイテムのワークシート・データが返されます。
このエクスポート動作は、configuration.xmlのisCurrentPageItemsExportForOLAPの設定が考慮されない点を除いて、Viewerと同様です。
行セットXML構造のサンプル
<BIData> <Query id="1"> <PAGE> <ROWSET> <ROW> <Dimension L="Time Dimension Values">1996</D> < Dimension L="Product Dimension Values">TOTALPROD</D> < Dimension L="Geography Dimension Values">WORLD</D> < Dimension L="Channel Dimension Values">TOTALCHANNEL</D> <Measure L="Dollar Sales">1.18247112042864E8</M> <Measure L="Quota">5475441.87541972</M> </ROW> <ROW> < Dimension L="Time Dimension Values">1997</D> < Dimension L="Product Dimension Values">TOTALPROD</D> < Dimension L="Geography Dimension Values">WORLD</D> < Dimension L="Channel Dimension Values">TOTALCHANNEL</D> <Measure L="Dollar Sales">4.64121127850704E7</M> <Measure L="Quota">2917189.84519184</M> </ROW> </ROWSET> </PAGE> </Query> </BIData>
このAPIコールは、SessionKeyおよびWorkbookKeyを受け付け、WorkbookKeyで指定されたワークブック内のワークシートのリストを提供します。
API | 詳細 |
---|---|
メソッド |
Public WorksheetList getWorkSheetList(SessionKey aSessionKey, WorkbookKey aWorkbookKey ) {} |
入力: |
|
出力 |
|
例外 |
|
次の表は、構造のフィールドを示しています。
構造 | フィールド |
---|---|
WorksheetList |
|
Worksheet |
|
WorksheetName |
|
WorksheetKey |
|
このAPIは、SessionKeyを受け付け、指定されたセッションが有効かどうかを示すブール値を返します。
API | 詳細 |
---|---|
メソッド |
Public boolean isSessionValid( SessionKey sKey ) { } |
入力: |
|
出力 |
|
例外 |
|
このAPIコールは、クライアント・アプリケーションとDiscoverer Webサービス間のユーザー・アイデンティティ伝播メカニズムを提供します。認証は、Discoverer Webサービスが呼び出されるたびに行われます。詳細は、「認証」を参照してください。クライアント・アプリケーションによって行われるログインごとに、Discoverer Webサービスは新規Discovererユーザー・セッションを作成してユーザーに割り当てます。このAPIコールは、UserCredentialおよびLocaleBeanを受け付け、一意なSessionKeyを返します。その後、SessionKeyは他のすべてのAPIコールに渡されます。クライアント・アプリケーション・インスタンスとDiscoverer Webサービスとの間にセッションが存在する場合、このAPIコールは新規HTTPセッションを作成しません。
API | 詳細 |
---|---|
メソッド |
Public SessionKey login(UserCredential aUserCredential, LocaleBean aLocale) { } |
入力: |
|
出力 |
|
例外 |
|
次の表は、構造のフィールドを示しています。
構造 | フィールド |
---|---|
LocaleBean |
|
UserCredential |
|
Identifier |
|
DisplayName |
|
SessionKey |
|
このAPIコールは、Discoverer WebサービスAPIにユーザー・セッションの完了を通知します。このコールは、ユーザー・セッションに関連付けられたDiscoverer専用セッションを解放し、Discovererセッションをセッション・プールに返します。
API | 詳細 |
---|---|
メソッド |
Public void logout(SessionKey aSessionKey ) { } |
入力: |
|
出力 |
|
例外 |
|
このAPIは、クエリー・リクエストを取り消し、そのリクエストに関連付けられたリソースを削除します。このメソッドは、発行されてもデータがまだフェッチされていないクエリーに対して使用します。クエリー・データがフェッチされていた場合は、リソースが削除されます。この非同期APIコールは即時に返されます。
API | 詳細 |
---|---|
メソッド |
Public Void requestQueryCancel(SessionKey aSessionKey, QueryKey){ } |
入力: |
|
出力 |
|
例外 |
|
このAPIコールは、実行対象として指定されたワークシートへのクエリーを発行します。この非同期APIコールは、クエリー実行の完了まで待機せず、即時に返されます。
API | 詳細 |
---|---|
メソッド |
Public QueryKey submitWorksheetQuery(SessionKey aSessionKey, WorksheetKey aWorksheetkey, List aParameteSelectList, QueryOption aQueryOption){ } |
入力: |
|
出力 |
|
例外 |
|
次の表は、構造のフィールドを示しています。
構造 | フィールド |
---|---|
QueryKey |
|
ParameterSelect |
|
QueryOption |
|
LocaleBean |
有効なタイプは次のとおりです。
|