プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle Business Intelligence Enterprise Editionインテグレーターズ・ガイド
12c (12.2.1)
E70040-02
  目次へ移動
目次
前
前 		 次
次		  

2 Oracle BI EE Webサービスで使用する構造体について

この章では、Oracle Business IntelligenceのセッションベースWebサービスで使用する構造体について説明します。

このドキュメントでは、JavaScriptに類似した構文を使用して構造体を表現します。正確な構文および実装は、アプリケーション開発環境で使用されるSOAPコード生成ツールおよびターゲット言語により異なります。

この章の内容は次のとおりです。

2.1 AccessControlToken構造体

この構造体を使用して、アクセス制御リストの特定のアカウントに許可されたパーミッションを説明します。この構造体は、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レポートの出力を参照するパーミッション

65535 = アイテムのフル・コントロール権限を付与するパーミッション

2.2 Account構造体

この構造体を使用して、ユーザー名やグループ名を保持します。これは、名前がユーザー名かグループ名かを示すフラグを持っています。この構造体は、SecurityServiceサービスで使用します。

表2-2に、この構造体のフィールドをリストします。

表2-2 Account構造体のフィールド

フィールド 説明

String accountName

アカウント名またはグループ名を指定します。

int accountType

アカウントがユーザーか、グループか、またはその両方かを指定します。

次の場合にaccountTypeを使用します。

  • "非問合せ" SOAP関数への入力(updateCatalogItemACL()をコールする際のパラメータなど)。

    または

  • SOAP関数からの出力(getAccounts()から戻されたデータなど)。

0 = ユーザー

1 = カタログ・グループ

2 = initblockユーザー

3 = 有効または削除済のアカウント

int accountFindType

アカウントがユーザーか、グループか、またはその両方かを指定します。

"問合せ" SOAP関数への入力(getAccounts()をコールする際のパラメータなど)として使用されている場合にaccountFindTypeを使用します。

0 = 名前またはGUIDの完全一致を使用してユーザーを検索します

1 = 名前またはGUIDの完全一致を使用してカタログ・グループを検索します

2 = 名前またはGUIDの完全一致を使用してアプリケーション・ロールを検索します

3 = 名前またはGUIDの完全一致を使用してユーザーまたはカタログ・グループまたはアプリケーション・ロールを検索します

このフィールドの高度な使用方法として、次のことに注意してください。accountFindTypeが4以上の場合、NameまたはGUIDはパターンとして扱われます。

4 = 名前またはGUIDのパターン一致を使用してすべてのユーザーを検索します

5 = 名前またはGUIDのパターン一致を使用してすべてのカタログ・グループを検索します

6 = 名前またはGUIDのパターン一致を使用してすべてのアプリケーション・ロールを検索します

7 = 名前またはGUIDのパターン一致を使用してすべてのユーザーかつWebカタログ・グループかつアプリケーション・ロールを検索します

このフィールドをこのように使用すると、低速になり、大量にレコードが戻される可能性があります。Accountを受け取ると、NameとGUIDの両方が設定されます。

String GUID

アカウントを識別する一意のIDを指定します。

2.3 ACL構造体

この構造体を使用して、アクセス制御リスト(ACL)を保持します。この構造体は、SecurityServiceサービスで使用します。

表2-3に、この構造体のフィールドをリストします。

表2-3 ACL構造体のフィールド

フィールド 説明

AccessControlToken[] accessControlTokens

パーミッションの全リストを指定します。詳細は、第2.1項「AccessControlToken構造体」を参照してください。

String dummy

内部で使用します。

2.4 Action構造体

この構造体を使用して、スコアカードにアタッチされたアクションに関する情報を保持します。この構造体は、ActionLinks構造体で使用します。

表2-4に、この構造体のフィールドをリストします。

表2-4 Action構造体のフィールド

フィールド 説明

String Path

ActionのターゲットであるBIコンテンツへのカタログ・パスを指定します(ActionLinkが"BIコンテンツ"タイプでない場合のみ表示されます)。

String ActionName

アクションのカタログ・オブジェクト名を指定します。

String ClassName

EJBアクションでコールされるJavaクラスを指定します。

String ClassPath

jarが格納されているJavaパスを指定します。

String AddnClassPath

指定したパスにjarがない場合、追加のクラス・パスを指定します。

ParameterDocument[] ActionParameters

ParameterDocumentオブジェクトの配列を指定します。ParameterDocumentは、単一のアクション・パラメータを定義するJavaScriptオブジェクトです。詳細は、第2.36項「ParameterDocument構造体」を参照してください。

String ActionType

アクションのタイプを指定します(たとえば、システム設定や権限によって、必ずしもすべてのタイプが使用できるわけではありません)。

WebServiceActionType
JavaActionType
OldJavaActionType
URLActionType
InvokeURLActionType
ScriptActionType
ServerScriptActionType
NavToBIActionType
NavToEBSActionType
NavToEPMActionType
WorkflowActionType
NavToCRMActionType
ADFContextEventActionType

String WebServerRegistry

アクションが起動する個々のWebサービスの詳細を指定します。

String WebService

アクションが起動する個々のWebサービスの詳細を指定します。

String WebOperation

アクションが起動する個々のWebサービスの詳細を指定します。

2.5 ActionLinks構造体

この構造体を使用して、有効なアクション・リンクを参照します。この構造体は、ValidActionLinks構造体で使用します。

表2-5に、この構造体のフィールドをリストします。

表2-5 ActionLinks構造体のフィールド

フィールド 説明

String ActionPath

ActionLinkのターゲットであるBIコンテンツへのカタログ・パスを指定します(ActionLinkが"BIコンテンツ"タイプのアクション・リンクである場合のみ表示されます)。

String Text

クリックしてアクションを起動できるようにユーザーに表示するテキストを指定します。

Action[] Action

アクションの詳細を指定します(ActionLinkが"BIコンテンツ"タイプでない場合のみ表示されます)。詳細は、第2.4項「Action構造体」を参照してください。

2.6 AnalysisExportExecutionOptions構造体

この構造体を使用して、分析をエクスポートする場合の実行オプションを指定します。この構造体は、AnalysisExportViewsサービスで使用します。

表2-6に、この構造体のフィールドをリストします。

表2-6 AnalysisExportExecutionOptions構造体のフィールド

フィールド 説明

boolean async

TRUEに設定されている場合、非同期分析エクスポートが有効です。FALSEに設定されている場合、非同期分析エクスポートが無効です。

boolean useMtom

TRUEに設定されている場合、MTOMを使用して、SOAPメッセージにより戻されたコンテンツをエンコードします。

boolean refresh

TRUEに設定されている場合、データをリフレッシュするためにサーバーが問合せを再送信します。FALSEに設定されている場合、Oracle Business Intelligence Serverはキャッシュにあるデータを使用します。

2.7 AnalysisExportResult構造体

この構造体を使用して、結果をエクスポートする場合の実行オプションを指定します。この構造体は、AnalysisExportViewsサービスで使用します。

表2-7に、この構造体のフィールドをリストします。

表2-7 AnalysisExportResult構造体のフィールド

フィールド 説明

viewData

AnalysisExportOutputFormatで指定された形式のビュー・データの返されたコンテンツを指定します。詳細は、「initiateAnalysisExport()メソッド」を参照してください。

String mimeType

返されたビュー・データのMIMEタイプを指定します。

String queryID

リクエストの問合せIDを指定します。completeAnalysisExportメソッドのパラメータとしてこれを使用します。詳細は、次を参照してください。

completeAnalysisExport

ダウンロード・リクエストのステータスを指定します。値は次のとおりです。

  • String InProgress - ダウンロードが進行中であることを指定します

  • String Error - ダウンロード・リクエストの結果がエラーであることを指定します。

  • String Done - ダウンロードが完了したことを指定します。

2.8 ArrayofGUIDS構造体

この構造体を使用して、保存した結果セットを表すGUIDのリストを指定します。この構造体は、SecurityServiceサービスで使用します。

表2-8に、この構造体のフィールドをリストします。

表2-8 ArrayofGUIDS構造体のフィールド

フィールド 説明

String[] guid

保存した結果セットを表すGUIDのリストを指定します。

2.9 AssessmentResult構造体

この構造体を使用して、戦略ツリーのノードに対する特定のQDRのアセスメントを1つのみ格納します。この構造体は、ScorecardAssessmentServiceサービスで使用します。

表2-9に、この構造体のフィールドをリストします。

表2-9 AssessmentResult構造体のフィールド

フィールド 説明

String ScorecardPath

評価されたスコアカードが格納されているフォルダへのプレゼンテーション・サービス・カタログ・パスを指定します。

Variable[] Variables

アセスメント結果が適用可能なQDRを定義するVariableオブジェクトの配列を指定します。詳細は、第2.64項の「Variable構造体のフィールド」を参照してください。

String GUID

このアセスメント結果の対象となる戦略ツリーのノードを識別するGUIDを指定します。

Enumeration Assessment

ノードまたはQDRのステータスIDを指定します。

Number Assessment

戦略ノードの正規化されたアセスメント結果を指定します。0と100の間の数値です。数値は、整数にかぎらないため、小数位も含めることができます。

String ObjectContext

戦略ノードのインスタンスを表すオブジェクト・コンテキストを指定します。

String ObjectContext

戦略ノードのインスタンスを表すオブジェクト・コンテキストを指定します。

Boolean IsAnnotated

ノードが注釈付きか(true)、否か(false)を示すフラグの値を指定します。

KPIResultColumn[] KPIResultColumns

ノードがKPIノードの場合、KPI結果を定義するKPIResultColumnオブジェクトの配列を指定します。詳細は、第2.31項「KPIResultColumn構造体」を参照してください。

Boolean IsOverridden

