ヘッダーをスキップ
Oracle® Fusion Middleware Oracle Business Intelligence Discoverer WebサービスAPIユーザーズ・ガイド
11g リリース1（11.1.1）
E51913-01
  目次
目次		 索引
索引
戻る
戻る 		 次へ
次へ		  

2 Discoverer WebサービスAPIリファレンス

この章では、次のDiscoverer WebサービスAPIのリファレンス情報について詳細に説明します。

2.1 AppsConnect

この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

    このオブジェクトは、Discovererアプリケーション用の有効なAPP_SECUREチケットを含む必要があります。

  • ConnectStr

    このオブジェクトは、Discovererに接続するための接続詳細を渡します。

  • eul

    ユーザーの接続先のEULを含むデータベース・スキーマの名前を指定します。

  • ロケール

    このオブジェクトは、Webサービス・セッションにロケール情報を渡します。デフォルトでは、ロケールは英語（en-US）です。
出力
  • SessionKey
例外
  • DiscovererWSException

  • DiscovererSessionUnavailableException

次の表は、構造のフィールドを示しています。

構造 フィールド
Ticket
  • String ticket_name
ConnectString
  • String name
DiscoEulName
  • String eulname
LocaleBean
  • String language

  • String country

  • String variant

2.2 getConnectionList

このAPIコールは接続のリストを取得します。SessionKeyを受け付け、Connectionリスト・オブジェクトを返します。シングル・サインオン・モードでは、パブリック接続とプライベート接続のリストが返されます。使用できる接続タイプはリレーショナル、OLAPまたはAPPSです。

API 詳細
メソッド 
Public ConnectionList getConnectionList(SessionKey aSessionKey) { }
入力:
  • SessionKey
出力
  • ConnectionList
例外
  • java.rmi.RemoteException

次の表は、構造のフィールドを示しています。

構造 フィールド
ConnectionList
  • Connectionオブジェクトの配列
Connection
  • ConnectionName

  • ConnectionKey

  • ConnectionDescription

  • ConnectionEUL

  • ConnectionDBIdentifier

  • ConnectionAccessType
ConnectionName
  • String name
ConnectionKey
  • String key
ConnectionDescription
  • String description
ConnectionEUL
  • String eulname
ConnectionDBIdentifier
  • String database name
ConnectionAccessType
  • String accesstype

2.3 getFolderEntryList

この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 ) { }
入力:
  • SessionKey

  • ConnectionKey

  • FolderEntryPath

    ワークブックとFolderEntriesが必要なパス。
出力
  • FolderEntryListオブジェクト
例外
  • java.rmi.RemoteException

次の表は、構造のフィールドを示しています。

構造 フィールド
FolderEntryList
  • FolderEntryオブジェクトの配列

  • String country

  • String variant
FolderEntry
  • FolderEntryName

  • FolderEntrypath

    FolderEntryまたはWorkbookEntryへの完全修飾パス。

  • FolderEntryType

  • FolderEntryDescription
FolderEntryName
  • String name
FolderEntryPath
  • String path
FolderEntryDescription
  • String description
FolderEntryType
  • String type

    FolderEntryまたはWorkbookEntry

  • WorkbookKey

    タイプはWorkbookEntryの場合、有効です。
WorkbookKey
  • String wbDevKey

  • ConnectionKey

2.4 getLayoutMetaData

このAPIコールは、選択したワークシートのレイアウト・メタデータを取得します。このAPIコールは、SessionKeyおよびWorksheetKeyを受け付け、WorksheetKeyで識別されるワークシートのレイアウト情報を提供します。

API 詳細
メソッド 
Public Layout getLayoutMetaData(SessionKey aSessionKey,
WorksheetKey  aWorksheetKey ) {}
入力:
  • SessionKey

  • WorksheetKey
出力
  • Layout
例外
  • java.rmi.RemoteException

次の表は、構造のフィールドを示しています。

構造 フィールド
Layout
  • Dimensionオブジェクトの配列

  • Measureオブジェクトの配列
Dimension
  • String label
Measure
  • String label

2.5 getParameterMetaData

このAPIコールは、選択したワークシートのパラメータ・メタデータを取得します。SessionKeyおよびWorksheetKeyを受け付け、WorksheetKeyで識別されるワークシートのパラメータ・リストを提供します。

API 詳細
メソッド 
Public ParameterList getParameterMetaData(SessionKey aSessionKey,
WorksheetKey  aWorksheetKey ) {}
入力:
  • SessionKey

  • WorksheetKey
出力
  • ParameterList
例外
  • java.rmi.RemoteException

次の表は、構造のフィールドを示しています。

構造 フィールド
ParameterList
  • Parameterオブジェクトの配列

2.6 getParameterValueList

このAPIコールは、ParameterKeyを使用してパラメータLOVを取得します。SessionKey、ParameterKeyおよびnumValuesを受け付け、値リスト（LOV）を提供します。このメソッドはLOVを持つパラメータに対してコールします。LOVはまとまりで取得され（サイズはnumValuesで指定されます）、先頭から末尾への1方向にのみページングできます（パラメータの双方向ページングはサポートされていません）。パラメータはクライアント・アプリケーションがキャッシュします。

