| Oracle® Fusion Middleware Oracle Business Intelligence Enterprise Editionインテグレーターズ・ガイド 11g リリース1 (11.1.1) B63033-06 |
|
 前 |
 次 |
| Oracle® Fusion Middleware Oracle Business Intelligence Enterprise Editionインテグレーターズ・ガイド 11g リリース1 (11.1.1) B63033-06 |
|
前 |
次 |
この章では、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レポートの出力を参照するパーミッション 65535 = アイテムのフル・コントロール権限を付与するパーミッション |
この構造体を使用して、ユーザー名やグループ名を保持します。これは、名前がユーザー名かグループ名かを示すフラグを持っています。この構造体は、SecurityServiceサービスで使用します。
表2-2に、この構造体のフィールドをリストします。
表2-2 Account構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String accountName |
アカウント名またはグループ名を指定します。 |
|
int accountType |
アカウントがユーザーか、グループか、またはその両方かを指定します。 次の場合にaccountTypeを使用します。
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を指定します。 |
この構造体を使用して、アクセス制御リスト(ACL)を保持します。この構造体は、SecurityServiceサービスで使用します。
表2-3に、この構造体のフィールドをリストします。
表2-3 ACL構造体のフィールド
| フィールド | 説明 |
|---|---|
|
AccessControlToken[] accessControlTokens |
パーミッションの全リストを指定します。詳細は、第2.1項「AccessControlToken構造体」を参照してください。 |
|
String dummy |
内部で使用します。 |
この構造体を使用して、スコアカードにアタッチされたアクションに関する情報を保持します。この構造体は、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.32項「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サービスの詳細を指定します。 |
この構造体を使用して、有効なアクション・リンクを参照します。この構造体は、ValidActionLinks構造体で使用します。
表2-5に、この構造体のフィールドをリストします。
表2-5 ActionLinks構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String ActionPath |
ActionLinkのターゲットであるBIコンテンツへのカタログ・パスを指定します(ActionLinkが"BIコンテンツ"タイプのアクション・リンクである場合のみ表示されます)。 |
|
String Text |
クリックしてアクションを起動できるようにユーザーに表示するテキストを指定します。 |
|
Action[] Action |
アクションの詳細を指定します(ActionLinkが"BIコンテンツ"タイプでない場合のみ表示されます)。詳細は、第2.4項「Action構造体」を参照してください。 |
この構造体を使用して、保存した結果セットを表すGUIDのリストを指定します。この構造体は、SecurityServiceサービスで使用します。
表2-6に、この構造体のフィールドをリストします。
この構造体を使用して、戦略ツリーのノードに対する特定のQDRのアセスメントを1つのみ格納します。この構造体は、ScorecardAssessmentServiceサービスで使用します。
表2-7に、この構造体のフィールドをリストします。
表2-7 AssessmentResult構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String ScorecardPath |
評価されたスコアカードが格納されているフォルダへのプレゼンテーション・サービス・カタログ・パスを指定します。 |
|
Variable[] Variables |
アセスメント結果が適用可能なQDRを定義するVariableオブジェクトの配列を指定します。詳細は、第2.53項の「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.27項「KPIResultColumn構造体」を参照してください。 |
|
Boolean IsOverridden |
ノードがオーバーライドされるか(true)、否か(false)を指定します。 |
|
ValidActionLink[] ValidActionLinks |
現在の評価されたステータスについてアクション・リンクを定義するリンク要素の配列を指定します。詳細は、第2.52項「ValidActionLinks構造体」を参照してください。 |
この構造体を使用して、認可時の認証の詳細を指定します。この構造体は、SecurityServiceサービスで使用されています(impersonateex()メソッドおよびlogonex()メソッドの中で)。
表2-8に、この構造体のフィールドをリストします。
パスとタイムスタンプをもとにカタログ項目および変更をフィルタするために、この構造体を使用します。この構造体は、ReplicationServiceサービスで使用します。
表2-9に、この構造体のフィールドをリストします。
表2-9 CatalogItemsFilter構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String[] items |
フィルタに含めるフォルダおよびその子フォルダを指定します。この値がNULLの場合、カタログのすべてのノードが含まれます。 |
|
Calendar from |
フィルタする期間を指定します。その期間中のタイムスタンプを持つ項目および変更のみがフィルタを満たします。これらフィールドのいずれかまたは両方がNULLである場合、そのフィールドに対する範囲設定がないものとされます。 |
|
Calendar to |
フィルタする期間を指定します。その期間中のタイムスタンプを持つ項目および変更のみがフィルタを満たします(from <= タイムスタンプ <= to)。これらフィールドのいずれかまたは両方がNULLである場合、そのフィールドに対する範囲設定がないものとされます。 |
この構造体を使用して、単一のメソッドにおける特定のカタログ・オブジェクトのすべての情報を取得または指定します。この構造体はWebCatalogServiceサービスで使用します。
表2-10に、この構造体のフィールドをリストします。
表2-10 CatalogObject構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String catalogObject |
オブジェクトのXML表現を指定します。 |
|
catalogObjectBytes |
カタログ・オブジェクトから返却されるコンテンツが文字列かバイトかを指定します。このフィールドで指定するものは、readObjectsメソッドによって決まります。 |
|
ItemInfo itemInfo |
ItemInfo共通構造体で提供されているオブジェクトのカタログ情報を指定します。 ItemInfo構造体の詳細は、第2.17項「ItemInfo構造体」を参照してください。 |
|
ErrorInfo errorInfo |
readObjectsメソッドのErrorDetails引数の指定を受けて、提供するエラー情報のレベルを指定します。 |
この構造体を使用して、単一の因果関係を表します。この構造体は、ScorecardMetadataServiceサービスで使用します。
表2-11に、この構造体のフィールドをリストします。
表2-11 CausalLinkage構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String ID |
この因果関係のGUIDを指定します。 |
|
String causeNodeID |
リンクの原因側にある戦略ノードまたはイニシアティブ・ノードのGUIDを指定します。 |
|
String effectNodeID |
リンクの結果側にある戦略ノードまたはイニシアティブ・ノードのGUIDを指定します。 |
|
String Strength |
関係の強さを指定します。第2.11.1項「Strength列挙」の値のいずれかを使用して定義します。 |
|
String Interaction |
関係の比例を指定します。第2.11.2項「Interaction列挙」の静的値のいずれかを使用して定義します。 |
|
String Operation |
指定したCausalLinkageを使用して実行する内容を指定します。指定可能な値は、ADD、UPDATE、DELETEのいずれかです。 |
この列挙は、サポートされている様々なリンクの強さの値を表します。この列挙は、CausalLinkage構造体で使用します。
表2-12に、この列挙の値をリストします。
この列挙は、サポートされている様々なリンクの強さの値を表します。この列挙は、CausalLinkage構造体で使用します。
表2-13に、この列挙の値をリストします。
この構造体を使用して、ディメンションを取得します。この構造体は、ValidActionLinks構造体で使用します。
表2-15に、この構造体のフィールドをリストします。
この構造体を使用して、プレゼンテーション・カタログ・サービスのメソッドを呼び出す際のエラー情報を取得します。この構造体は、WebCatalogServiceサービスで使用します。
表2-16に、この構造体のフィールドをリストします。
この構造体を使用して、プレゼンテーション・カタログ・サービスのメソッドを呼び出す際にお気に入り項目の情報を取得します。この構造体は、UserPersonalizationServiceサービスで使用します。
表2-17に、この構造体のフィールドをリストします。
表2-17 FavoriteItem構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String name |
お気に入りまたはカテゴリの名前を指定します。 |
|
String path |
お気に入り項目の場合はカタログ・オブジェクトのパスを、カテゴリ・オブジェクトの場合はお気に入りマネージャのカテゴリ・パスを指定します。 |
|
UnsignedShort type |
FavoriteItemオブジェクトに格納されるタイプを指定します。 お気に入り項目 = 0 カテゴリ・オブジェクト = 1 |
|
ItemInfo itemInfo |
ItemInfo共通構造体で提供されているオブジェクトのカタログ情報を指定します。 typeが0の場合、有効であり、実際のカテゴリ・オブジェクトが格納されます。typeが1の場合、無効です。 ItemInfo構造体の詳細は、第2.17項「ItemInfo構造体」を参照してください。 |
|
FavoriteItem favoriteItem |
typeが1の場合はサブ項目のリスト、それ以外の場合は無効な値です。 |
この構造体を使用して、getSubItemsメソッドで使用されているオプションのパラメータを保持します。この構造体は、WebCatalogServiceサービスで使用します。
表2-18に、この構造体のフィールドをリストします。
表2-18 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-19に、この構造体のフィールドをリストします。
この構造体を使用して、オブジェクトのカタログ情報を保持します。この構造体は、WebCatalogServiceサービスおよびScorecardMetadataServiceサービスで使用します。
表2-20に、この構造体のフィールドをリストします。
表2-20 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」に設定されている場合、このフィールドはオブジェクトのターゲット・パスを指定します。 |
この構造体を使用して、ジョブ情報を保持します。この構造体は、SchedulerServiceサービスで使用します。
表2-21に、この構造体のフィールドをリストします。
詳細は、『Oracle Fusion Middleware Oracle Business Intelligence Enterprise Editionジョブ・スケジューリング・ガイド』のOracle BIスケジューラのジョブ・マネージャ・メニューに関する項を参照してください。
いくつかのプロパティはオプションで、ジョブに関連していなければ存在しない場合があります(たとえば、ジョブ・トリガーのタイプによります)。
表2-21 Job構造体のフィールド
| フィールド | 説明 |
|---|---|
|
ジョブ参照 |
インスタンスに関連付けられているジョブの一意の参照。 |
|
名前 |
短くてわかりやすいジョブ名。 |
|
説明 |
エンド・ユーザーに対するそのアクションに関するジョブの説明のテキスト。 |
|
ユーザーID(作成者ID) |
ジョブを作成したユーザーのID。 |
|
スクリプト・タイプ |
ジョブの実行で使用したスクリプトのタイプ(VBScript、JScript、JavaまたはNQCmd)。 |
|
スクリプトID (エージェントのパス) |
ジョブを実行するスクリプトへのパス。 WebCatalogService APIをコールして、エージェント定義を戻す場合に使用します。詳細は、第3.10.8.5項「例 - WebCatalogServiceのすべてのエージェントの検索および表示」を参照してください。 |
|
最大実行時間(ミリ秒) |
ジョブの実行が継続する最大時間(ミリ秒)。 |
|
実行インスタンス件数 |
現在実行中のこのジョブのインスタンスの総数。 |
|
最大同時インスタンス |
同時に実行するインスタンスの最大数。同時インスタンスの数を制限しない場合は、この値をゼロに設定します。 |
|
タイム・ゾーン |
ジョブの実行で使用するタイムゾーン。このフィールドが指定されない場合、タイムゾーンはスケジューラのローカル・タイムゾーンであるとみなされます。 |
|
最終実行日時 |
最後にジョブの実行を開始した日付および時刻。 |
|
次回実行日時 |
次にジョブの実行を開始する日付および時刻。 |
|
開始日 |
最初の繰返し区間を実行する日付。 |
|
開始時間 |
ジョブが開始した時刻。 |
|
終了日 |
最初の繰返し区間を終了する日付。 |
|
終了時間 |
ジョブが完了した時刻。 |
|
間隔 |
繰返し区間中に次のジョブを実行するまでの分単位の時間。 |
|
無効 |
トリガーが期限切れになるとジョブ・スクリプトが実行されないように指定します。 |
|
完了時にジョブを削除 |
ジョブの終了後、ジョブを削除するかどうか指定します。 |
|
存在しない場合に実行 |
ジョブの実行中、スケジュールされた時間にエラーが発生した場合、ジョブを実行するかどうか指定します。 |
|
ジョブ・トリガー(詳細はタイプ別) |
ジョブおよびジョブの詳細をトリガーするかどうか指定します。詳細はジョブ・タイプによって異なります。 ジョブ・トリガーは、次のいずれかの値です。 RunNever、RunOnce、RunDaily、RunWeekly、RunMonthlyByDate、RunMonthlyByDayOfWeek。 |
この構造体を使用して、ジョブ一覧をフィルタします。この構造体は、SchedulerServiceサービスで使用します。
表2-22に、この構造体のフィールドをリストします。
この構造体を使用して、実行中、取消済または完了済のジョブに対応するジョブ・インスタンスに関する情報を保持します。この構造体は、SchedulerServiceサービスで使用します。
表2-23に、この構造体のフィールドをリストします。
詳細は、『Oracle Fusion Middleware Oracle Business Intelligence Enterprise Editionジョブ・スケジューリング・ガイド』のOracle BIスケジューラのジョブ・マネージャ・メニューに関する項を参照してください。
表2-23 JobInstance構造体のフィールド
| フィールド | 説明 |
|---|---|
|
ジョブ参照 |
ジョブ・インスタンスに関連付けられているジョブの一意の参照。 |
|
ジョブ・インスタンス参照 |
ジョブ・インスタンスの一意の参照。 |
|
ジョブ・インスタンス・ステータス |
ジョブ・インスタンスの現在のステータス。有効な値は次のとおりです。
|
|
開始日時 |
スケジューラがジョブ・インスタンスを開始した日時です。 |
|
終了日時 |
ジョブ・スケジューラがジョブ・インスタンスを完了した日時です。 |
|
正常な配信 |
このジョブ・インスタンスによる成功した配信の回数。 |
|
エラー・メッセージ |
ジョブ・インスタンスの実行に関するエラー・メッセージ、警告または一般的なメッセージ。 |
この構造体を使用して、ジョブ・インスタンス一覧をフィルタします。この構造体は、SchedulerServiceサービスで使用します。
表2-24に、この構造体のフィールドをリストします。
この列挙を使用して、ジョブ・インスタンス・ステータスを定義します。この列挙は、SchedulerServiceサービスで使用します。
表2-25に、この列挙の値をリストします。
この構造体を使用して、ジョブおよび関連付けられたインスタンスをグループ化します。ジョブ参照の一覧が、ジョブ・インスタンスの一覧の選択条件として指定された場合、これは重要です。この構造体は、SchedulerServiceサービスで使用します。
表2-26に、この構造体のフィールドをリストします。
詳細は、『Oracle Fusion Middleware Oracle Business Intelligence Enterprise Editionジョブ・スケジューリング・ガイド』のOracle BIスケジューラのジョブ・マネージャ・メニューに関する項を参照してください。
この列挙では、KPIColumnNameフィールドの有効な値のリストを指定します。この列挙は、KPIAssessmentServiceサービスで使用し、KPIResultColumn構造体によって使用されます。
表2-27に、この列挙の値をリストします。
表2-27 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 |
カスタム列名。 |
この構造体を使用して、アセスメントのリクエスト時にKPIのQDRを定義する際に使用する個々のディメンション固定のメタデータを格納します。この構造体は、KPIRequest構造体で使用します。
表2-28に、この構造体のフィールドをリストします。
表2-28 KPIDimensionPinning構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String DimensionID |
特定の値に固定するディメンションのIDを指定します。 |
|
String Value |
指定したディメンションの固定先となる値を指定します。 |
|
String VariableType |
指定したディメンションの固定に使用する値が格納されている変数のタイプを指定します。 |
|
String VariableName |
(オプション)指定したディメンションの固定に使用する値が格納されている変数の名前を指定します(VariableTypeがNONEの場合はnullのままにできます)。 |
|
String LevelID |
(オプション)指定した値が属するディメンション・レベルのIDを指定します(ディメンションがLevelまたはValue Hierarchyでない場合はnullのままにできます)。 |
この構造体を使用して、指定したKPIのアセスメント値のリクエストに必要な情報を格納します。この構造体は、KPIAssessmentServiceサービスで使用します。
表2-29に、この構造体のフィールドをリストします。
表2-29 KPIRequest構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String Path |
KPIのプレゼンテーション・サービス・カタログ・パスを指定します。 |
|
KPIDimensionPinning[] KPIDimensionPinnings |
問合せに適用されるフィルタを定義するディメンション固定の配列を指定します。詳細は、第2.25項の「KPIDimensionPinning構造体のフィールド」を参照してください。 |
この構造体を使用して、戦略ツリーのノードに対する特定のQDRのアセスメントを1つのみ格納します。この構造体は、ScorecardAssessmentServiceサービスで使用します。
表2-30に、この構造体のフィールドをリストします。
表2-30 KPIResultColumn構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String Name |
セルが属する列名を指定します。詳細は、第2.24項の「KPIColumnName列挙の値」を参照してください。 |
|
String Type |
セルのデータ型を指定します。 |
|
String Value |
セルの値を指定します。 |
|
String FormattedValue |
書式設定された値を指定します。 |
|
String ObjectContext |
このセルを戻した問合せに適用されたQDRを指定します。 |
|
Boolean IsAnnotated |
セルが注釈付きとなっていたか(true)、否か(false)を指定します。 |
この構造体を使用して、プレゼンテーション・カタログ・サービスのメソッドを呼び出す際に最近使用した(MRU)項目の情報を取得します。この構造体は、UserPersonalizationServiceサービスで使用します。
表2-31に、この構造体のフィールドをリストします。
表2-31 MRUItem構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String catalogPath |
最近使用したカタログ・オブジェクトのカタログ・パスを指定します。 |
|
Boolean isFavorite |
MRU項目がお気に入り項目でもあるかどうかを指定します。 |
|
ItemInfo itemInfo |
ItemInfo共通構造体で提供されているオブジェクトのカタログ情報を指定します。 ItemInfo構造体の詳細は、第2.17項「ItemInfo構造体」を参照してください。 |
この構造体を使用して、名前付きプロパティを指定します(COLOR=REDなど)。この構造体は、WebCatalogServiceサービスで使用します。
表2-32に、この構造体のフィールドをリストします。
この構造体を使用して、単一ノードを識別する情報を格納します。この構造体は、ScorecardAssessmentServiceサービスで使用します。
表2-33に、この構造体のフィールドをリストします。
表2-33 NodeInfo構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String NodeType |
ノードのタイプを指定します。詳細は、第2.30.1項「NodeTypes列挙」を参照してください。 |
|
String NodeID |
ノードのGUIDを指定します。 |
この構造体を使用して、出力メソッドに含まれているデータのコピー先を指定します。この構造体は、ReplicationServiceサービスによって使用されます。
表2-35に、この構造体のフィールドをリストします。
この構造体を使用して、Actionフレームワークで使用されているように、パラメータをモデル化します。この構造体は、Action構造体で使用します。
表2-36に、この構造体のフィールドをリストします。
表2-36 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.33項「ParameterValue構造体」を参照してください。 |
|
String ValueFixed |
パラメータ値がこのパラメータに対して固定である(オーバーライドできない)かどうかを指定します。値は'true'または'false'です。 |
|
String Order |
所有元のドキュメントでパラメータを保持する特定の順序を指定します。 |
|
String MultiValuesAllowed |
パラメータが複数の値をサポートしているかどうかを指定します。値は'true'または'false'です。 |
|
String Mandatory |
値のユーザー入力が必須かどうかを指定します。値は'true'または'false'です。 |
この構造体を使用して、ParameterDocument構造体で使用されているように、パラメータ値をモデル化します。ParameterDocumentはこれらのゼロ以上の配列を所有します。この構造体は、ParameterDocument構造体で使用します。
表2-37に、この構造体のフィールドをリストします。
この構造体を使用して、グローバル権限を表します。Oracle BI EEでは、「権限の管理」画面を使用してこれらの権限を構成します。この構造体は、SecurityServiceサービスで使用します。
表2-38に、この構造体のフィールドをリストします。
この構造体を使用して、ジョブ・インスタンスをパージします。この構造体は、SchedulerServiceサービスで使用します。
表2-39に、この構造体のフィールドをリストします。2つのプロパティのいずれか1つを選択します。
この構造体を使用して、問合せ実行時に問合せ詳細を指定します。この構造体は、XMLViewServiceサービス(executeXMLQueryメソッド)で使用します。
表2-40に、この構造体のフィールドをリストします。
この構造体を使用して、結果をHTMLページに表示するオプションを定義します。この構造体は、HtmlViewServiceサービスで使用します。
表2-41に、この構造体のフィールドをリストします。
表2-41 ReportHTMLOptions構造体のフィールド
| フィールド | 説明 |
|---|---|
|
boolean enableDelayLoading |
内部でのみ使用します。このフィールドには常に1が設定されます。これは、Oracle Business Intelligence Webサービスはすぐに結果を提供する必要がなく、結果待ちであるというメッセージを表示することを意味します。 |
|
String linkMode |
ドリルまたはリンクを現在のブラウザ・ウィンドウで表示するか、新しいブラウザ・ウィンドウで表示するかを指定します。有効な値の詳細は、第2.37.1項「ReportHTMLLinksMode列挙」を参照してください。 |
この列挙は、ReportHTMLOptions構造体のReportHTMLLinksModeフィールドで有効な値のリストを指定します。
表2-42に、この列挙の値をリストします。
この構造体を使用して、分析の既存のフィルタおよび変数を置き換えます。この構造体は、Oracle BI EE Webサービスのすべてのサービスで共通です。
表2-43に、この構造体のフィールドをリストします。
表2-43 ReportParams構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String[] filterExpressions |
Oracle Business Intelligence Webサービスのフィルタ式の配列を指定します(形式は、Object[] filter_expression, filter_expression ...)。 |
|
Variable[] variables |
メソッド実行前に設定する変数値の配列を指定します。この構造体は、第3.16.4項「executeXMLQuery()メソッド」および第3.8.3項「generateReportSQL()メソッド」で使用します。詳細は、第2.53項「Variable構造体」を参照してください。 |
|
NameValuePair[] nameValues |
NULLに設定します。このフィールドは内部で使用します。 |
|
TemplateInfo[] templateInfos |
NULLに設定します。このフィールドは内部で使用します。 |
|
String viewName |
分析のXMLデータを生成する際に、どのビューを使用するのかを指定します。 |
表2-44に、分析にフィルタ式を適用する方法を示します。
表2-44 Oracle BI EE Webサービスの分析にフィルタ式を適用する方法
| 手順 | 内部処理 |
|---|---|
|
1 |
分析のXML表現と各フィルタ式を取得します。 |
|
2 |
各式要素ごとに、sqlExpression型の子ノードを特定(型はxsi:type attributeの値によって決定)し、その内部テキストを参照します。 |
|
3 |
分析XMLにおいて、内部テキストが前述の手順で特定されたものと合致するsqlExpression型の子ノードを持つすべてのノードを特定します。 |
|
4 |
ステップ3で特定したすべてのノードを、ステップ2の式で置き換えます。 |
表2-45に、分析に変数を適用する方法を示します。
この構造体を使用して、次のいずれかの方法で分析を参照します。
カタログの分析の場所。
分析を定義するReportDefオブジェクト。このフィールドは常にNULLです。
分析を定義するXML。
|
注意: ReportRefの1つのフィールドのみにデータ移入します。ReportRef構造体は、Oracle BI EE Webサービスのすべてのサービスに共通です。 |
表2-46に、この構造体のフィールドをリストします。
この構造体を使用して、サブジェクト・エリアの論理列を表します。この構造体は、MetadataServiceサービスで使用します。
表2-47に、この構造体のフィールドをリストします。
表2-47 SAColumn構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String name |
SQL文で使用する列名を指定します。 |
|
String displayName |
Oracle Business Intelligence Answersで使用するローカル名を指定します。 |
|
String description |
列名の説明を保持する文字列を指定します。 |
|
boolean nullable |
TRUEに設定されている場合、列はNULLとなる場合があります。 |
|
String dataType |
列が保持するデータ型を指定します。詳細は、第2.40.1項「SADataType値」を参照してください。 |
|
boolean aggregateable |
TRUEに設定されている場合、列は集計できます。 |
|
String aggrRule |
列が集計データを保持する場合、この値は使用されている集計の種類を指定します。詳細は、第2.40.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
この構造体を使用して、サブジェクト・エリア属性を表します。この構造体は、MetadataServiceサービスで使用します。
表2-48に、この構造体のフィールドをリストします。
表2-48 SASubjectArea構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String name |
SQL文で使用する表名を指定します。 |
|
String displayName |
Oracle Business Intelligence Answersで使用するローカル名を指定します。 |
|
String description |
サブジェクト・エリアの説明を指定します。 |
|
SATable[] tables |
このサブジェクト・エリアの表のコレクションを指定します。SATable構造体の詳細は、第2.42項「SATable構造体」を参照してください。 |
この構造体を使用して、サブジェクト・エリアの論理表を表します。この構造体は、MetadataServiceサービスで使用します。
表2-49に、この構造体のフィールドをリストします。
表2-49 SATable構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String name |
SQL文で使用する表名を指定します。 |
|
String displayName |
Oracle Business Intelligence Answersで使用するローカル名を指定します。 |
|
String description |
表名の説明を指定します。 |
|
SAColumn[] columns |
表の列の配列を指定します。SAColumn構造体の詳細は、第2.40項「SAColumn構造体」を参照してください。 |
この構造体を使用して、現在のセッションのロケールを定義します。この構造体は、SAWSessionServiceサービスで使用します。
表2-50に、この構造体のフィールドをリストします。
この構造体を使用して、現在のセッションにおけるオプションのパラメータを定義します。この構造体は、SAWSessionServiceサービスで使用します。
表2-51に、この構造体のフィールドをリストします。
表2-51 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()メソッド」で使用します。 |
この構造体を使用して、Oracle Marketing Analyticsのユーザー・インタフェースで指定されているデフォルトを上書きする、セグメントまたはセグメント・ツリーを定義します。この構造体は、MetadataServiceサービスで使用します。
表2-52に、この構造体のフィールドをリストします。
表2-52 SegmentationOptions構造体のフィールド
| フィールド | 説明 |
|---|---|
|
OverrideType cacheOverride |
Oracle Marketing Analyticsにおける今後の更新カウント・リクエストに対するブロックをキャッシュのユーザー・インタフェース・オプションをどのように上書きするかを指定します。 デフォルトに設定されている場合、構造体でのキャッシュ・オーバーライドが指定されていないか、構造体が指定されていません。デフォルト値は、各基準ブロックのユーザー・インタフェース・オプションで定義されているものを使用することを指定しています。 Noneに設定されている場合、システムはユーザー・インタフェースで定義された値をオーバーライドし、すべての基準ブロックで今後の更新カウント・リクエストに対するブロックをキャッシュのユーザー・インタフェース・オプションを無効にします。 Allに設定されている場合、システムはユーザー・インタフェースで定義された値をオーバーライドし、すべての基準ブロックで今後の更新カウント・リクエストに対するブロックをキャッシュユーザー・インタフェースのオプションを有効にします。 |
|
OverrideType countOverride |
システムがカウント数の生成にgetCountsメソッドを使用するべきかを指定します。 デフォルトに設定されている場合、構造体でのカウントのオーバーライドが指定されていないか、構造体が指定されていません。 Allに設定されている場合、システムはgetCountsメソッドを実行します。Allに設定されている場合、システムはすべての基準ブロックに対してカウント数を計算します。 |
|
NameValuePair |
セグメントまたはセグメント・ツリーに対する契約計画ルールを適用するための値を指定します。 |
|
NameValuePair |
セグメントまたはセグメント・ツリーの列に適用するプロンプト値を指定します。このプロセスは、カウント生成時にデータをフィルタします。 このフィールドに値を提供しない場合、システムはセグメントの列に対してフィルタ基準を適用しません。 |
|
Boolean removeCacheHits |
カウント情報を含むキャッシュ・エントリの消去を指定します。 Trueに設定されている場合、システムは最新のデータに対して問合せを行います。これを行うため、システムはターゲットのセグメントまたはセグメント・ツリーのカウント情報を持つすべての既存キャッシュ・エントリを削除します。システムはその後、getCountsメソッドで計算された新しいカウント数エントリで、キャッシュのデータを再移入します。 |
|
BigDecimal samplingFactor |
カウントを計算するデータセットのサイズを指定します。getCountsメソッドは、この値によって決定するデータのサブセットに対し、すべての基準ブロックのカウント数を計算します。 デフォルト値は100です。このデフォルト値によって、カウント数は全データセットに対して計算されます。 |
この構造体を使用して、現在のセッションの環境情報を返却します。この構造体は、SAWSessionServiceサービスで使用します。
表2-53に、この構造体のフィールドをリストします。
表2-53 SessionEnvironment構造体のフィールド
| フィールド | 説明 |
|---|---|
|
String userName |
現在のユーザーの名前を指定します。 |
|
ItemInfo homeDirectory |
カタログにおけるユーザーのホーム・ディレクトリへのフルパスを指定します。例: /users/<ユーザー・ログインID>。 |
|
ItemInfo[] SharedDirectories |
現在のユーザーが最低でも読取りアクセス権を持つ共有ディレクトリへのフルパスを指定します。 注意: デフォルトでは、「/shared」ディレクトリの直下をリストできるのは管理者のみです。ユーザーによる共有エリアのナビゲートは、SessionEnvironmentオブジェクトの取得のみです。 |
この構造体を使用して、startPageメソッド起動のオプションを定義します。この構造体は、HtmlViewServiceサービスで使用します。
表2-54に、この構造体のフィールドをリストします。
この列挙では、ノード・アセスメントの一部として戻すことができる各種TreeFlag値の静的定義を指定します。この列挙は、KPIAssessmentServiceサービスで使用します。
表2-55に、この列挙の値をリストします。
表2-55 TreeFlags列挙の値
| 値 | 説明 |
|---|---|
|
Integer STRATEGY |
戦略のTreeFlagの値が1であることを指定します。 |
|
Integer INITIATIVE |
イニシアティブのTreeFlagの値が2であることを指定します。 |
|
Integer ACCOUNTABILITY |
アカウンタビリティのTreeFlagの値が4であることを指定します。 |
この構造体を使用して、セグメント・ツリーのブランチに対するセグメント・ツリー・パスとブランチIDを指定します。この構造体は、JobManagementServiceサービスで使用します。
表2-56に、この構造体のフィールドをリストします。
この構造体を使用して、updateACLメソッド起動のオプションを設定します。この構造体は、SecurityServiceサービスで使用します。
表2-57に、この構造体のフィールドをリストします。
表2-57 UpdateACLParams構造体のフィールド
| フィールド | 説明 |
|---|---|
|
UpdateACLMode updateFlag |
ACLモードの更新方法を指定します。詳細は、第2.50.1項「UpdateACLMode列挙」を参照してください。 |
この構造体を使用して、updateCatalogItemACL()メソッドで追加のパラメータを提供します。この構造体は、WebCatalogServiceサービスで使用します。
表2-59に、この構造体のフィールドをリストします。
表2-59 UpdateCatalogItemACLParams構造体のフィールド
| フィールド | 説明 |
|---|---|
|
UpdateACLMode updateFlag |
ACLモードの更新方法を指定します。詳細は、第2.50.1項「UpdateACLMode列挙」を参照してください。 |
|
boolean recursive |
TRUEに設定されている場合、メソッドはカタログ項目と、パスによって識別されるそのすべての子孫に適用されます。FALSEに設定されている場合、メソッドはカタログ項目にのみ適用されます。 |
この構造体を使用して、有効なアクション・リンクを参照します。この構造体は、AssessmentResult構造体で使用します。
表2-60に、この構造体のフィールドをリストします。
表2-60 ValidActionLinks構造体のフィールド
| フィールド | 説明 |
|---|---|
|
DimensionContext[] ActionLinkContext |
DimensionContext構造体の配列を指定します。詳細は、第2.12項「DimensionContext構造体」を参照してください。 |
|
ActionLinks[] ActionLink |
ActionLink構造体の配列を指定します。詳細は、第2.5項「ActionLinks構造体」を参照してください。 |
この構造体を使用して、分析の変数を参照し、他の変数で置き換えます。この構造体は、Oracle BI EE Webサービスのすべてのサービスで共通です。
表2-61に、この構造体のフィールドをリストします。
この構造体を使用して、問合せにおけるオプションのパラメータを指定します。この構造体は、XMLViewServiceサービス(executeXMLQueryメソッド)で使用します。
表2-62に、この構造体のフィールドをリストします。
表2-62 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は、エラーを診断する際に、ログで使用できます。 |