ノードがオーバーライドされるか(true)、否か(false)を指定します。

ValidActionLink[] ValidActionLinks

現在の評価されたステータスについてアクション・リンクを定義するリンク要素の配列を指定します。詳細は、第2.63項「ValidActionLinks構造体」を参照してください。

2.10 AuthResult構造体

この構造体を使用して、認可時の認証の詳細を指定します。この構造体は、SecurityServiceサービスで使用されています(impersonateex()メソッドおよびlogonex()メソッドの中で)。

表2-10に、この構造体のフィールドをリストします。

表2-10 AuthResult構造体のフィールド

フィールド 説明

String sessionID

セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

boolean authCompleted

TRUEに設定されている場合、認可は完了しています。FALSEに設定されている場合、認可のプロセスの最中であるため、再度logonexかimpersonatexのプロセスをコールします。

2.11 CatalogItemsFilter構造体

パスとタイムスタンプをもとにカタログ項目および変更をフィルタするために、この構造体を使用します。

表2-11に、この構造体のフィールドをリストします。

表2-11 CatalogItemsFilter構造体のフィールド

フィールド 説明

String[] items

フィルタに含めるフォルダおよびその子フォルダを指定します。この値がNULLの場合、カタログのすべてのノードが含まれます。

Calendar from

フィルタする期間を指定します。その期間中のタイムスタンプを持つ項目および変更のみがフィルタを満たします。これらフィールドのいずれかまたは両方がNULLである場合、そのフィールドに対する範囲設定がないものとされます。

Calendar to

フィルタする期間を指定します。その期間中のタイムスタンプを持つ項目および変更のみがフィルタを満たします(from <= タイムスタンプ <= to)。これらフィールドのいずれかまたは両方がNULLである場合、そのフィールドに対する範囲設定がないものとされます。

2.12 CatalogObject構造体

この構造体を使用して、単一のメソッドにおける特定のカタログ・オブジェクトのすべての情報を取得または指定します。この構造体はWebCatalogServiceサービスで使用します。

表2-12に、この構造体のフィールドをリストします。

表2-12 CatalogObject構造体のフィールド

フィールド 説明

String catalogObject

オブジェクトのXML表現を指定します。

catalogObjectBytes

カタログ・オブジェクトから返却されるコンテンツが文字列かバイトかを指定します。このフィールドで指定するものは、readObjectsメソッドによって決まります。

ItemInfo itemInfo

ItemInfo共通構造体で提供されているオブジェクトのカタログ情報を指定します。

ItemInfo構造体の詳細は、第2.21項「ItemInfo構造体」を参照してください。

ErrorInfo errorInfo

readObjectsメソッドのErrorDetails引数の指定を受けて、提供するエラー情報のレベルを指定します。

2.13 CausalLinkage構造体

この構造体を使用して、単一の因果関係を表します。この構造体は、ScorecardMetadataServiceサービスで使用します。

表2-13に、この構造体のフィールドをリストします。

表2-13 CausalLinkage構造体のフィールド

フィールド 説明

String ID

この因果関係のGUIDを指定します。

String causeNodeID

リンクの原因側にある戦略ノードまたはイニシアティブ・ノードのGUIDを指定します。

String effectNodeID

リンクの結果側にある戦略ノードまたはイニシアティブ・ノードのGUIDを指定します。

String Strength

関係の強さを指定します。第2.13.1項「Strength列挙」の値のいずれかを使用して定義します。

String Interaction

関係の比例を指定します。第2.13.2項「Interaction列挙」の静的値のいずれかを使用して定義します。

String Operation

指定したCausalLinkageを使用して実行する内容を指定します。指定可能な値は、ADD、UPDATE、DELETEのいずれかです。

2.13.1 Strength列挙

この列挙は、サポートされている様々なリンクの強さの値を表します。この列挙は、CausalLinkage構造体で使用します。

表2-14に、この列挙の値をリストします。

表2-14 Strength列挙の値

値 説明

String STRONG

強い関係を指定する場合に使用します。

String MIDDLE

普通の関係を指定する場合に使用します。

String WEAK

弱い関係を指定する場合に使用します。

2.13.2 Interaction列挙

この列挙は、サポートされている様々なリンクの強さの値を表します。この列挙は、CausalLinkage構造体で使用します。

表2-15に、この列挙の値をリストします。

表2-15 Interaction列挙の値

値 説明

String POSITIVE

正比例の関係を指定する場合に使用します。

String NEGATIVE

反比例の関係を指定する場合に使用します。

2.13.3 Operation列挙

この列挙は、操作の値を表します。この列挙は、CausalLinkage構造体で使用します。

表2-16に、この列挙の値をリストします。

表2-16 Operation列挙の値

値 説明

String ADD

適用する操作の識別に使用します。

String UPDATE

適用する操作の識別に使用します。

String DELETE

適用する操作の識別に使用します。

2.14 DimensionContext構造体

この構造体を使用して、ディメンションを取得します。この構造体は、ValidActionLinks構造体で使用します。

表2-17に、この構造体のフィールドをリストします。

表2-17 Dimension構造体のフィールド

フィールド 説明

String name

ディメンションの名前を指定します。

String value

ディメンションが固定されている値を指定します。

2.15 ErrorInfo構造体

この構造体を使用して、プレゼンテーション・カタログ・サービスのメソッドを呼び出す際のエラー情報を取得します。この構造体は、WebCatalogServiceサービスで使用します。

表2-18に、この構造体のフィールドをリストします。

表2-18 ErrorInfo構造体のフィールド

フィールド 説明

String code

表示するエラー・コードを指定します。

String context

エラーが起きたサービスおよびメソッドを指定します。

String details

エラーの詳細を指定します。

String message

可読形式のエラーの説明を指定します。

2.16 FavoriteItem構造体

この構造体を使用して、プレゼンテーション・カタログ・サービスのメソッドを呼び出す際にお気に入り項目の情報を取得します。この構造体は、UserPersonalizationServiceサービスで使用します。

表2-20に、この構造体のフィールドをリストします。

表2-19 FavoriteItem構造体のフィールド

フィールド 説明

String name

お気に入りまたはカテゴリの名前を指定します。

String path

お気に入り項目の場合はカタログ・オブジェクトのパスを、カテゴリ・オブジェクトの場合はお気に入りマネージャのカテゴリ・パスを指定します。

UnsignedShort type

FavoriteItemオブジェクトに格納されるタイプを指定します。

お気に入り項目 = 0

カテゴリ・オブジェクト = 1

ItemInfo itemInfo

ItemInfo共通構造体で提供されているオブジェクトのカタログ情報を指定します。

typeが0の場合、有効であり、実際のカテゴリ・オブジェクトが格納されます。typeが1の場合、無効です。

ItemInfo構造体の詳細は、第2.21項「ItemInfo構造体」を参照してください。

FavoriteItem favoriteItem

typeが1の場合はサブ項目のリスト、それ以外の場合は無効な値です。

2.17 ForgetAccount構造体

この構造体を使用して、カタログから削除されるアカウントの名前およびタイプを保持します。この構造体は、SecurityServiceサービスで使用します。

表2-20に、この構造体のフィールドをリストします。

表2-20 ForgetAccount構造体のフィールド

フィールド 説明

String accountName

アカウント名を指定します。

int accountType

アカウント・タイプを指定します。

2.18 ForgetAccountResult構造体

この構造体を使用して、各アカウントのアカウントの削除操作のステータスを保持します。この構造体は、SecurityServiceサービスで使用します。

表2-21に、この構造体のフィールドをリストします。

表2-21 ForgetAccountResult構造体のフィールド

フィールド 説明

String accountName

アカウントの名前を指定します。

int accountType

アカウントのタイプを指定します

int Status

アカウントの全削除操作のステータスを指定します。ステータス値は次のとおりです。

  • 0- 正常終了

  • 1- エラー

2.19 ForgetAccountsStatus構造体

この構造体を使用して、アカウントの削除操作の全体的なステータスを保持します。この構造体は、SecurityServiceサービスで使用します。

表2-22に、この構造体のフィールドをリストします。

表2-22 ForgetAccountsStatus構造体のフィールド

フィールド 説明

int Status

アカウントの全削除操作のステータスを指定します。ステータス値は次のとおりです。

  • 0- 正常終了

  • 1- エラー

ForgetAccountResult[] accountsResult

各アカウントに対する成功または失敗のメッセージとともにアカウント名およびアカウント・タイプを指定します。

2.20 GetSubItemsParams構造体

この構造体を使用して、getSubItemsメソッドで使用されているオプションのパラメータを保持します。この構造体は、WebCatalogServiceサービスで使用します。

表2-23に、この構造体のフィールドをリストします。

表2-23 GetSubItemsParams構造体のフィールド

フィールド 説明

GetSubItemsFilter filter

内部でのみ使用されます。

boolean includeACL

TRUEに設定されている場合、結果のItemInfo構造体にACL情報が含まれます。

int withPermissionおよびint withPermissionMask

結果のアイテム・コレクションをアクセス・レベルでフィルタすることを指定します。次の式でtrueとなるアイテムのみが結果に含まれます。

(itemPermission & withPermissionMask) = (withPermission & withPermissionMask)

itemPermissionは、現在のカタログ項目におけるパーミッション・フラグの組合せです。

int withAttributesおよび

int withAttributesMask

結果のアイテム・コレクションを属性フラグでフィルタすることを指定します。次の式でtrueとなるアイテムのみが結果に含まれます。

(itemAttributes & withAttributesMask) = (withAttributes & withAttributesMask)

itemAttributesは、現在のカタログ項目における属性フラグの組合せです。

2.21 ItemInfo構造体