API 詳細
メソッド 
Public ParameterValueList getParameterValueList(SessionKey
aSessionKey, ParameterKey aParamKey, int numValues){ }
入力:
  • SessionKey

  • ParameterKey

  • numValues

    Webサービスが1回のコールで返す値の数を指定する整数値です。さらに値がある場合は、getParameterValueListを繰り返しコールする必要があります。
出力
  • ParameterValueList
例外
  • java.rmi.RemoteException
注記
  • パラメータのリンクは非アクティブです。

次の表は、構造のフィールドを示しています。

構造 フィールド
ParameterValueList
  • ParameterValueオブジェクトの配列

  • Boolean finished

2.7 getCascadeParameterValueList

この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){ }
入力:
  • SessionKey

  • ParameterKey

  • numValues

    Webサービスが1回のコールで返す値の数を指定する整数値です。さらに値がある場合は、getCascadeParameterValueListを繰り返しコールする必要があります。

  • ParameterSelectList
出力 ParameterValueList
例外
  • DiscovererWSException

  • DiscovererSessionUnavailableException

  • DiscovererSessionCreationFailedException

次の表は、構造のフィールドを示しています。

構造 フィールド
ParameterValueList
  • ParameterValueオブジェクトの配列

  • Boolean finished

2.8 getQueryStatus

このAPIコールは、クエリーのステータス（実行中、取消など）を返します。このAPIコールはSessionKeyおよびQueryKeyを受け付けます。

API 詳細
メソッド 
Public QueryStatus getQueryStatus(SessionKey aSessionKey,
QueryKey aQueryKey){ }
入力:
  • SessionKey

  • QueryKey
出力
  • QueryStatus
例外
  • java.rmi.RemoteException

次の表は、構造のフィールドを示しています。

構造 フィールド
QueryStatus
  • String detail

  • String status

ステータスは次のいずれかです。

  • QUERY_FAILED

  • QUERY_EXECUTING

  • QUERY_CANCELED

  • QUERY_RESULTS_READY

  • QUERY_NEEDS_EXECUTING

  • QUERY_NOT_DEFINED

  • QUERY_SCHEDULED

  • QUERY_VALIDATING

2.9 getVersion

このAPIコールはWebサービス・コンポーネントのバージョンを提供します。Webサービス・インタフェースまたはAPIになんらかの変更が加えられると、バージョン番号が変更されます。バージョン番号を使用して、Webサービスで使用可能な機能を特定できます。

API 詳細
メソッド 
Public String getVersion( ) { }
入力:
  • Void
出力
  • String

バージョン1.0には、Oracle BI Publisherとの統合のサポートが含まれます。

バージョン2.0には、Oracle BI Publisherとの統合およびOracle BI Enterprise Editionとの相互運用のサポートが含まれます。
例外
  • なし

2.10 getViewerURL

このAPIコールは、同一マシン上にWebサービスとしてホストされたDiscoverer ViewerインスタンスのURLを提供します。クライアントはこのURLを使用して、それぞれのアプリケーションからDiscoverer Viewerを起動できます。

API 詳細
メソッド 
Public String getViewerURL(SessionKey aSessionKey,
WorksheetKey aWorksheetkey, List aParameteSelectList){ }
入力:
  • SessionKey

  • WorksheetKey

  • ParameterSelectのJava.util.List
出力
  • String

    Discoverer Viewerを起動するURL
例外
  • java.rmi.RemoteException

2.11 getWorksheetData

このAPIコールは、SessionKeyおよびQueryKeyを受け付け、SubmitWorksheetQueryメソッドのQueryOptionで指定されたフォーマット・タイプでワークシート・データを提供します。結果セットが大きく、かつRowset XMLの場合、デフォルトで25行のデータが返されます。他のフォーマット・タイプの場合は、1MBのデータが返されます。残りのデータは、このメソッドを繰り返しコールすることによってページングできます。QueryResultsの終了フラグがFALSEの場合、このメソッドを再度コールして、データのページングを続行します。ページングは先頭から末尾への1方向のみ可能です。双方向のページングはサポートされていません。

API 詳細
メソッド 
Public QueryResult getWorksheetData(SessionKey aSessionKey,
QueryKey aQueryKey){ }
入力:
  • SessionKey

  • QueryKey
出力
  • QueryResult
例外
  • java.rmi.RemoteException

次の表は、構造のフィールドを示しています。

構造 フィールド
QueryResult
  • String data

    行セットXML、HTML、PDF、XLSデータ。HTML、PDF、XLSデータはbase64でエンコードされます。

  • Boolean finished

    finishedがtrueの場合は、GetWorksheetDataをコールしません。

次の表に、エクスポート・タイプを示します。

エキスポート・タイプ リレーショナル OLAP
HTML HTMLファイルは、転送する前に圧縮されbase64でエンコードされます。 HTMLファイルは、転送する前に圧縮されbase64でエンコードされます。
PDF PDFファイルは、転送する前にbase64でエンコードされます。 PDFファイルは、転送する前にbase64でエンコードされます。
XLS XLSファイルは、転送する前にbase64でエンコードされます。Discoverer Viewerの場合と同様、グラフはエクスポートされません。 XLSファイルは、転送する前にbase64で圧縮されます。グラフはエクスポートされます。

