| Oracle® Fusion Middleware Oracle Business Intelligence Enterprise Editionインテグレーターズ・ガイド 11g リリース1 (11.1.1) B63033-03 |
|
 前 |
 次 |
| Oracle® Fusion Middleware Oracle Business Intelligence Enterprise Editionインテグレーターズ・ガイド 11g リリース1 (11.1.1) B63033-03 |
|
前 |
次 |
この章では、Oracle Business Intelligenceのセッション・ベースWebサービスで使用する構造体について説明します。
このドキュメントでは、JavaScriptに類似した構文を使用して構造体を表現します。正確な構文および実装は、アプリケーション開発環境で使用されるSOAPコード生成ツールおよびターゲット言語により異なります。
この章の内容は次のとおりです。
この章の内容は次のとおりです。
この構造体を使用して、アクセス制御リストの特定のアカウントに許可されたパーミッションを説明します。この構造体は、SecurityServiceサービスで使用します。
表2-1に、この構造体のフィールドをリストします。
表2-1 AccessControlToken構造体のフィールド
| フィールド | 説明 |
|---|---|
|
Account account |
Account構造体への参照を指定します。 |
|
int permissionMask |
次のフラグの組合せを指定します。 1 = アイテムの内容を読むパーミッション 2 = ディレクトリをトラバースするパーミッション 4 = アイテムの内容を変更するパーミッション 8 = アイテムを削除するパーミッション 16 = 他のアカウントにパーミッションを設定するパーミッション 32 = アイテムの所有権を得るパーミッション 2048 = Oracle BI Publisherレポートを生で実行するパーミッション 4096 = Oracle BI Publisherレポートをスケジュールするパーミッション 8192 = Oracle BI Publisherレポートの出力を参照するパーミッション |
この構造体を使用して、ユーザー名やグループ名を保持します。これは、名前がユーザー名かグループ名かを示すフラグを持っています。この構造体は、SecurityServiceサービスで使用します。
表2-2に、この構造体のフィールドをリストします。
表2-2 Account構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String accountName |
アカウント名またはグループ名を指定します。 |
|
int accountType |
アカウントがユーザーか、グループか、または両方かを指定します(0 = ユーザー、1 = カタログ・グループ、2 = アプリケーション・ロール、3 = すべて)。 このフィールドの高度な使用方法として、次のことに注意してください。accountTypeが4以上の場合、システムはNameまたはGUIDをパターンとして扱います。すなわち、accountTypeはユーザーをフェッチする場合は4、カテゴリ・グループをフェッチする場合は5、アプリケーション・ロールをフェッチする場合は6、すべてのパターンの場合は7となります。このフィールドをこのように使用した場合、コストがかかり低速になるうえ、システムが大量にレコードを返却する原因となる可能性があります。Accountを受け取ると、NameとGUIDの両方が設定されます。accountTypeは、ユーザーの場合は0、カタログ・グループの場合は1、アプリケーション・ロールの場合は4となります。 |
|
String GUID |
アカウントを識別する一意のIDを指定します。 |
この構造体を使用して、アクセス制御リスト(ACL)を保持します。この構造体は、SecurityServiceサービスで使用します。
表2-3に、この構造体のフィールドをリストします。
この構造体を使用して、保存した結果セットを表すGUIDのリストを指定します。この構造体は、SecurityServiceサービスで使用します。
表2-4に、この構造体のフィールドをリストします。
この構造体を使用して、認可時の認証の詳細を指定します。この構造体は、SecurityServiceサービスで使用されています(impersonateex()メソッドおよびlogonex()メソッドの中で)。
表2-5に、この構造体のフィールドをリストします。
パスとタイムスタンプをもとにカタログ項目および変更をフィルタするために、この構造体を使用します。この構造体は、ReplicationServiceサービスで使用します。
表2-6に、この構造体のフィールドをリストします。
表2-6 CatalogItemsFilter構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String[] items |
フィルタに含めるフォルダおよびその子フォルダを指定します。この値がNULLの場合、カタログのすべてのノードが含まれます。 |
|
Calendar from |
フィルタする期間を指定します。その期間中のタイムスタンプを持つ項目および変更のみがフィルタを満たします。これらフィールドのいずれかまたは両方がNULLである場合、そのフィールドに対する範囲設定がないものとされます。 |
|
Calendar to |
フィルタする期間を指定します。その期間中のタイムスタンプを持つ項目および変更のみがフィルタを満たします(from <= タイムスタンプ <= to)。これらフィールドのいずれかまたは両方がNULLである場合、そのフィールドに対する範囲設定がないものとされます。 |
この構造体を使用して、単一のメソッドにおける特定のカタログ・オブジェクトのすべての情報を取得または指定します。この構造体はWebCatalogServiceサービスで使用します。
表2-7に、この構造体のフィールドをリストします。
表2-7 CatalogObject構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String catalogObject |
オブジェクトのXML表現を指定します。 |
|
catalogObjectBytes |
カタログ・オブジェクトから返却されるコンテンツが文字列かバイトかを指定します。このフィールドで指定するものは、readObjectsメソッドによって決まります。 |
|
ItemInfo itemInfo |
ItemInfo共通構造体で提供されているオブジェクトのカタログ情報を指定します。 ItemInfo構造体の詳細は、第2.11項「ItemInfo構造体」を参照してください。 |
|
ErrorInfo errorInfo |
readObjectsメソッドのErrorDetails引数の指定を受けて、提供するエラー情報のレベルを指定します。 |
この構造体を使用して、プレゼンテーション・カタログ・サービスのメソッドを呼び出す際のエラー情報を取得します。この構造体は、WebCatalogServiceサービスで使用します。
表2-8に、この構造体のフィールドをリストします。
この構造体を使用して、getSubItemsメソッドで使用されているオプションのパラメータを保持します。この構造体は、WebCatalogServiceサービスで使用します。
表2-9に、この構造体のフィールドをリストします。
表2-9 GetSubItemsParams構造体のフィールド
| フィールド | 説明 |
|---|---|
|
GetSubItemsFilter filter |
内部でのみ使用されます。 |
|
boolean includeACL |
TRUEに設定されている場合、結果のItemInfo構造体にACL情報が含まれます。 |
|
int withPermissionおよびint withPermissionMask |
結果のアイテム・コレクションをアクセス・レベルでフィルタすることを指定します。次の式でtrueとなるアイテムのみが結果に含まれます。 (itemPermission & withPermissionMask) = (withPermission & withPermissionMask)
|
|
int withAttributesおよび int withAttributesMask |
結果のアイテム・コレクションを属性フラグでフィルタすることを指定します。次の式でtrueとなるアイテムのみが結果に含まれます。 (itemAttributes & withAttributesMask) = (withAttributes & withAttributesMask)
|
この構造体を使用して、インポート時の失敗の原因を説明します。この構造体は、ReplicationServiceサービスで使用します。
表2-10に、この構造体のフィールドをリストします。
この構造体を使用して、オブジェクトのカタログ情報を保持します。この構造体は、WebCatalogServiceサービスで使用します。
表2-11に、この構造体のフィールドをリストします。
表2-11 ItemInfo構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String path |
カタログ内のオブジェクトへのパスを指定します。例: /users/jchan/analyses/。 |
|
ItemInfoType type |
型を示す文字列を指定します。有効な値は次のとおりです。
|
|
String caption |
カタログのオブジェクトのローカル名を指定します。たとえば、フランス語では「My Folders」は「Mes Dossiers」と表示されます。 |
|
int attributes |
次のフラグの組合せを指定します。 1 = 読取りのみ 2 = アーカイブ 4 = 非表示 8 = システム |
|
Calendar lastModified |
オブジェクトを最後に変更した日付と時間をカレンダ形式で指定します。 |
|
Calendar created |
カタログにオブジェクトを作成(保存)した日付と時間をカレンダ形式で指定します。 |
|
Calendar accessed |
ユーザーがオブジェクトに最後にアクセスした日付と時間をカレンダ形式で指定します。 |
|
String signature |
カタログ・オブジェクトのシグネチャを指定します。 |
|
NameValuePair[] itemProperties |
オブジェクト・プロパティの配列を指定します。 |
|
ACL aclXX |
このカタログ項目のアクセス制御リストを指定します。 |
|
Account owner |
オブジェクトのオーナーを指定します。 |
|
String targetPath |
ItemInfoTypeフィールドが「Link」に設定されている場合、このフィールドはオブジェクトのターゲット・パスを指定します。 |
この構造体を使用して、名前付きプロパティを指定します(COLOR=REDなど)。この構造体は、WebCatalogServiceサービスで使用します。
表2-12に、この構造体のフィールドをリストします。
この構造体を使用して、出力メソッドに含まれているデータのコピー先を指定します。この構造体は、ReplicationServiceサービスで使用します。
表2-13に、この構造体のフィールドをリストします。
この構造体を使用して、グローバル権限を表します。Oracle BI EEでは、「権限の管理」画面を使用してこれらの権限を構成します。この構造体は、第3.9項「SecurityServiceサービス」で使用します。
表2-14に、この構造体のフィールドをリストします。
この構造体を使用して、問合せ実行時の問合せ詳細を指定します。この構造体は、第3.11項「XMLViewServiceサービス」 (executeXMLQueryメソッド)で使用します。
表2-15に、この構造体のフィールドをリストします。
この構造体を使用して、結果をHTMLページに表示するオプションを定義します。この構造体は、第3.2項「HtmlViewServiceサービス」で使用します。
表2-16に、この構造体のフィールドをリストします。
表2-16 ReportHTMLOptions構造体のフィールド
| フィールド | 説明 |
|---|---|
|
boolean enableDelayLoading |
内部でのみ使用します。このフィールドは常に1が設定されます。これは、Oracle Business Intelligence Webサービスはすぐに結果を提供する必要がなく、結果待ちであるというメッセージを表示することを意味します。 |
|
String linkMode |
ドリルまたはリンクを現在のブラウザ・ウィンドウで表示するか、新しいブラウザ・ウィンドウで表示するかを指定します。有効な値の詳細は、第2.16.1項「ReportHTMLLinksMode列挙」を参照してください。 |
この列挙は、ReportHTMLOptions構造体のReportHTMLLinksModeフィールドで有効な値のリストを指定します。
表2-17に、この列挙の値をリストします。
この構造体を使用して、分析の既存のフィルタおよび変数を置き換えます。この構造体は、Oracle BI EE Webサービスのすべてのサービスで共通です。
表2-18に、この構造体のフィールドをリストします。
表2-18 ReportParams構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String[] filterExpressions |
Oracle Business Intelligence Webサービスのフィルタ式の配列を指定します(形式は、Object[] filter_expression, filter_expression ...)。 |
|
Variable[] variables |
メソッド実行前に設定する変数値の配列を指定します。この構造体は、第3.11.4項「executeXMLQuery()メソッド」および第3.7.3項「generateReportSQL()メソッド」で使用します。 |
|
NameValuePair[] nameValues |
NULLに設定します。このフィールドは内部で使用します。 |
|
TemplateInfo[] templateInfos |
NULLに設定します。このフィールドは内部で使用します。 |
|
String viewName |
分析のXMLデータを生成する際に、どのビューを使用するのかを指定します。 |
表2-19に、分析にフィルタ式を適用する方法を示します。
表2-19 Oracle BI EE Webサービスの分析にフィルタ式を適用する方法
| 手順 | 内部処理 |
|---|---|
|
1 |
分析のXML表現と各フィルタ式を取得します。 |
|
2 |
各式要素ごとに、sqlExpression型の子ノードを特定(型はxsi:type attributeの値によって決定)し、その内部テキストを参照します。 |
|
3 |
分析XMLにおいて、内部テキストが前述の手順で特定されたものと合致するsqlExpression型の子ノードを持つすべてのノードを特定します。 |
|
4 |
ステップ3で特定したすべてのノードを、ステップ2の式で置き換えます。 |
表2-20に、分析に変数を適用する方法を示します。
この構造体を使用して、次のいずれかの方法で分析を参照します。
カタログの分析の場所。
分析を定義するReportDefオブジェクト。このフィールドは常にNULLです。
分析を定義するXML。
|
注意: ReportRefの1つのフィールドのみにデータ移入します。 ReportRef構造体は、Oracle BI EE Webサービスのすべてのサービスに共通です。 |
表2-21に、この構造体のフィールドをリストします。
この構造体を使用して、サブジェクト・エリアの論理列を表します。この構造体は、第3.5項「MetadataServiceサービス」で使用します。
表2-22に、この構造体のフィールドをリストします。
表2-22 SAColumn構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String name |
SQL文で使用する列名を指定します。 |
|
String displayName |
Oracle Business Intelligence Answersで使用するローカル名を指定します。 |
|
String description |
列名の説明を保持する文字列を指定します。 |
|
boolean nullable |
TRUEに設定されている場合、列はNULLとなる場合があります。 |
|
String dataType |
列が保持するデータ型を指定します。詳細は、第2.19.1項「SADataType値」を参照してください。 |
|
boolean aggregateable |
TRUEに設定されている場合、列は集計できます。 |
|
String aggrRule |
列が集計データを保持する場合、この値は使用されている集計の種類を指定します。詳細は、第2.19.2項「AggregationRule値」を参照してください。 |
SADataTypeは、列が保持するデータの型を指定します。次のリストに、利用可能なデータ型を示します。
BigInt
Binary
Bit
Char
Coordinate
Date
Decimal
Double
Float
Integer
Invalid
LongVarBinary
LongVarChar
Numeric
Real
SmallInt
Time
TimeStamp
TinyInt
Unknown
VarBinary
VarChar
この構造体を使用して、サブジェクト・エリア属性を表します。この構造体は、第3.5項「MetadataServiceサービス」で使用します。
表2-23に、この構造体のフィールドをリストします。
表2-23 SASubjectArea構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String name |
SQL文で使用する表名を指定します。 |
|
String displayName |
Oracle Business Intelligence Answersで使用するローカル名を指定します。 |
|
String description |
サブジェクト・エリアの説明を指定します。 |
|
SATable[] tables |
このサブジェクト・エリアの表のコレクションを指定します。SATable構造体の詳細は、第2.21項「SATable構造体」を参照してください。 |
この構造体を使用して、サブジェクト・エリアの論理表を表します。この構造体は、第3.5項「MetadataServiceサービス」で使用します。
表2-24に、この構造体のフィールドをリストします。
表2-24 SATable構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String name |
SQL文で使用する表名を指定します。 |
|
String displayName |
Oracle Business Intelligence Answersで使用するローカル名を指定します。 |
|
String description |
表名の説明を指定します。 |
|
SAColumn[] columns |
表の列の配列を指定します。SAColumn構造体の詳細は、第2.19項「SAColumn構造体」を参照してください。 |
この構造体を使用して、現在のセッションのロケールを定義します。この構造体は、第3.8項「SAWSessionServiceサービス」で使用します。
表2-25に、この構造体のフィールドをリストします。
この構造体を使用して、現在のセッションにおけるオプションのパラメータを定義します。この構造体は、第3.8項「SAWSessionServiceサービス」で使用します。
表2-26に、この構造体のフィールドをリストします。
表2-26 SAWSessionParameters構造体のフィールド
| フィールド | 説明 |
|---|---|
|
SAWLocale locale |
使用するロケールを指定します(SAWLocale構造体で提供)。SAWLocale構造体の詳細は、第3.8項「SAWSessionServiceサービス」を参照してください。 |
|
String userAgent |
現在のセッションでHTMLViewサービスを使用するかどうかを指定します。これは、Oracle Business Intelligenceプレゼンテーション・サービスのHTMLコンテンツが表示される、ブラウザのuserAgent文字列を指定します。Oracle Business Intelligenceプレゼンテーション・サービスは、この情報を使用してブラウザ固有のHTMLを作成します。 |
|
String syndicate |
内部でのみ使用します。 |
|
LogonParameter logonParams |
認証で使用するパラメータを指定します。 |
|
boolean asyncLogon |
TRUEに設定されている場合、非同期ログインが有効になります。FALSE(デフォルト)に設定されている場合、非同期ログインは無効となります。 |
|
String sessionID |
セッションの一意のIDを指定します。このフィールドは、第3.8.9項「logonex()メソッド」および第3.8.5項「impersonateex()メソッド」で使用します。 |
この構造体を使用して、Oracle Marketing Analyticsのユーザー・インタフェースで指定されているデフォルトを上書きする、セグメントまたはセグメント・ツリーを定義します。この構造体は、第3.5項「MetadataServiceサービス」で使用します。
表2-27に、この構造体のフィールドをリストします。
表2-27 SegmentationOptions構造体のフィールド
| フィールド | 説明 |
|---|---|
|
OverrideType cacheOverride |
Oracle Marketing Analyticsにおける今後の更新カウント・リクエストに対するブロックをキャッシュのユーザー・インタフェース・オプションをどのように上書きするかを指定します。 デフォルトに設定されている場合、構造体でのキャッシュ・オーバーライドが指定されていないか、構造体が指定されていません。デフォルト値は、各基準ブロックのユーザー・インタフェース・オプションで定義されているものを使用することを指定しています。 Noneに設定されている場合、システムはユーザー・インタフェースで定義された値をオーバーライドし、すべての基準ブロックで今後の更新カウント・リクエストに対するブロックをキャッシュのユーザー・インタフェース・オプションを無効にします。 Allに設定されている場合、システムはユーザー・インタフェースで定義された値をオーバーライドし、すべての基準ブロックで今後の更新カウント・リクエストに対するブロックをキャッシュユーザー・インタフェースのオプションを有効にします。 |
|
OverrideType countOverride |
システムがカウント数の生成にgetCountsメソッドを使用するべきかを指定します。 デフォルトに設定されている場合、構造体でのカウントのオーバーライドが指定されていないか、構造体が指定されていません。 Allに設定されている場合、システムはgetCountsメソッドを実行します。Allに設定されている場合、システムはすべての基準ブロックに対してカウント数を計算します。 |
|
NameValuePair |
セグメントまたはセグメント・ツリーに対する契約計画ルールを適用するための値を指定します。 |
|
NameValuePair |
セグメントまたはセグメント・ツリーの列に適用するプロンプト値を指定します。このプロセスは、カウント生成時にデータをフィルタします。 このフィールドに値を提供しない場合、システムはセグメントの列に対してフィルタ基準を適用しません。 |
|
Boolean removeCacheHits |
カウント情報を含むキャッシュ・エントリの消去を指定します。 Trueに設定されている場合、システムは最新のデータに対して問合せを行います。これを行うため、システムはターゲットのセグメントまたはセグメント・ツリーのカウント情報を持つすべての既存キャッシュ・エントリを削除します。システムはその後、getCountsメソッドで計算された新しいカウント数エントリで、キャッシュのデータを再移入します。 |
|
BigDecimal samplingFactor |
カウントを計算するデータセットのサイズを指定します。getCountsメソッドは、この値によって決定するデータのサブセットに対し、すべての基準ブロックのカウント数を計算します。 デフォルト値は100です。このデフォルト値によって、カウント数は全データセットに対して計算されます。 |
この構造体を使用して、現在のセッションの環境情報を返却します。この構造体は、第3.8項「SAWSessionServiceサービス」で使用します。
表2-28に、この構造体のフィールドをリストします。
表2-28 SessionEnvironment構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String userName |
現在のユーザーの名前を指定します。 |
|
ItemInfo homeDirectory |
カタログにおけるユーザーのホーム・ディレクトリへのフルパスを指定します。例: /users/<ユーザー・ログインID>。 |
|
ItemInfo[] SharedDirectories |
現在のユーザーが最低でも読取りアクセス権を持つ共有ディレクトリへのフルパスを指定します。 注意: デフォルトでは、「/shared」ディレクトリの直下をリストできるのは管理者のみです。ユーザーによる共有エリアのナビゲートは、SessionEnvironmentオブジェクトの取得のみです。 |
この構造体を使用して、startPageメソッド起動のオプションを定義します。この構造体は、第3.2項「HtmlViewServiceサービス」で使用します。
表2-29に、この構造体のフィールドをリストします。
この構造体を使用して、セグメント・ツリーのブランチに対するセグメント・ツリー・パスとブランチIDを指定します。この構造体は、第3.4項「JobManagementServiceサービス」で使用します。
表2-30に、この構造体のフィールドをリストします。
この構造体を使用して、updateACLメソッド起動のオプションを設定します。この構造体は、第3.9項「SecurityServiceサービス」で使用します。
表2-31に、この構造体のフィールドをリストします。
表2-31 UpdateACLParams構造体のフィールド
| フィールド | 説明 |
|---|---|
|
UpdateACLMode updateFlag |
ACLモードの更新方法を指定します。詳細は、第2.28.1項「UpdateACLMode列挙」を参照してください。 |
この列挙は、UpdateACLParams構造体の更新フラグで有効な値のリストを指定します。
表2-32「UpdateACLMode列挙の値」に、この列挙の値をリストします。
この構造体を使用して、第3.10.18項「updateCatalogItemACL()メソッド」で追加のパラメータを提供します。この構造体は、第3.10項「WebCatalogServiceサービス」で使用します。
表2-33に、この構造体のフィールドをリストします。
表2-33 UpdateCatalogItemACLParams構造体のフィールド
| フィールド | 説明 |
|---|---|
|
UpdateACLMode updateFlag |
ACLモードの更新方法を指定します。詳細は、第2.28.1項「UpdateACLMode列挙」を参照してください。 |
|
boolean recursive |
TRUEに設定されている場合、メソッドはカタログ項目と、パスによって識別されるそのすべての子孫に適用されます。FALSEに設定されている場合、メソッドはカタログ項目にのみ適用されます。 |
この構造体を使用して、分析の変数を参照し、他の変数で置き換えます。この構造体は、Oracle BI EE Webサービスのすべてのサービスで共通です。
表2-34に、この構造体のフィールドをリストします。
この構造体を使用して、問合せにおけるオプションのパラメータを指定します。この構造体は、第3.11項「XMLViewServiceサービス」 (executeXMLQueryメソッドの中)で使用します。
表2-35に、この構造体のフィールドをリストします。
表2-35 XMLQueryExecutionOptions構造体のフィールド
| フィールド | 説明 |
|---|---|
|
boolean async |
TRUEに設定されている場合、非同期問合せ実行が有効です。FALSEに設定されている場合、非同期問合せ実行は無効です。 |
|
int maxRowsPerPage |
executeXMLQueryまたはfetchNextメソッドによって返却される行の最大数を指定します。 |
|
boolean refresh |
TRUEに設定されている場合、データをリフレッシュするためにサーバーが問合せを再送信します。FALSEに設定されている場合、Oracle Business Intelligence Serverはキャッシュにあるデータを使用します。 |
|
boolean presentationInfo |
TRUEに設定されている場合、ローカライズされたプレゼンテーション情報を、レコード・セットXMLのメタデータ・セクションに格納します。 プレゼンテーション情報は次のものから構成されます。
|
|
String type |
問合せIDを指定します。このIDは、エラーを診断する際に、ログで使用できます。 |