この構造体を使用して、オブジェクトのカタログ情報を保持します。この構造体は、WebCatalogServiceサービスおよびScorecardMetadataServiceサービスで使用します。

表2-24に、この構造体のフィールドをリストします。

表2-24 ItemInfo構造体のフィールド

フィールド 説明

String path

カタログ内のオブジェクトへのパスを指定します。例: /users/jchan/analyses/。

ItemInfoType type

型を示す文字列を指定します。有効な値は次のとおりです。

  • Folder

  • Link

  • Missing

  • NoAccess

  • Object

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」に設定されている場合、このフィールドはオブジェクトのターゲット・パスを指定します。

2.22 Job構造体

この構造体を使用して、ジョブ情報を保持します。この構造体は、SchedulerServiceサービスで使用します。

表2-25に、この構造体のフィールドをリストします。

詳細は、『Oracle Fusion Middleware Oracle Business Intelligence Enterprise Editionジョブ・スケジューリング・ガイド』のOracle BIスケジューラのジョブ・マネージャ・メニューに関する項を参照してください。

いくつかのプロパティはオプションで、ジョブに関連していなければ存在しない場合があります(たとえば、ジョブ・トリガーのタイプによります)。

表2-25 Job構造体のフィールド

フィールド 説明

ジョブ参照

インスタンスに関連付けられているジョブの一意の参照。

名前

短くてわかりやすいジョブ名。

説明

エンド・ユーザーに対するそのアクションに関するジョブの説明のテキスト。

ユーザーID(作成者ID)

ジョブを作成したユーザーのID。

スクリプト・タイプ

ジョブの実行で使用したスクリプトのタイプ(VBScript、JScript、JavaまたはNQCmd)。

スクリプトID (エージェントのパス)

ジョブを実行するスクリプトへのパス。

WebCatalogService APIをコールして、エージェント定義を戻す場合に使用します。詳細は、第3.10.8.5項「例 - WebCatalogServiceのすべてのエージェントの検索および表示」を参照してください。

最大実行時間(ミリ秒)

ジョブの実行が継続する最大時間(ミリ秒)。

実行インスタンス件数

現在実行中のこのジョブのインスタンスの総数。

最大同時インスタンス

同時に実行するインスタンスの最大数。同時インスタンスの数を制限しない場合は、この値をゼロに設定します。

タイム・ゾーン

ジョブの実行で使用するタイムゾーン。このフィールドが指定されない場合、タイムゾーンはスケジューラのローカル・タイムゾーンであるとみなされます。

最終実行日時

最後にジョブの実行を開始した日付および時刻。

次回実行日時

次にジョブの実行を開始する日付および時刻。

開始日

最初の繰返し区間を実行する日付。

開始時間

ジョブが開始した時刻。

終了日

最初の繰返し区間を終了する日付。

終了時間

ジョブが完了した時刻。

間隔

繰返し区間中に次のジョブを実行するまでの分単位の時間。

無効

トリガーが期限切れになるとジョブ・スクリプトが実行されないように指定します。

完了時にジョブを削除

ジョブの終了後、ジョブを削除するかどうか指定します。

存在しない場合に実行

ジョブの実行中、スケジュールされた時間にエラーが発生した場合、ジョブを実行するかどうか指定します。

ジョブ・トリガー(詳細はタイプ別)

ジョブおよびジョブの詳細をトリガーするかどうか指定します。詳細はジョブ・タイプによって異なります。

ジョブ・トリガーは、次のいずれかの値です。

RunNever、RunOnce、RunDaily、RunWeekly、RunMonthlyByDate、RunMonthlyByDayOfWeek。

2.23 JobFilter構造体

この構造体を使用して、ジョブ一覧をフィルタします。この構造体は、SchedulerServiceサービスで使用します。

表2-26に、この構造体のフィールドをリストします。

表2-26 JobFilter構造体のフィールド

フィールド 説明

ユーザーID(作成者)のリスト

(オプション)ユーザーIDが指定されていない場合、すべてのJobReferencesが戻されます。

2.24 JobInstance構造体

この構造体を使用して、実行中、取消済または完了済のジョブに対応するジョブ・インスタンスに関する情報を保持します。この構造体は、SchedulerServiceサービスで使用します。

表2-27に、この構造体のフィールドをリストします。

詳細は、『Oracle Fusion Middleware Oracle Business Intelligence Enterprise Editionジョブ・スケジューリング・ガイド』のOracle BIスケジューラのジョブ・マネージャ・メニューに関する項を参照してください。

表2-27 JobInstance構造体のフィールド

フィールド 説明

ジョブ参照

ジョブ・インスタンスに関連付けられているジョブの一意の参照。

ジョブ・インスタンス参照

ジョブ・インスタンスの一意の参照。

ジョブ・インスタンス・ステータス

ジョブ・インスタンスの現在のステータス。有効な値は次のとおりです。

  • 完了

  • 実行中

  • 失敗

  • 取消済

  • タイムアウト

  • 警告

開始日時

スケジューラがジョブ・インスタンスを開始した日時です。

終了日時

ジョブ・スケジューラがジョブ・インスタンスを完了した日時です。

正常な配信

このジョブ・インスタンスによる成功した配信の回数。

エラー・メッセージ

ジョブ・インスタンスの実行に関するエラー・メッセージ、警告または一般的なメッセージ。

2.25 JobInstanceFilter構造体

この構造体を使用して、ジョブ・インスタンス一覧をフィルタします。この構造体は、SchedulerServiceサービスで使用します。

表2-28に、この構造体のフィールドをリストします。

表2-28 JobInstanceFilter構造体のフィールド

フィールド 説明

「JobReference(所有者)」リスト

(必須)ジョブ参照が指定されていない場合、すべてのJobReferencesが戻されます。

ジョブ・インスタンス・ステータス

(オプション)

ジョブ・インスタンスの現在のステータス。有効な値は次のとおりです。

  • 完了

  • 実行中

  • 失敗

  • 取消済

  • タイムアウト

  • 警告

2.26 JobInstanceStatusの列挙

この列挙を使用して、ジョブ・インスタンス・ステータスを定義します。この列挙は、SchedulerServiceサービスで使用します。

表2-29に、この列挙の値をリストします。

表2-29 JobInstanceStatusの列挙の値

値 説明

ジョブ・インスタンスの状態

ジョブ・インスタンスの状態は、次の列挙を使用して表します。有効な状態は次のとおりです。

  • 完了

  • 実行中

  • 失敗

  • 取消済

  • タイムアウト

  • 警告

2.27 JobReferenceAndInstanceReferences構造体

この構造体を使用して、ジョブおよび関連付けられたインスタンスをグループ化します。ジョブ参照の一覧が、ジョブ・インスタンスの一覧の選択条件として指定された場合、これは重要です。この構造体は、SchedulerServiceサービスで使用します。

表2-30に、この構造体のフィールドをリストします。

詳細は、『Oracle Fusion Middleware Oracle Business Intelligence Enterprise Editionジョブ・スケジューリング・ガイド』のOracle BIスケジューラのジョブ・マネージャ・メニューに関する項を参照してください。

表2-30 JobReferenceAndInstanceReferences構造体のフィールド

フィールド 説明

ジョブ参照

(必須)インスタンスに関連付けられているジョブの一意の参照。

ジョブ・インスタンス参照のリスト

(必須)ジョブ・インスタンスの一覧。

2.28 KPIColumnNameの列挙

この列挙では、KPIColumnNameフィールドの有効な値のリストを指定します。この列挙は、KPIAssessmentServiceサービスで使用し、KPIResultColumn構造体によって使用されます。

表2-31に、この列挙の値をリストします。

表2-31 KPIColumnName列挙の値

値 説明

String NAME

列名。

String STATUS

ステータスの列名。

String ACTUAL_VALUE

実際の値の列名。

String TARGET_VALUE

ターゲット値の列名。

String VARIANCE

差分の列名。

String VARIANCE_PERCENT

差分率の列名。

String CHANGE

変更の列名。

String CHANGE_PERCENT

変更率の列名。

String TREND

トレンドの列名。

String OBJECT_CONTEXT

オブジェクト・コンテキストの列名。

String STATUS_INFO

ステータス情報の列名。

String OWNER

所有者の列名。

String DIMENSION_CONTEXT

ディメンション・コンテキストの列名。

String CUSTOM_COLUMN1

カスタム列名。

String CUSTOM_COLUMN2

カスタム列名。

String CUSTOM_COLUMN5

カスタム列名。

2.29 KPIDimensionPinning構造体

この構造体を使用して、アセスメントのリクエスト時にKPIのQDRを定義する際に使用する個々のディメンション固定のメタデータを格納します。この構造体は、KPIRequest構造体で使用します。

表2-32に、この構造体のフィールドをリストします。

表2-32 KPIDimensionPinning構造体のフィールド

フィールド 説明

String DimensionID

特定の値に固定するディメンションのIDを指定します。

String Value

指定したディメンションの固定先となる値を指定します。

String VariableType

指定したディメンションの固定に使用する値が格納されている変数のタイプを指定します。

String VariableName

(オプション)指定したディメンションの固定に使用する値が格納されている変数の名前を指定します(VariableTypeがNONEの場合はnullのままにできます)。

String LevelID

(オプション)指定した値が属するディメンション・レベルのIDを指定します(ディメンションがLevelまたはValue Hierarchyでない場合はnullのままにできます)。

2.30 KPIRequest構造体

この構造体を使用して、指定したKPIのアセスメント値のリクエストに必要な情報を格納します。この構造体は、KPIAssessmentServiceサービスで使用します。

表2-33に、この構造体のフィールドをリストします。

表2-33 KPIRequest構造体のフィールド

フィールド 説明

String Path

KPIのプレゼンテーション・サービス・カタログ・パスを指定します。