エクスポート・タイプがHTML、PDFまたはXLSの場合は次のとおりです。

このエクスポート動作は、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>

2.12 getWorkSheetList

このAPIコールは、SessionKeyおよびWorkbookKeyを受け付け、WorkbookKeyで指定されたワークブック内のワークシートのリストを提供します。

API 詳細
メソッド 
Public WorksheetList getWorkSheetList(SessionKey aSessionKey, WorkbookKey  aWorkbookKey ) {}
入力:
  • SessionKey

  • WorkbookKey
出力
  • WorksheetList
例外
  • java.rmi.RemoteException

次の表は、構造のフィールドを示しています。

構造 フィールド
WorksheetList
  • Worksheetオブジェクトの配列
Worksheet
  • WorksheetName

  • WorksheetKey

  • Parameterオブジェクトの配列

    常にゼロ・サイズの配列です。
WorksheetName
  • String name
WorksheetKey
  • String wsDevKey

    ワークシートを識別します。Discoverer Plus RelationalまたはDiscoverer Plus OLAPの場合は文字列です。

  • WorkbookKey

2.13 isSessionValid

このAPIは、SessionKeyを受け付け、指定されたセッションが有効かどうかを示すブール値を返します。

API 詳細
メソッド 
Public boolean isSessionValid( SessionKey sKey ) { }
入力:
  • SessionKey
出力
  • セッションが有効な場合はTRUE、無効な場合はFALSE
例外
  • java.rmi.RemoteException

2.14 login

この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) { }
入力:
  • UserCredential

    このオブジェクトは、Discovererユーザーの有効なログイン詳細を含む必要があります。

  • LocaleBean

    このオブジェクトは、Webサービス・セッションにロケール情報を渡します。デフォルトでは、ロケールは英語（en-US）です。
出力
  • SessionKey
例外
  • java.rmi.RemoteException

次の表は、構造のフィールドを示しています。

構造 フィールド
LocaleBean
  • String language

  • String country

  • String variant
UserCredential
  • Identifier anIdentifier

  • DisplayName aDisplayName
Identifier
  • String id
DisplayName
  • String user
SessionKey
  • String key

    安全に生成されたランダムな英数字列。

2.15 logout

このAPIコールは、Discoverer WebサービスAPIにユーザー・セッションの完了を通知します。このコールは、ユーザー・セッションに関連付けられたDiscoverer専用セッションを解放し、Discovererセッションをセッション・プールに返します。

API 詳細
メソッド 
Public void logout(SessionKey aSessionKey ) { }
入力:
  • SessionKey
出力
  • Void
例外
  • java.rmi.RemoteException

2.16 requestQueryCancel

このAPIは、クエリー・リクエストを取り消し、そのリクエストに関連付けられたリソースを削除します。このメソッドは、発行されてもデータがまだフェッチされていないクエリーに対して使用します。クエリー・データがフェッチされていた場合は、リソースが削除されます。この非同期APIコールは即時に返されます。

API 詳細
メソッド 
Public Void requestQueryCancel(SessionKey aSessionKey, QueryKey){ }
入力:
  • SessionKey
出力
  • Void
例外
  • java.rmi.RemoteException

2.17 submitWorksheetQuery

このAPIコールは、実行対象として指定されたワークシートへのクエリーを発行します。この非同期APIコールは、クエリー実行の完了まで待機せず、即時に返されます。

API 詳細
メソッド 
Public QueryKey submitWorksheetQuery(SessionKey aSessionKey, WorksheetKey aWorksheetkey, List aParameteSelectList, QueryOption aQueryOption){ }
入力:
  • SessionKey

  • WorksheetKey

  • ParameterSelectのJava.util.List

  • QueryOption
出力
  • QueryKey
例外
  • java.rmi.RemoteException

次の表は、構造のフィールドを示しています。

構造 フィールド
QueryKey
  • String queryId

    ランダムに生成されるセキュアな一意キー。
ParameterSelect
  • ParameterKey

  • ParameterValueオブジェクトの配列
QueryOption
  • int NoOfRows

    行セットXMLで返す行数。デフォルトは25。

  • int NoOfRows

    行セットXMLで返す行数。デフォルトは25。

  • int chunksize

    PDF、XLSおよびHTMLフォーマットの場合はデータ・チャンクのKB単位のサイズ。デフォルトは64KB。

  • ResultType

  • UserCredential

    クエリー実行対象のユーザーのGUIDUsernameまたはSSOUsername。ユーザーが指定されていない場合、クエリーはログイン・ユーザーに対して実行されます。
LocaleBean
  • String type

有効なタイプは次のとおりです。

  • XMLROWSET

  • HTML - base64でエンコードされたコンテンツがデータ文字列で返されます。

  • PDF - base64でエンコードされたコンテンツがデータ文字列で返されます。

  • XLS - base64でエンコードされたコンテンツがデータ文字列で返されます。

  戻る
戻る 		 次へ
次へ
  目次
目次		 索引
索引