KPIDimensionPinning[] KPIDimensionPinnings

問合せに適用されるフィルタを定義するディメンション固定の配列を指定します。詳細は、第2.29項の「KPIDimensionPinning構造体のフィールド」を参照してください。

2.31 KPIResultColumn構造体

この構造体を使用して、戦略ツリーのノードに対する特定のQDRのアセスメントを1つのみ格納します。この構造体は、ScorecardAssessmentServiceサービスで使用します。

表2-34に、この構造体のフィールドをリストします。

表2-34 KPIResultColumn構造体のフィールド

フィールド 説明

String Name

セルが属する列名を指定します。詳細は、第2.28項の「KPIColumnName列挙の値」を参照してください。

String Type

セルのデータ型を指定します。

String Value

セルの値を指定します。

String FormattedValue

書式設定された値を指定します。

String ObjectContext

このセルを戻した問合せに適用されたQDRを指定します。

Boolean IsAnnotated

セルが注釈付きとなっていたか(true)、否か(false)を指定します。

2.32 MRUItem構造体

この構造体を使用して、プレゼンテーション・カタログ・サービスのメソッドを呼び出す際に最近使用した(MRU)項目の情報を取得します。この構造体は、UserPersonalizationServiceサービスで使用します。

表2-35に、この構造体のフィールドをリストします。

表2-35 MRUItem構造体のフィールド

フィールド 説明

String catalogPath

最近使用したカタログ・オブジェクトのカタログ・パスを指定します。

Boolean isFavorite

MRU項目がお気に入り項目でもあるかどうかを指定します。

ItemInfo itemInfo

ItemInfo共通構造体で提供されているオブジェクトのカタログ情報を指定します。

ItemInfo構造体の詳細は、第2.21項「ItemInfo構造体」を参照してください。

2.33 NameValuePair構造体

この構造体を使用して、名前付きプロパティを指定します(COLOR=REDなど)。この構造体は、WebCatalogServiceサービスで使用します。

表2-36に、この構造体のフィールドをリストします。

表2-36 NameValuePair構造体のフィールド

フィールド 説明

String name

プロパティの名前を示す文字列を指定します(COLORなど)。

String value

値を示す文字列を指定します(REDなど)。

2.34 NodeInfo構造体

この構造体を使用して、単一ノードを識別する情報を格納します。この構造体は、ScorecardAssessmentServiceサービスで使用します。

表2-37に、この構造体のフィールドをリストします。

表2-37 NodeInfo構造体のフィールド

フィールド 説明

String NodeType

ノードのタイプを指定します。詳細は、第2.34.1項「NodeTypes列挙」を参照してください。

String NodeID

ノードのGUIDを指定します。

2.34.1 NodeTypes列挙

この列挙は、様々なタイプのノードの値を定義します。この列挙は、NodeInfo構造体で使用します。

表2-38に、この列挙の値をリストします。

表2-38 NodeTypes列挙の値

値 説明

String STRATEGY_NODE

ノードが戦略ツリーに属することを指定します。

String INITIATIVE_NODE

ノードがイニシアティブ・ツリーに属することを指定します。

2.35 PathMap構造体

この構造体を使用して、出力メソッドに含まれているデータのコピー先を指定します。

表2-39に、この構造体のフィールドをリストします。

表2-39 PathMap構造体のフィールド

フィールド 説明

PathMapEntry pathMapEntries

出力メソッドに含まれているデータのコピー先を指定します。

2.36 ParameterDocument構造体

この構造体を使用して、Actionフレームワークで使用されているように、パラメータをモデル化します。この構造体は、Action構造体で使用します。

表2-40に、この構造体のフィールドをリストします。

表2-40 ParameterDocument構造体のフィールド

フィールド 説明

String Name

パラメータの名前(タイトル)を指定します。

String Prompt

このパラメータのユーザーに表示されるプロンプトを指定します。

String Description

パラメータ・ドキュメントの説明(ツールチップとして表示される場合もある)を指定します。

String ParameterType

次のいずれかのパラメータのデータ型を指定します。

string
integer
long
float
double
short
decimal
boolean
byte
date
dateTime
time
document

Array[] ParameterValues

パラメータ値オブジェクトの配列を指定します。これは、空の配列にはできず、1つ以上のパラメータ値を持つ配列です(MultiValuesAllowedを参照)。

詳細は、第2.37項「ParameterValue構造体」を参照してください。

String ValueFixed

パラメータ値がこのパラメータに対して固定である(オーバーライドできない)かどうかを指定します。値は'true'または'false'です。

String Order

所有元のドキュメントでパラメータを保持する特定の順序を指定します。

String MultiValuesAllowed

パラメータが複数の値をサポートしているかどうかを指定します。値は'true'または'false'です。

String Mandatory

値のユーザー入力が必須かどうかを指定します。値は'true'または'false'です。

2.37 ParameterValue構造体

この構造体を使用して、ParameterDocument構造体で使用されているように、パラメータ値をモデル化します。ParameterDocumentはこれらのゼロ以上の配列を所有します。この構造体は、ParameterDocument構造体で使用します。

表2-41に、この構造体のフィールドをリストします。

表2-41 ParameterValue構造体のフィールド

フィールド 説明

String Value

値を指定します。デフォルトは空の文字列です。

String ValueMapping

次のいずれかのパラメータ値のタイプを指定します。

value
session
repository
presentation
colrequest
request
column
catalog
date
time
dateTime

String AltDisplayValue

実際の値がコードである場合の代替表示値を指定します。

2.38 Prompt構造体

これらの構造体を使用して、「ReportEditingServiceサービス」の「getPromptElementsメソッド」でプロンプトを指定します。

この項には、次の構造が含まれます。

2.38.1 PromptsObjectModel構造体

この構造体を使用して、プロンプトのオブジェクト・モデルを指定します。このプロンプト構造体は、「getPromptElementsメソッド」で使用します。

表2-42に、この構造体のフィールドをリストします。

表2-42 PromptsObjectModel構造体のフィールド

フィールド 説明

String name

プロンプトの名前を指定します。

String description

プロンプトの説明を指定します。

String scope

プロンプトのスコープを指定します。

String subjectArea

プロンプトのサブジェクト・エリアを指定します。

String layout

プロンプトのレイアウトを指定します。

PromptCollectionRunTimeInfo runTimeInfo

プロンプト・コレクションの実行時間情報を指定します。詳細は、「PromptCollectionRunTimeInfo構造体」を参照してください。

PromptStepObjectModel promptStepObj

プロンプト状態のオブジェクト・モデルを指定します。詳細は、「PromptStepObjectModel構造体」を参照してください。

2.38.2 PromptCollectionRunTimeInfo構造体

この構造体を使用して、プロンプト・コレクションの実行時間情報を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-43に、この構造体のフィールドをリストします。

表2-43 PromptCollectionRunTimeInfo構造体のフィールド

フィールド 説明

String collectionID

プロンプトのコレクションIDを指定します。

String viewStatePath

プロンプトのビュー状態パスを指定します。

Int currentStep

プロンプトの現在の手順を指定します。

Boolean reloadInline

プロンプトをインラインで再ロードするか(true)、否か(false)を指定します。

Boolean supportAutoComplete

プロンプトを自動的に完了するか(true)、否か(false)を指定します。

Boolean showReturnLink

プロンプトでReturnリンクを表示するか(true)、否か(false)を指定します。

String currentAction

プロンプトの現在のアクションを指定します。

2.38.3 PromptStepObjectModel構造体

この構造体を使用して、プロンプトの手順オブジェクト・モデルを指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-44に、この構造体のフィールドをリストします。

表2-44 PromptStepObjectModel構造体のフィールド

フィールド 説明

String title

プロンプトのタイトルを指定します。

String instruction

プロンプトの指示を指定します。

String buttonsPosition

プロンプトのボタンの位置を指定します。

String labelPosition

プロンプトのラベルの位置を指定します。

String wrapLabelText

プロンプトのラップ・ラベル・テキストを指定します。

String customWidthUsage

プロンプトのカスタム幅の使用方法を指定します。

String customWidthWidth

プロンプトのカスタム幅を指定します。

String setWidthToAllPrompts

幅をすべてのプロンプトに適用するかどうかを指定します。

Boolean autoApplyPrompt

プロンプトを自動的に適用するか(true)、否か(false)を指定します。

Boolean showResetButton

プロンプトが「リセット」ボタンを表示するか(true)、否か(false)を指定します。

PromptStepRunTimeInfo runTimeInfo (nillable)

プロンプト手順の実行時間情報を指定します。nullを指定できる。

IndividualPromptObjectModel[] promptObj

プロンプト・オブジェクト・モデルの配列を指定します。詳細は、「IndividualPromptObjectModel構造」を参照してください。

2.38.4 PromptStepRunTimeInfo構造体

この構造体を使用して、プロンプトの手順実行時間情報を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-45に、この構造体のフィールドをリストします。

表2-45 PromptStepRunTimeInfo構造体のフィールド

フィールド 説明

Boolean applyToAllSteps

プロンプトをすべての手順に適用するか(true)、否か(false)を指定します。

Boolean autoApplyPrompt

プロンプトを自動的に適用するか(true)、否か(false)を指定します。

Boolean showResetButton

プロンプトで「リセット」ボタンを表示するか(true)、否か(false)を指定します。

Int remaininglRequiredPromptsOnSubsequentSteps

後続の手順に必要なプロンプトを指定します。

Int firstPromptStartIndex

最初のプロンプトの索引を指定します。

2.38.5 IndividualPromptObjectModel構造体

この構造体を使用して、プロンプトのプロンプト・オブジェクト・モデルを指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-46に、この構造体のフィールドをリストします。

表2-46 IndividualPromptObjectModel構造体のフィールド

フィールド 説明

String label

プロンプトのラベルを指定します。

String description

プロンプトの説明を指定します。

String type

プロンプトのタイプを指定します。

String subjectArea

プロンプトのサブジェクト・エリアを指定します。

Boolean placedOnNewColumn

プロンプトが新しい列に適用されるか(true)、否か(false)を指定します。

Boolean required

プロンプトが必要か(true)、否か(false)を指定します。

String formulaExprString

プロンプトの算式を指定します。

String promptUIControlType

プロンプトのユーザー・インタフェース・コントロール・タイプを指定します。

String promptOperator

プロンプト演算子を指定します。

String customWidthUsage

プロンプトのカスタム幅の使用方法を指定します。

String customWidthWidth

プロンプトのカスタム幅を指定します。

String setPromptVariableType

プロンプトのプロンプト変数タイプを指定します。

String setVariableName

プロンプトの変数名を指定します。

IndividualPromptRunTimeInfoLimitedByInfo limitedByInfo

プロンプトの制限情報を指定します。詳細は、「IndividualPromptRunTimeInfoLimitedByInfo構造体」を参照してください。

IndividualPromptRunTimeInfo runTimeInfo

プロンプトの実行時間情報を指定します。詳細は、「IndividualPromptRunTimeInfo構造体」を参照してください。

2.38.6 IndividualPromptRunTimeInfoLimitedByInfo構造体

この構造体を使用して、プロンプトの実行時間制限情報を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-47に、この構造体のフィールドをリストします。

表2-47 IndividualPromptRunTimeInfoLimitedByInfo構造体のフィールド

フィールド 説明

String limitedByType

プロンプトがnone、allPromptsおよびspecificPromptsなどの他のプロンプト・タイプで制限されるかどうかを指定します。

Boolean isLimitedByNotApplied

制約がプロンプトに適用されるか(true)、否か(false)を指定します。

IndividualPromptRunTimeInfoLimitedByPromptRefGroups specificPrompts

このプロンプトを制限するプロンプトを指定します。

2.38.7 IndividualPromptRunTimeInfo構造体

この構造体を使用して、プロンプトの実行時間情報を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-48に、この構造体のフィールドをリストします。

表2-48 IndividualPromptRunTimeInfo構造体のフィールド

フィールド 説明

Int promptID

プロンプトIDを指定します。

Boolean allowUserTypeValues

ユーザーにプロンプトの値の入力を許可するか(true)、否か(false)を指定します。

Boolean allowAutoComplete

プロンプトを自動的に完了するか(true)、否か(false)を指定します。

Boolean multiSelect

プロンプトで複数の選択を許可するか(true)、否か(false)を指定します。

String showSearch

プロンプトの検索を表示することを指定します。

IndividualPromptRunTimeInfoDataType dataType

プロンプトのデータ型情報を指定します。詳細は、「IndividualPromptRunTimeInfoDataType構造体」を参照してください。

IndividualPromptRunTimeInfoCurrentValues currentValues

プロンプトの現在値を指定します。詳細は、「IndividualPromptRunTimeInfoCurrentValues構造体」を参照してください。

IndividualPromptRunTimeInfoAvailableOptions availableOptions

プロンプトに使用できるオプションを指定します。詳細は、「IndividualPromptRunTimeInfoAvailableOptions構造体」を参照してください。

IndividualPromptRunTimeInfoAdditionalAttributes attributes

プロンプトの追加属性を指定します。詳細は、「IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体」を参照してください。

2.38.8 IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo構造体

この構造体を使用して、プロンプトの表示列の階層レベルのSQL情報を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-49に、この構造体のフィールドをリストします。

表2-49 IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo構造体のフィールド

フィールド 説明

String displayFormula

プロンプトの表示式を指定します。

String sqlFormula

プロンプトのSQL式を指定します。

String dataType

プロンプトのデータ型を指定します。

String category

プロンプトのカテゴリを指定します。

String primaryType

プロンプトのプライマリ・タイプを指定します。

Boolean nullable

プロンプトでNull値可能値を表示するか(true)、否か(false)を指定します。

Boolean isMeasure

TRUEに設定されている場合、プロンプトはメジャーを表示します。FALSEに設定されている場合、プロンプトは属性を表示します。

String aggType

プロンプトの集計タイプを指定します。

String aggRule

プロンプトの集計ルールを指定します。

2.38.9 IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo構造体

この構造体を使用して、階層列に基づいてプロンプトのレベル情報を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-50に、この構造体のフィールドをリストします。

表2-50 IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo構造体のフィールド

フィールド 説明

String levelID

プロンプトのレベルIDを指定します。

String displayName

プロンプトの表示名を指定します。

String displayFormula

プロンプトの表示式を指定します。

String sqlFormula

プロンプトのSQL式を指定します。

Boolean isDoubleColumn

プロンプトで二重列を表示するか(true)、否か(false)を指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo keyColumnInfo

プロンプト列が階層レベルである場合にプロンプトのキー列の階層レベルのSQL情報を指定します。詳細は、「IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo構造体」を参照してください。

IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo displayColumnInfo

プロンプト列が階層レベルである場合にプロンプトの表示列の階層レベルのSQL情報を指定します。詳細は、「IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo構造体」を参照してください。

2.38.10 IndividualPromptRunTimeInfoDataTypeHierarchyLevels構造体

この構造体を使用して、階層列に基づいてプロンプトのレベルを指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-51に、この構造体のフィールドをリストします。

表2-51 IndividualPromptRunTimeInfoDataTypeHierarchyLevels構造体のフィールド

フィールド 説明

IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo [] levelInfo

階層列に基づいてプロンプトのレベル情報の配列を指定します。詳細は、「IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo構造体」を参照してください。

2.38.11 IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels構造体

この構造体を使用して、階層列に基づいてプロンプトのメタデータ/式情報を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-52に、この構造体のフィールドをリストします。

表2-52 IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels構造体のフィールド

フィールド 説明

String subjectArea

プロンプトのサブジェクト・エリアを指定します。

String dimensionID

プロンプトのディメンションを指定します。

String tableName

プロンプトの表名を指定します。

String hierarchyID

プロンプトの階層IDを指定します。

String displayName

プロンプトの表示名を指定します。

String tableDisplayName

プロンプトの表の表示名を指定します。

String hierarchyDisplayName

プロンプトの階層表示名を指定します。

String sqlFormulaIn2Parts

プロンプトの2つの部分のSQL式を指定します。

String sqlFormulaDisplaySubjectAreaPart

SQL式のサブジェクト・エリア部分を指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyLevelsレベル

階層列に基づいてプロンプトのレベルを指定します。詳細は、「IndividualPromptRunTimeInfoDataTypeHierarchyLevels構造体」を参照してください。

2.38.12 IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体

この構造体を使用して、階層列に基づいてプロンプトの階層情報を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-53に、この構造体のフィールドをリストします。

表2-53 IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体のフィールド

フィールド 説明

String hierarchyID

プロンプトの階層IDを指定します。

String dimensionID

プロンプトのディメンションIDを指定します。

String tableName

プロンプトの表名を指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels formulaLevels

階層列に基づいてプロンプトのメタデータ/式情報を指定します。詳細は、「IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels構造体」を参照してください。

2.38.13 IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo構造体

この構造体を使用して、二重列に基づいてプロンプトの情報を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-54に、この構造体のフィールドをリストします。

表2-54 IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo構造体のフィールド

フィールド 説明

String codeColumnFormula

プロンプトのコード列式を指定します。

String codeColumnCategory

プロンプトのコード列カテゴリを指定します。

String codeColumnPrimaryType

プロンプトの列プライマリ・タイプのコードを指定します。

String codeColumnDBPrimaryType

プロンプトのデータベース・プライマリ・タイプのコードを指定します。

Boolean enableDoubleColumnInput

プロンプトで二重列の入力を有効にするか(true)、否か(false)を指定します。

String codeColumnLabel (nillable)

プロンプトのコード列のラベルを指定します。

Boolean selectedByCodeValue

プロンプト入力がコード値であるか(true)、否か(false)を指定します。

2.38.14 IndividualPromptRunTimeInfoDataType構造体

この構造体を使用して、プロンプトのデータ型情報を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-55に、この構造体のフィールドをリストします。

表2-55 IndividualPromptRunTimeInfoDataType構造体のフィールド

フィールド 説明

String subjectArea

プロンプトのサブジェクト・エリアを指定します。

String displayColumnFormula

プロンプトの列式を指定します。

String displayColumnCategory

プロンプトの列カテゴリを指定します。

String displayColumnPrimaryType

プロンプトの列プライマリ・タイプを指定します。

String displayColumnDBPrimaryType

プロンプトの列データベース・プライマリ・タイプを指定します。

Boolean isMeasureColumn

TRUEに設定されている場合、レポート列はメジャーです。FALSEに設定されている場合、レポート列は属性です。

String displayTimeZone

プロンプトのタイム・ゾーンを指定します。

Int dataTimeZoneOffset

プロンプトのデータ・タイム・ゾーン・オフセットを指定します。

Int displayToDataOffset

プロンプトのデータ・オフセットを指定します。

String promptSourceDataType

プロンプト表示列のソース・データ型を指定します。

Boolean isHierarchy

プロンプト列が階層列であるか(true)、否か(false)を指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyInfo hierarchyInfo (nillable)

階層列に基づいてプロンプトの階層情報を指定します。nullを指定することができます。詳細は、「IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体」を参照してください。

Boolean isDoubleColumnInput

プロンプト入力が二重列であるか(true)、否か(false)を指定します。

IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo codeColumnInfo (nillable)

二重列に基づいてプロンプトのコード列情報を指定します。nullを指定することができます。詳細は、「IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo構造体」を参照してください。

2.38.15 IndividualPromptRunTimeInfoSingleValueType構造体

この構造体を使用して、プロンプトに1つの値を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-56に、この構造体のフィールドをリストします。

表2-56 IndividualPromptRunTimeInfoSingleValueType構造体のフィールド

フィールド 説明

String eType

構造体の値のタイプを指定します。たとえば、SQL、customGroup、hierarchyLevelsなどです。

String caption

プロンプトのキャプションを指定します。

String codeValue

プロンプトのコード値を指定します。

2.38.16 IndividualPromptRunTimeInfoValuesType構造体

この構造体を使用して、プロンプトで使用されるすべての値を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-57に、この構造体のフィールドをリストします。

表2-57 individualPromptRunTimeInfoValuesType構造体のフィールド

フィールド 説明

IndividualPromptRunTimeInfoSingleValueType[] value

プロンプトの単一値の配列を指定します。詳細は、「IndividualPromptRunTimeInfoSingleValueType構造体」を参照してください。

2.38.17 IndividualPromptRunTimeInfoCurrentValues構造体

この構造体を使用して、プロンプトの現在の値を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-58に、この構造体のフィールドをリストします。

表2-58 IndividualPromptRunTimeInfoCurrentValues構造体のフィールド

フィールド 説明

String currentOperator

プロンプトの現在の演算子を指定します。

Boolean emptyAsAllChoices

空のプロンプトのデフォルト値をすべての選択にするか(true)、否か(false)を指定します。

IndividualPromptRunTimeInfoValuesType values

プロンプトの値を指定します。詳細は、「IndividualPromptRunTimeInfoValuesType構造体」を参照してください。

2.38.18 IndividualPromptRunTimeInfoAvailableOptions構造体

この構造体を使用して、プロンプトの使用可能なオプションを指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-59に、この構造体のフィールドをリストします。

表2-59 IndividualPromptRunTimeInfoAvailableOptions構造体のフィールド

フィールド 説明

Int numOptionsPerPage

ページごとのオプション数を指定します。

Int currentPageInOptions

現行のページ数を指定します。

Boolean moreOptions

プロンプトを追加オプションで構成するか(true)、否か(false)を指定します。

Boolean includeAllChoices

プロンプトにすべての選択を含むか(true)、否か(false)を指定します。

Boolean needToPopulateDropDown

プロンプトがドロップ・ダウンの移入を要求するか(true)、否か(false)を指定します。

String valueTablePromptSourceType

プロンプトのソース・タイプを指定します。

String sql

プロンプトのSQLを指定します。

String runTimeCodeAndDisplayValueFormatStr

プロンプトの値の書式文字列を指定します。

String filterXmlString (nillable)

プロンプトのXMLフィルタを指定します。

IndividualPromptRunTimeInfoValuesType groupPaths (nillable)

プロンプトで使用されるグループの値を指定します。nullを指定することができます。詳細は、「IndividualPromptRunTimeInfoValuesType構造体」を参照してください。

IndividualPromptRunTimeInfoValuesType populatedOptions (nillable)

プロンプトで使用される移入済の値を指定します。nullを指定することができます。詳細は、「IndividualPromptRunTimeInfoValuesType構造体」を参照してください。

2.38.19 IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体

この構造体を使用して、プロンプトの追加属性を指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-60に、この構造体のフィールドをリストします。

表2-60 IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体のフィールド

フィールド 説明

Int opMinNumValues

プロンプト内の値の最小数を指定します。

Int opMaxNumValues

プロンプト内の値の最大数を指定します。

2.38.20 IndividualPromptRunTimeInfoLimitedByPromptReference構造体

この構造体を使用して、このプロンプトを制限するプロンプトを指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-61に、この構造体のフィールドをリストします。

表2-61 IndividualPromptRunTimeInfoLimitedByPromptReference構造体のフィールド

フィールド 説明

Int promptID

プロンプトの識別子を指定します。

String formulaExprString

プロンプトの算式を指定します。

2.38.21 IndividualPromptRunTimeInfoLimitedByPromptRefGroups構造体

この構造体を使用して、このプロンプトのグループを制限するプロンプトを指定します。このプロンプトは、「getPromptElementsメソッド」で使用します。

表2-62に、この構造体のフィールドをリストします。

表2-62 IndividualPromptRunTimeInfoLimitedByPromptRefGroups構造体のフィールド

フィールド 説明

IndividualPromptRunTimeInfoLimitedByPromptReference[] limitByPrompt

このプロンプトを制限するプロンプトの配列を指定します。詳細は、「IndividualPromptRunTimeInfoLimitedByPromptReference構造体」を参照してください。

2.39 Privilege構造体

この構造体を使用して、グローバル権限を表します。Oracle BI EEでは、「権限の管理」画面を使用してこれらの権限を構成します。この構造体は、SecurityServiceサービスで使用します。

表2-63に、この構造体のフィールドをリストします。

表2-63 Privilege構造体のフィールド

フィールド 説明

String name

権限の名前を指定します。

String description

権限の説明を指定します。

2.40 PurgeJobInstancesFilter構造体

ジョブ・インスタンスをパージする場合にこの構造体を使用します。この構造体は、SchedulerServiceサービスで使用します。

表2-64に、この構造体のフィールドをリストします。2つのプロパティのいずれか1つを選択します。

表2-64 PurgeJobInstancesFilter構造体のフィールド

フィールド 説明

「JobReference」リスト

(オプション)ジョブ参照が指定されていない場合、すべてのJobReferencesが戻されます。

JobInstanceStatus

(オプション)

ジョブ・インスタンスの現在のステータス。有効な値は次のとおりです。

  • 完了

  • 実行中

  • 失敗

  • 取消済

  • タイムアウト

  • 警告

2.41 QueryResults構造体

この構造体を使用して、問合せ実行時に問合せ詳細を指定します。この構造体は、XMLViewServiceサービス(executeXMLQueryメソッド)で使用します。

表2-65に、この構造体のフィールドをリストします。

表2-65 QueryResults構造体のフィールド

フィールド 説明

String rowset

文字列にエンコードされた行セットXMLを指定します。

String queryID

fetchNextコールで使用できる問合せの一意なIDを指定します。

boolean finished

TRUEに設定されている場合、返却する行がもうないことを意味します。FALSEに設定されている場合、行を返却するために再度fetchNextコールが必要であることを意味します。

2.42 RenameAccount構造体

この構造体を使用して、名前を変更するアカウントの古い名前、新しい名前およびタイプを保持します。この構造体は、SecurityServiceサービスで使用します。

表2-66に、この構造体のフィールドをリストします。

表2-66 RenameAccount構造体のフィールド

フィールド 説明

String oldAccountName

アカウントの変更前の名前を指定します。

String newAccountName

アカウントの新しい名前を指定します。

int accountType

アカウント・タイプを指定します。

2.43 RenameAccountResults構造体

この構造体を使用して、各アカウントのアカウントの名前変更操作のステータスを保持します。この構造体は、SecurityServiceサービスで使用します。

表2-68に、この構造体のフィールドをリストします。

表2-67 RenameAccountResults構造体のフィールド

フィールド 説明

String oldAccountName

アカウントの変更前の名前を指定します。

String newAccountName

アカウントの新しい名前を指定します。

int accountType

アカウントのタイプを指定します。

int status

全体的なアカウントの名前変更操作のステータスを指定します。値は次のとおりです。

  • 0-正常終了

  • 1-エラー

2.44 RenameAccountsStatus構造体

この構造体を使用して、アカウントの名前変更操作の全体的なステータスを保持します。この構造体は、SecurityServiceサービスで使用します。

表2-68に、この構造体のフィールドをリストします。

表2-68 RenameAccountsStatus構造体のフィールド

フィールド 説明

int status

全体的なアカウントの名前変更操作のステータスを指定します。値は次のとおりです。

  • 0- 正常終了

  • 1- エラー

RenameAccountResult[] accountsResult

各アカウントに対する成功または失敗のメッセージとともに古い名前、新しい名前およびアカウント・タイプを指定します。

2.45 ReportADFParameters構造体

この構造体を使用して、レポート・パラメータ(プロンプト、フィルタまたは変数)を定義します。この構造体は、ReportEditingServiceサービスで使用します。

表2-69に、この構造体のフィールドをリストします。

表2-69 ReportADFParameters構造体のフィールド

フィールド 説明

String name

プロンプト、フィルタまたは変数の式を指定します

String operator

プロンプト演算子を指定します

String type

パラメータのタイプ(フィルタ、プロンプトまたは変数)を指定します。

String datatype

パラメータのSQLデータ型を指定します

String value

2つのオペランドが必要な演算子に使用するフィールドを指定します。他の演算子は、ADFParameterValuesフィールドで指定される値を持ちます。

ADFParameterValues values

このパラメータの値を指定します

ADFParameterValues String []

文字列値の配列を指定します

2.46 ReportHTMLOptions構造体

この構造体を使用して、結果をHTMLページに表示するオプションを定義します。この構造体は、HtmlViewServiceサービスで使用します。

表2-70に、この構造体のフィールドをリストします。

表2-70 ReportHTMLOptions構造体のフィールド

フィールド 説明

boolean enableDelayLoading

内部でのみ使用します。このフィールドには常に1が設定されます。これは、Oracle Business Intelligence Webサービスはすぐに結果を提供する必要がなく、結果待ちであるというメッセージを表示することを意味します。

String linkMode

ドリルまたはリンクを現在のブラウザ・ウィンドウで表示するか、新しいブラウザ・ウィンドウで表示するかを指定します。有効な値の詳細は、第2.46.1項「ReportHTMLLinksMode列挙」を参照してください。

2.46.1 ReportHTMLLinksMode列挙

この列挙は、ReportHTMLOptions構造体のReportHTMLLinksModeフィールドで有効な値のリストを指定します。

表2-71に、この列挙の値をリストします。

表2-71 ReportHTMLLinksMode列挙の値

値 説明

String InPlace

ドリルまたはリンクは、ページのその他の部分を変更せず、現在の分析の内容のみを置き換えることを指定します。

String NewPage

ドリルまたはリンクを新しいブラウザ・ウィンドウで表示することを指定します。

String SamePage

ドリルまたはリンクは現在のブラウザ・ウィンドウを置き換えることを指定します。

2.47 ReportParams構造体

この構造体を使用して、分析の既存のフィルタおよび変数を置き換えます。この構造体は、Oracle BI EE Webサービスのすべてのサービスで共通です。

表2-72に、この構造体のフィールドをリストします。

表2-72 ReportParams構造体のフィールド

フィールド 説明

String[] filterExpressions

Oracle Business Intelligence Webサービスのフィルタ式の配列を指定します(形式は、Object[] filter_expression, filter_expression ...)。

Variable[] variables

メソッド実行前に設定する変数値の配列を指定します。この構造体は、第3.16.4項「executeXMLQuery()メソッド」および第3.8.4項「generateReportSQL()メソッド」で使用します。詳細は、第2.64項「Variable構造体」を参照してください。

NameValuePair[] nameValues

NULLに設定します。このフィールドは内部で使用します。

TemplateInfo[] templateInfos

NULLに設定します。このフィールドは内部で使用します。

String viewName

分析のXMLデータを生成する際に、どのビューを使用するのかを指定します。

表2-73に、分析にフィルタ式を適用する方法を示します。

表2-73 Oracle BI EE Webサービスの分析にフィルタ式を適用する方法

手順 内部処理

1

分析のXML表現と各フィルタ式を取得します。

2

各式要素ごとに、sqlExpression型の子ノードを特定(型はxsi:type attributeの値によって決定)し、その内部テキストを参照します。

3

分析XMLにおいて、内部テキストが前述の手順で特定されたものと合致するsqlExpression型の子ノードを持つすべてのノードを特定します。

4

ステップ3で特定したすべてのノードを、ステップ2の式で置き換えます。

表2-74に、分析に変数を適用する方法を示します。

表2-74 Oracle BI EE Webサービスの分析に変数を適用する方法

手順 内部処理

1

分析のXML表現を取得します。

2

各変数ごとに、variable型で、属性範囲が分析と同じで、変数名と合致する内部テキストを持つすべてのノードを、分析XMLから特定します。

3

ステップ2で特定した各ノードを、新しい変数値で置き換えます。

2.48 ReportHierarchicalColumn

この構造体を使用して、分析に使用する階層列の列プロパティを返します。この構造体は、ReportEditingServiceサービスで使用します。


注意:

レポート列に適用するシステム全体のデフォルトの列プロパティは、レポート列プロパティに返されます。

表2-75に、この構造体のフィールドをリストします。

表2-75 ReportHierarchicalColumn構造体のフィールド

フィールド 説明

文字列ID

レポート列の列識別子を指定します

String tableHeading

レポート列の表見出しを指定します

String columnHeading

レポート列の列見出しを指定します

Boolean hidden

TRUEに設定されている場合、列は非表示です。FALSEに設定されている場合、列が表示されます。

String subjectArea

レポート列のサブジェクト・エリアを指定します

String tableName

レポート列の表名を指定します

String hierarchyID

レポート列の階層を指定します

String dimensionID

レポート列のディメンションを指定します

2.49 ReportRegularColumn

この構造体を使用して、分析に使用する標準列の列プロパティを返します。この構造体は、ReportEditingServiceサービスで使用します。


注意:

レポート列に適用するシステム全体のデフォルトの列プロパティは、レポート列プロパティに返されます。

表2-76に、この構造体のフィールドをリストします。

表2-76 ReportRegularColumn構造体のフィールド

フィールド 説明

文字列ID

レポート列の列識別子を指定します

String tableHeading

レポート列の表見出しを指定します

String columnHeading

レポート列の列見出しを指定します

Boolean hidden

TRUEに設定されている場合、列は非表示です。FALSEに設定されている場合、列が表示されます。

String sqlFormula

レポート列の列式を指定します

Boolean measure

TRUEに設定されている場合、レポート列はメジャーです。FALSEに設定されている場合、レポート列は属性列です。

aggrRule ReportColumnAggrRule

列が集計データを保持する場合、この値は列に使用されている集計の種類を指定します。詳細は、第2.49.1項「ColumnAggregationRule値」を参照してください。

2.49.1 ColumnAggregationRuleの値

ReportRegularColumn構造体は、列のデフォルトの集計ルールを指定します。次のリストに、利用可能な集計関数を示します。

  • Default

  • Server

  • Sum

  • Average

  • Count

  • CountDistinct

  • Max

  • Min

  • None

  • ServerAggregate

  • Unknown

2.50 ReportRef構造体

この構造体を使用して、次のいずれかの方法で分析を参照します。

  • カタログの分析の場所。

  • 分析を定義するReportDefオブジェクト。このフィールドは常にNULLです。

  • 分析を定義するXML。


    注意:

    ReportRefの1つのフィールドのみにデータ移入します。

    ReportRef構造体は、Oracle BI EE Webサービスのすべてのサービスに共通です。

表2-77に、この構造体のフィールドをリストします。

表2-77 ReportRef構造体のフィールド

フィールド 説明

String reportPath

カタログの分析へのパスを提供する文字列値を指定します。例: /users/jchan/analyses/。

String reportXML

分析を定義するXMLを含む文字列値を指定します。

2.51 SAColumn構造体

この構造体を使用して、サブジェクト・エリアの論理列を表します。この構造体は、MetadataServiceサービスで使用します。

表2-78に、この構造体のフィールドをリストします。

表2-78 SAColumn構造体のフィールド

フィールド 説明

String name

SQL文で使用する列名を指定します。

String displayName

Oracle Business Intelligence Answersで使用するローカル名を指定します。

String description

列名の説明を保持する文字列を指定します。

boolean nullable

TRUEに設定されている場合、列はNULLとなる場合があります。

String dataType

列が保持するデータ型を指定します。詳細は、第2.51.1項「SADataType値」を参照してください。

boolean aggregateable

TRUEに設定されている場合、列は集計できます。

String aggrRule

列が集計データを保持する場合、この値は使用されている集計の種類を指定します。詳細は、第2.51.2項「AggregationRule値」を参照してください。

2.51.1 SADataTypeの値

SADataTypeは、列が保持するデータの型を指定します。次のリストに、利用可能なデータ型を示します。

  • BigInt

  • Binary

  • Bit

  • Char

  • Coordinate

  • Date

  • Decimal

  • Double

  • Float

  • Integer

  • Invalid

  • LongVarBinary

  • LongVarChar

  • Numeric

  • Real

  • SmallInt

  • Time

  • TimeStamp

  • TinyInt

  • Unknown

  • VarBinary

  • VarChar

2.51.2 AggregationRuleの値

SADataTypeは、列のデフォルト集計ルールを指定します。次のリストに、利用可能な集計関数を示します。

  • Avg

  • BottomN

  • Complex

  • Count

  • CountDistinct

  • CountStar

  • DimensionAggr

  • First

  • Last

  • Max

  • Min

  • None

  • Percentile

  • Rank

  • ServerDefault

  • SubTotal

  • Sum

  • TopN

2.52 SASubjectArea構造体

この構造体を使用して、サブジェクト・エリア属性を表します。この構造体は、MetadataServiceサービスで使用します。

表2-79に、この構造体のフィールドをリストします。

表2-79 SASubjectArea構造体のフィールド

フィールド 説明

String name

SQL文で使用する表名を指定します。

String displayName

Oracle Business Intelligence Answersで使用するローカル名を指定します。

String description

サブジェクト・エリアの説明を指定します。

SATable[] tables

このサブジェクト・エリアの表のコレクションを指定します。SATable構造体の詳細は、第2.53項「SATable構造体」を参照してください。

2.53 SATable構造体

この構造体を使用して、サブジェクト・エリアの論理表を表します。この構造体は、MetadataServiceサービスで使用します。

表2-80に、この構造体のフィールドをリストします。

表2-80 SATable構造体のフィールド

フィールド 説明

String name

SQL文で使用する表名を指定します。

String displayName

Oracle Business Intelligence Answersで使用するローカル名を指定します。

String description

表名の説明を指定します。

SAColumn[] columns

表の列の配列を指定します。SAColumn構造体の詳細は、第2.51項「SAColumn構造体」を参照してください。

2.54 SAWLocale構造体

この構造体を使用して、現在のセッションのロケールを定義します。この構造体は、SAWSessionServiceサービスで使用します。

表2-81に、この構造体のフィールドをリストします。

表2-81 SAWLocale構造体のフィールド

フィールド 説明

String language

言語コードを指定します。言語の値は、Javaのjava.util.Localeクラス(ISO-639、ISO-3166)で使用されているものに準拠します。

String country

国コードを指定します。国の値は、Javaのjava.util.Localeクラス(ISO-639, ISO-3166)で使用されているものに準拠します。

2.55 SAWSessionParameters構造体

この構造体を使用して、現在のセッションにおけるオプションのパラメータを定義します。この構造体は、SAWSessionServiceサービスで使用します。

表2-82に、この構造体のフィールドをリストします。

表2-82 SAWSessionParameters構造体のフィールド

フィールド 説明

SAWLocale locale

使用するロケールを指定します(SAWLocale構造体で提供)。SAWLocale構造体の詳細は、第3.9項「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.9.9項「logonex()メソッド」および第3.9.5項「impersonateex()メソッド」で使用します。

2.56 SegmentationOptions構造体

この構造体を使用して、Oracle Marketing Analyticsのユーザー・インタフェースで指定されているデフォルトを上書きする、セグメントまたはセグメント・ツリーを定義します。この構造体は、MetadataServiceサービスで使用します。

表2-83に、この構造体のフィールドをリストします。

表2-83 SegmentationOptions構造体のフィールド

フィールド 説明

OverrideType cacheOverride

Oracle Marketing Analyticsにおける今後の更新カウント・リクエストに対するブロックをキャッシュのユーザー・インタフェース・オプションをどのように上書きするかを指定します。

デフォルトに設定されている場合、構造体でのキャッシュ・オーバーライドが指定されていないか、構造体が指定されていません。デフォルト値は、各基準ブロックのユーザー・インタフェース・オプションで定義されているものを使用することを指定しています。

Noneに設定されている場合、システムはユーザー・インタフェースで定義された値をオーバーライドし、すべての基準ブロックで今後の更新カウント・リクエストに対するブロックをキャッシュのユーザー・インタフェース・オプションを無効にします。

Allに設定されている場合、システムはユーザー・インタフェースで定義された値をオーバーライドし、すべての基準ブロックで今後の更新カウント・リクエストに対するブロックをキャッシュユーザー・インタフェースのオプションを有効にします。

OverrideType countOverride

システムがカウント数の生成にgetCountsメソッドを使用するべきかを指定します。

デフォルトに設定されている場合、構造体でのカウントのオーバーライドが指定されていないか、構造体が指定されていません。

Allに設定されている場合、システムはgetCountsメソッドを実行します。Allに設定されている場合、システムはすべての基準ブロックに対してカウント数を計算します。

NameValuePair
govRules

セグメントまたはセグメント・ツリーに対する契約計画ルールを適用するための値を指定します。

NameValuePair
prompts

セグメントまたはセグメント・ツリーの列に適用するプロンプト値を指定します。このプロセスは、カウント生成時にデータをフィルタします。

このフィールドに値を提供しない場合、システムはセグメントの列に対してフィルタ基準を適用しません。

Boolean removeCacheHits

カウント情報を含むキャッシュ・エントリの消去を指定します。

Trueに設定されている場合、システムは最新のデータに対して問合せを行います。これを行うため、システムはターゲットのセグメントまたはセグメント・ツリーのカウント情報を持つすべての既存キャッシュ・エントリを削除します。システムはその後、getCountsメソッドで計算された新しいカウント数エントリで、キャッシュのデータを再移入します。

BigDecimal samplingFactor

カウントを計算するデータセットのサイズを指定します。getCountsメソッドは、この値によって決定するデータのサブセットに対し、すべての基準ブロックのカウント数を計算します。

デフォルト値は100です。このデフォルト値によって、カウント数は全データセットに対して計算されます。

2.57 SessionEnvironment構造体

この構造体を使用して、現在のセッションの環境情報を返却します。この構造体は、SAWSessionServiceサービスで使用します。

表2-84に、この構造体のフィールドをリストします。

表2-84 SessionEnvironment構造体のフィールド

フィールド 説明

String userName

現在のユーザーの名前を指定します。

ItemInfo homeDirectory

カタログにおけるユーザーのホーム・ディレクトリへのフルパスを指定します。例: /users/<ユーザー・ログインID>。

ItemInfo[] SharedDirectories

現在のユーザーが最低でも読取りアクセス権を持つ共有ディレクトリへのフルパスを指定します。

注意: デフォルトでは、「/shared」ディレクトリの直下をリストできるのは管理者のみです。ユーザーによる共有エリアのナビゲートは、SessionEnvironmentオブジェクトの取得のみです。

2.58 StartPageParams構造体

この構造体を使用して、startPageメソッド起動のオプションを定義します。この構造体は、HtmlViewServiceサービスで使用します。

表2-85に、この構造体のフィールドをリストします。

表2-85 StartPageParams構造体のフィールド

フィールド 説明

String idsPrefix

HTMLページでの名前の競合を回避するために、すべてのHTML要素のIDや名前と併用する接頭辞を指定します。

boolean dontUseHttpCookies

TRUEに設定されている場合、Oracle Business Intelligenceプレゼンテーション・サービスはsessionIDを渡すためにCookieを使用できません。そのかわり、sessionIDがコールバックURLにパラメータとして含まれます。

2.59 TreeFlags列挙

この列挙では、ノード・アセスメントの一部として戻すことができる各種TreeFlag値の静的定義を指定します。この列挙は、KPIAssessmentServiceサービスで使用します。

表2-86に、この列挙の値をリストします。

表2-86 TreeFlags列挙の値

値 説明

Integer STRATEGY

戦略のTreeFlagの値が1であることを指定します。

Integer INITIATIVE

イニシアティブのTreeFlagの値が2であることを指定します。

Integer ACCOUNTABILITY

アカウンタビリティのTreeFlagの値が4であることを指定します。


注意:

必要に応じて、表2-86の値をまとめて追加できます。たとえば、結果に戦略ツリーとイニシアティブ・ツリーの両方からのノードを含める場合、値として3 (1+2)を渡します。

2.60 TreeNodePath構造体

この構造体を使用して、セグメント・ツリーのブランチに対するセグメント・ツリー・パスとブランチIDを指定します。この構造体は、JobManagementServiceサービスで使用します。

表2-87に、この構造体のフィールドをリストします。

表2-87 TreeNodePath構造体のフィールド

フィールド 説明

String treeNode

リストに含めるメンバーを保持するセグメント・ツリーのブランチID番号を指定します。

String treePath

セグメント・ツリーへのパスを指定します。

2.61 UpdateACLParams構造体

この構造体を使用して、updateACLメソッド起動のオプションを設定します。この構造体は、SecurityServiceサービスで使用します。

表2-88に、この構造体のフィールドをリストします。

表2-88 UpdateACLParams構造体のフィールド

フィールド 説明

UpdateACLMode updateFlag

ACLモードの更新方法を指定します。詳細は、第2.61.1項「UpdateACLMode列挙」を参照してください。

2.61.1 UpdateACLMode列挙

この列挙では、UpdateACLParams構造体の更新フラグで有効な値のリストを指定します。

表2-89に、この列挙の値をリストします。

表2-89 UpdateACLMode列挙の値

値 説明

String ReplaceACL

更新するACLの値を指定します。

String ReplaceForSpecifiedAccounts

ACLで更新するアカウントのリストを指定します。

String DeleteAccountsFromACL

ACLから削除するアカウントのリストを指定します。

String AddPermission

ACLエントリのリストのために更新するリスト権限を指定します

String DeletePermission

ACLエントリのリストから削除するリスト権限を指定します

2.62 UpdateCatalogItemACLParams構造体

この構造体を使用して、updateCatalogItemACL()メソッドで追加のパラメータを提供します。この構造体は、WebCatalogServiceサービスで使用します。

表2-90に、この構造体のフィールドをリストします。

表2-90 UpdateCatalogItemACLParams構造体のフィールド

フィールド 説明

UpdateACLMode updateFlag

ACLモードの更新方法を指定します。詳細は、第2.61.1項「UpdateACLMode列挙」を参照してください。

boolean recursive

TRUEに設定されている場合、メソッドはカタログ項目と、パスによって識別されるそのすべての子孫に適用されます。FALSEに設定されている場合、メソッドはカタログ項目にのみ適用されます。

2.63 ValidActionLinks構造体

この構造体を使用して、有効なアクション・リンクを参照します。この構造体は、AssessmentResult構造体で使用します。

表2-91に、この構造体のフィールドをリストします。

表2-91 ValidActionLinks構造体のフィールド

フィールド 説明

DimensionContext[] ActionLinkContext

DimensionContext構造体の配列を指定します。詳細は、第2.14項「DimensionContext構造体」を参照してください。

ActionLinks[] ActionLink

ActionLink構造体の配列を指定します。詳細は、第2.5項「ActionLinks構造体」を参照してください。

2.64 Variable構造体

この構造体を使用して、分析の変数を参照し、他の変数で置き換えます。この構造体は、Oracle BI EE Webサービスのすべてのサービスで共通です。

表2-92に、この構造体のフィールドをリストします。

表2-92 Variable構造体のフィールド

フィールド 説明

String name

置き換える変数の名前を示す文字列を指定します。

Object value

変数の値を指定します。

2.65 XMLQueryExecutionOptions構造体

この構造体を使用して、問合せにおけるオプションのパラメータを指定します。この構造体は、XMLViewServiceサービス(executeXMLQueryメソッド)で使用します。

表2-93に、この構造体のフィールドをリストします。

表2-93 XMLQueryExecutionOptions構造体のフィールド

フィールド 説明

boolean async

TRUEに設定されている場合、非同期問合せ実行が有効です。FALSEに設定されている場合、非同期問合せ実行は無効です。

int maxRowsPerPage

executeXMLQueryまたはfetchNextメソッドによって返却される行の最大数を指定します。

boolean refresh

TRUEに設定されている場合、データをリフレッシュするためにサーバーが問合せを再送信します。FALSEに設定されている場合、Oracle Business Intelligence Serverはキャッシュにあるデータを使用します。

boolean presentationInfo

TRUEに設定されている場合、ローカライズされたプレゼンテーション情報を、レコード・セットXMLのメタデータ・セクションに格納します。

プレゼンテーション情報は次のものから構成されます。

  • 列ヘッダー情報(columnHeadingフィールドに格納されています)。

  • 表ヘッダー情報(tableHeadingフィールドに格納されています)。

String type

問合せIDを指定します。このIDは、エラーを診断する際に、ログで使用できます。

  前
前 		 次
次
  目次へ移動
目次