1. Oracle EssbaseのREST API
  2. タスク
  3. ルール

ルール・データのプレビュー

post

/essbase/rest/v1/utils/rules/preview

ルール・ファイルをデータの2次元配列に適用し、プレビューしたデータ・ロードを2次元配列として返します。

リクエスト

サポートされているメディア・タイプ
本体()

ルール・ファイルの詳細、および入力内容の2次元配列。

ルート・スキーマ : RulePreviewInput
型: object
ソースの表示
ネストされたスキーマ : data
型: array
ソースの表示
ネストされたスキーマ : Rules
型: object
ソースの表示
  • columnOperations

    フィールド・レベルで実行できるルールの操作。たとえば、レコード内の新しい位置にフィールドを移動できます。

  • DataLoadOptions

    フィールド内のデータに対して実行できるルールの操作。たとえば、データが既存の値にどのように影響するかの変更、値のクリア、符号の反転などです。ディメンション構築ルールには適用できません。

  • DataSource

    ディメンション構築ルールまたはデータ・ロード・ルールの一般ソース・プロパティ。ソース・データに対するルールの動作を大まかに設定するために使用します。

  • DimBuildOptions

    ディメンション構築ルールに組み込まれているすべてのディメンションに影響するグローバル・プロパティ。

  • dimensions

    ディメンションごとに定義されたプロパティ。ディメンションに対するルールの動作を設定します。

  • EditorOptions
  • 指定可能な値: [ "NONE", "NONUNICODE", "UTF8" ]

    ルール・ファイルのエンコーディング・タイプ。

  • EssbaseInfo
  • fields

    特定のフィールドに関する情報に加えて、すべてのフィールドの一般的なプロパティを含むフィールド情報の配列。

  • ルールがフラット・ファイルに関連付けられている場合はtrue。

  • ルールが索引ベースの場合はtrue、ルールが標準の場合はfalse。索引ベースのルール(BPMルールとも呼ばれる)は、標準ルールとは構造が異なります。フィールドは任意の順序で配置できます。たとえば、世代2を世代1の前に配置することも、世代1のプロパティを実際の世代1の列の前に配置することもできます。索引ベースのルールは、列の操作(結合、分割および移動)をサポートしていませんが、フィールド式を使用して同じことができます。

ネストされたスキーマ : items
型: array
ソースの表示
ネストされたスキーマ : columnOperations
型: array

フィールド・レベルで実行できるルールの操作。たとえば、レコード内の新しい位置にフィールドを移動できます。

ソースの表示
  • ColumnOperation

    フィールド・レベルで実行できるルールの操作。たとえば、レコード内の新しい位置にフィールドを移動できます。

ネストされたスキーマ : DataLoadOptions
型: object

フィールド内のデータに対して実行できるルールの操作。たとえば、データが既存の値にどのように影響するかの変更、値のクリア、符号の反転などです。ディメンション構築ルールには適用できません。

ソースの表示
  • clearCombinations

    データのロード中にクリアするテキスト値の配列。

  • 指定可能な値: [ "NONE", "OVERWRITE", "ADD", "SUBTRACT" ]

    新しくロードされたデータ値が既存のデータ値にどのように影響を及ぼすかを指定するデータ・ロード・オプション。デフォルトでは、Essbaseではキューブの既存の値がソース・データの値で上書きされます。たとえば、週次値をロードした場合、ADDオプションを指定してキューブ内に月次値を作成できます。

  • 符号を反転するディメンション名。データ・フィールドの値をリバース(反転)するには、その符号を反転します。符号反転は、signFlipUDAで指定したUDA (ユーザー定義属性)に基づきます。たとえば、勘定科目ディメンションにデータをロードするとき、その勘定科目メンバーに費用のUDAが含まれるレコードでプラス符号がマイナス符号に変更されるように指定できます。

  • 符号を反転するUDA (ユーザー定義属性)。データ・フィールドの値をリバース(反転)するには、その符号を反転します。signFlipDimensionも指定します。

ネストされたスキーマ : DataSource
型: object

ディメンション構築ルールまたはデータ・ロード・ルールの一般ソース・プロパティ。ソース・データに対するルールの動作を大まかに設定するために使用します。

ソースの表示
  • FileProperties

    フラット・ファイルまたはExcelファイルに関連付けられたルールに設定できるファイル・プロパティ。たとえば、デリミタ、幅(固定幅レコードの場合)、ヘッダーと最初にロードするレコードを示すレコード番号などです。

  • ソース・データで使用されているヘッダー文字列(わかっている場合)。これは、ディメンション構築またはデータ・ロード時にスキップされます。

  • SQLProperties

    SQLプロパティを使用すると、RDBMSなどの外部システムに接続して、問合せを使用してリレーショナル・システムからデータを抽出できます。

  • tokens

    レコードに指定されたトークンが含まれている場合、ディメンション構築中またはデータ・ロード中にソース・データ・レコードを無視します。トークンとは、ソース・データ内の1つの区切り文字列です。複数のトークンを指定する場合は、必ずトークンを区切り、tokensCombineOptionを指定してください。スペースで区切られたトークンの例: "tokens" : [ "&& UNDEFINED" ]

  • 指定可能な値: [ "AND", "OR" ]

    無視するトークンを複数リストした場合、Essbaseですべてのトークンが含まれるレコードのみを無視するにはANDを指定します。Essbaseでいずれかのトークンが含まれるレコードを無視するにはORを指定します。

ネストされたスキーマ : DimBuildOptions
型: object

ディメンション構築ルールに組み込まれているすべてのディメンションに影響するグローバル・プロパティ。

ソースの表示

  • ソース・データからの新しい別名で更新する別名表を選択します。指定しない場合、ディメンション構築ではデフォルトの別名表が更新されます。

  • trueに設定すると、計算のパフォーマンスのためにディメンションが砂時計の順序で配置されます。ブロック・ストレージ・キューブにのみ適用できます。順序: 1- 最も密なディメンション(勘定科目および時間)、2- 残りの密ディメンション(最大から最小)、3- 疎ディメンション(最小から最大)、4- 属性ディメンション。

  • trueに設定すると、Essbaseによってディメンションが密または疎として自動的に割り当てられます。デフォルトでは、密/疎の設定は、既存の設定またはディメンション構築ルールで指定された設定として保持されます。ブロック・ストレージ・キューブにのみ適用できます。

  • smartLists

    テキスト・リスト・オブジェクト(スマート・リストとも呼ばれる)を追加または更新する配列。テキスト・リスト・オブジェクトは、自分の勘定科目ディメンションがテキスト・メジャーを使用するように設計され、アウトラインが型付きメジャーに対して有効になっている場合に、メトリックをテキスト値として格納する方法です。テキスト・メジャー・ディメンションを使用するサンプル・キューブを表示するには、Filesカタログのギャラリ選択で入手できるサンプル・アプリケーションFacility Ratingをインポートします。

ネストされたスキーマ : dimensions
型: array

ディメンションごとに定義されたプロパティ。ディメンションに対するルールの動作を設定します。

ソースの表示
ネストされたスキーマ : EditorOptions
型: object
ソースの表示
ネストされたスキーマ : EssbaseInfo
型: object
ソースの表示
ネストされたスキーマ : fields
型: array

特定のフィールドに関する情報に加えて、すべてのフィールドの一般的なプロパティを含むフィールド情報の配列。

ソースの表示
  • Field

    レコード・レベルでロード・ルールの操作を実行するためのフィールド・プロパティ。たとえば、キューブにレコードをロードする前に、特定のレコードを選択または拒否するようにフィルタできます。

ネストされたスキーマ : ColumnOperation
型: object

フィールド・レベルで実行できるルールの操作。たとえば、レコード内の新しい位置にフィールドを移動できます。

ソースの表示
ネストされたスキーマ : clearCombinations
型: array

データのロード中にクリアするテキスト値の配列。

ソースの表示
ネストされたスキーマ : FileProperties
型: object

フラット・ファイルまたはExcelファイルに関連付けられたルールに設定できるファイル・プロパティ。たとえば、デリミタ、幅(固定幅レコードの場合)、ヘッダーと最初にロードするレコードを示すレコード番号などです。

ソースの表示
ネストされたスキーマ : SQLProperties
型: object

SQLプロパティを使用すると、RDBMSなどの外部システムに接続して、問合せを使用してリレーショナル・システムからデータを抽出できます。

ソースの表示

  • Essbaseアプリケーション名(別のEssbaseキューブに接続する場合)。

  • Essbaseデータベース名(別のEssbaseキューブに接続する場合)。

  • 問合せのFROM句(FROMを除く)。

  • 問合せのSELECT句(SELECTを除く)。

  • SQLベースの接続を確立するための接続文字列またはデータソース情報。データソースの例: REST;URL=LOCAL;DS=Orcl_DS。SIDを持つOracle Databaseの場合: oracle://somedb99:1521/orcl。サービス名を持つOracle Databaseの場合: ORACLESERVICE:oracle://somedb99:1234/esscs.host1.oraclecloud.com。Microsoft SQL Serverの場合: sqlserver://myMSSQLHost:1433:myDbName。MySQLの場合: mysql://HostName:3306:DBName。Teradataの場合: teradata://192.0.2.110:1025/myDBName。IBM DB2の場合: db2://myDB2Host:1234:myDbName。

  • 問合せのWHERE句(WHEREを除く)。

ネストされたスキーマ : tokens
型: array

レコードに指定されたトークンが含まれている場合、ディメンション構築中またはデータ・ロード中にソース・データ・レコードを無視します。トークンとは、ソース・データ内の1つの区切り文字列です。複数のトークンを指定する場合は、必ずトークンを区切り、tokensCombineOptionを指定してください。スペースで区切られたトークンの例: "tokens" : [ "&& UNDEFINED" ]

ソースの表示
ネストされたスキーマ : smartLists
型: array

テキスト・リスト・オブジェクト(スマート・リストとも呼ばれる)を追加または更新する配列。テキスト・リスト・オブジェクトは、自分の勘定科目ディメンションがテキスト・メジャーを使用するように設計され、アウトラインが型付きメジャーに対して有効になっている場合に、メトリックをテキスト値として格納する方法です。テキスト・メジャー・ディメンションを使用するサンプル・キューブを表示するには、Filesカタログのギャラリ選択で入手できるサンプル・アプリケーションFacility Ratingをインポートします。

ソースの表示
ネストされたスキーマ : SmartList
型: object
ソースの表示
ネストされたスキーマ : Dimension
型: object
ソースの表示

  • アウトラインにまだ存在しない新しいディメンションの場合は、trueに設定します。trueの場合、新しいディメンションがディメンション構築中に作成されます。falseの場合、新しいディメンションのディメンション構築は失敗します。

  • 指定可能な値: [ "GENERATION", "SIBLING_LOWEST_LEVEL", "CHILD", "SIBLING_MATCHING_STRING", "LEVEL", "PARENT_CHILD", "GEN_NULLS", "LEVEL_NULLS" ]

    このディメンションに含まれるディメンション、メンバーおよび別名を追加、変更または削除する構築方法アルゴリズム。ソース・データのプロパティに基づいている必要があります。たとえば、各レコードで親、その後に子メンバーをこの順序で指定している場合、PARENT_CHILDが適切な方法です。

  • 指定可能な値: [ "NOTOK", "OK", "IGNORE", "GEN2", "NOTGEN2" ]

    メンバーおよびその子を新しい親に移動できるようにする場合はOKに設定し、Essbaseがプライマリ・メンバーを認識してそれらをソース・データと照合できるようにします。重複メンバーのアウトラインには使用できません。updateOption = RESET_DIMENSIONの場合は、NOTOKのままにします。

  • AttributeOptions
  • 指定可能な値: [ "EXISTING", "DENSE", "SPARSE" ]

  • Essbaseで属性メンバーを作成できるようにするには、trueに設定します。falseの場合、Essbaseでは属性メンバーを作成できません。

  • ディメンションの解決順。

  • generations
  • 指定可能な値: [ "EXISTING", "MULTIPLE", "STORED", "DYNAMIC" ]

    このディメンションで複数の階層を有効にする必要がある場合はMULTIPLE (集約ストレージ・キューブにのみ適用可能)。設定をそのままにする場合はEXISTING。集約ストレージ保存階層タイプ(式なし)の場合はSTORED。式を使用して集約する集約ストレージ階層タイプ(勘定科目ディメンションを含む)の場合はDYNAMIC。

  • Essbaseがソース・データからのすべてのメンバーを処理および追加した後にメンバーをソートする場合は、trueに設定します。

  • levels
  • MeasureOptions

    主に勘定科目ディメンションに関連するロード・ルール定義プロパティ。

  • 子を追加する親メンバーの名前。「次の子として追加」構築方法とともに使用します。

  • ディメンションに共有メンバーが含まれる場合はtrueに設定します。

  • ディメンションまたはメンバーが計算される優先度(0から127)。解決順の値が大きいほどそのメンバーは後で計算されることになります。解決順が割り当てられていないメンバーは、そのディメンションから解決順を継承します。

  • 指定可能な値: [ "NONE", "ASCENDING", "DESCENDING" ]

    このディメンションの階層内の子をソートするかどうかと、ソート方法: なし(ソートしない)、昇順または降順。

  • 指定可能な値: [ "EXISTING", "STORE", "NEVER_SHARE", "LABEL_ONLY", "DYNAMIC_CALC_STORE", "DYNAMIC_CALC" ]
  • 指定可能な値: [ "EXISTING", "NONE", "ACCOUNTS", "TIME", "COUNTRY", "ATTRIBUTES" ]
  • 指定可能な値: [ "EXISTING", "UNIQUE", "DUPLICATE", "NONE" ]
  • 指定可能な値: [ "MERGE", "REMOVE_UNSPECIFIED", "RESET_DIMENSION" ]

    増分ディメンション構築の更新オプション。増分ディメンション構築は、メンバーの追加、移動、削除および順序変更によって既存のディメンションを更新するプロセスです。MERGE (デフォルト)では、新しいメンバーを追加しますが、既存のメンバーも保持します。REMOVE_UNSPECIFIEDでは、ソースで指定されていないメンバーを削除します(addMemberOption = GENERATION、LEVELまたはPARENT_CHILDの場合のみ使用可能)。メンバーの削除によってレベル0の式のない動的計算メンバーになる場合、アウトラインは無効です。RESET_DIMENSIONは、インデックスベースのルール(つまり、studio = true)にのみ使用可能です。ディメンションのリセットは、ディメンション全体を再構築します。このオプションでは、増分ディメンション構築中の挿入、順序変更、移動および削除操作を使用可能にし、階層内のメンバーの配置を最後に移動するのではなく、そのままにします。ディメンションのリセットを使用するには、allowMovesをNOTOKにする必要があります。そうしないと、共有階層を構築できません。

ネストされたスキーマ : AttributeOptions
型: object
ソースの表示
ネストされたスキーマ : generations
型: array
ソースの表示
ネストされたスキーマ : levels
型: array
ソースの表示
ネストされたスキーマ : MeasureOptions
型: object

主に勘定科目ディメンションに関連するロード・ルール定義プロパティ。

ソースの表示

  • ディメンションが通貨換算アプリケーションに関連付けられている場合は、通貨カテゴリ。これは通貨キューブからの勘定科目メンバーです。例: P&L。

  • 指定可能な値: [ "EXISTING", "NONE", "CATEGORY", "NO_CONVERSION" ]

    ディメンション構築中に実行する通貨換算アクション。通貨換算しないメンバーにはNO_CONVERSIONのマークを付けます。NONEは、換算しないことを示すのではなく、換算カテゴリが未指定である(つまり、継承される)ことを示します。

  • ディメンションが通貨換算アプリケーションに関連付けられている場合は、通貨名。これは通貨キューブからの国ディメンション・タイプ・メンバーです。例: USD、CND、GPB、EUR

  • 指定可能な値: [ "NONE", "NA", "MISSING", "ZERO", "MISSING_ZERO" ]

    timeBalanceOptionをFIRST、LASTまたはAVERAGEとして設定する場合は、スキップ・プロパティを使用して、欠落値またはゼロ値が出現した場合の親値の計算方法を示します。NONE: 親値を計算するときにデータをスキップしません。MISSING: #MISSINGデータをスキップします。ZERO: ゼロに等しい値をスキップします。MISSING_ZERO: #MISSINGデータとゼロに等しいデータをスキップします。

  • 指定可能な値: [ "EXISTING", "NONE", "FIRST", "LAST", "AVERAGE" ]

    タイム・バランス・プロパティ(使用する場合)。デフォルトでは、時間ディメンション内の親はその子の集計および式に基づいて計算されます。たとえば、Sample.Basicデータベースでは、Qtr1メンバーはその子(Jan、FebおよびMar)の合計です。ただし、タイム・バランス・プロパティを設定すると、親(たとえば、Qtr1)は異なる方法でロールアップされます。

  • 2パス計算を使用するとしてディメンションにマークを付ける場合はtrue。

  • 指定可能な値: [ "EXISTING", "NON_EXPENSE", "EXPENSE" ]

    勘定科目メンバーを費用アイテムとして処理します。現在の設定を保持する場合はEXISTING。

ネストされたスキーマ : indepDimensions
型: array
ソースの表示
ネストされたスキーマ : IndepDimension
型: object
ソースの表示
ネストされたスキーマ : Level
型: object
ソースの表示
ネストされたスキーマ : Field
型: object

レコード・レベルでロード・ルールの操作を実行するためのフィールド・プロパティ。たとえば、キューブにレコードをロードする前に、特定のレコードを選択または拒否するようにフィルタできます。

ソースの表示
  • 指定可能な値: [ "NOOP", "LOWER_CASE", "UPPER_CASE", "FIRST_CAPITAL_CASE" ]

    Essbaseへのロード中に受信データに対して実行する大/小文字の変換操作を選択します。NOOP: 変換を実行しません。LOWER_CASE: 大文字を小文字に変換します。UPPER_CASE: 小文字を大文字に変換します。FIRST_CAPITAL_CASE: 最初の文字を大文字に、残りの文字を小文字に変換します。

  • Essbaseへのロード中にソース・データのフィールドのスペースをアンダースコアに変換します。

  • FieldDataLoadOptions

    データ・ロード・ルールに設定できるフィールド・レベルのオプション。たとえば、Essbaseでは、ソース・データのフィールドを無視、再スケーリングおよび抽出できます。

  • フィールドの日付フォーマット(該当する場合)。

  • FieldDimBuildOptions

    ディメンション構築ルールに設定できるフィールド・レベルのオプション。たとえば、Essbaseではフィールドを無視、分割、結合および再配置できます。

  • フィールドの接頭辞(該当する場合)。

  • 指定可能な値: [ "AND", "OR" ]

    複数拒否フィルタを定義する場合は、論理結合演算子(ANDまたはOR)を選択します。ANDは、定義した拒否基準のすべてに適合する必要があることを意味します(いずれかの基準が所定のレコードに対して満たされない場合、そのレコードにはフィルタが適用されません)。「OR」は、その逆を意味します(いずれかの基準が所定のレコードで満たされる場合は、フィルタが適用されます)。

  • rejectFilters

    Essbaseキューブへのロード中にデータ・ロード・レコードまたはディメンション構築レコードを省略するための拒否フィルタ基準。フィルタ処理のオプションには、特定の値の文字列一致または数値一致、論理結合オプションおよび大文字と小文字の区別があります。

  • replaceInformation

    置換値の指定(Essbaseにレコードをロードする際に、ソース・レコード内の値を検索して置換するためのフィルタが設計されている場合)。

  • 指定可能な値: [ "AND", "OR" ]

    複数選択フィルタを定義する場合は、論理結合演算子(ANDまたはOR)を選択します。ANDは、定義した選択基準のすべてに適合する必要があることを意味します(いずれかの基準が所定のレコードに対して満たされない場合、そのレコードにはフィルタが適用されません)。「OR」は、その逆を意味します(いずれかの基準が所定のレコードで満たされる場合は、フィルタが適用されます)。

  • selectFilters

    Essbaseキューブへのロード中にデータ・ロード・レコードまたはディメンション構築レコードを承認するための選択フィルタ基準。フィルタ処理のオプションには、特定の値の文字列一致または数値一致、論理結合オプションおよび大文字と小文字の区別があります。

  • フィールドに関連付けられているテキスト・リスト・オブジェクト(スマート・リスト) (該当する場合)。

  • フィールドの接尾辞(該当する場合)。

  • Transform

    索引ベースのディメンション構築ルールで使用できるデータ処理の変換オプション。タイプは、COLUMN、部分文字列関数のSUBSTR、結合のCONCAT、静的文字列のSTATICSTR、またはIGNOREです。次の索引ベースのルール変換の指定は、join(column0,column1)のフィールド式を使用するEssbase Webインタフェースと同じです。"transform" : {"type": "CONCAT", "nodes": [ {"type": "COLUMN", "index" : 0}, {"type": "COLUMN", "index": 1}]}}。

  • Essbaseメンバー名に正しくマップされるように、ソース・データのフィールドから先頭スペースおよび末尾スペースを削除します。

  • フィールドの幅(該当する場合) (ソース・データのフィールドが固定幅の場合)。

ネストされたスキーマ : FieldDataLoadOptions
型: object

データ・ロード・ルールに設定できるフィールド・レベルのオプション。たとえば、Essbaseでは、ソース・データのフィールドを無視、再スケーリングおよび抽出できます。

ソースの表示

  • trueに設定すると、フィールドがデータ(非メタデータ)フィールドであることを示します。

  • このデータソース列を無視します(ロードしません)。

  • 重複メンバーのアウトラインについては、ディメンションとreferOptionを指定します。referOptionでは、Essbaseがフィールドのマッピングに使用する構築方法(レベル参照または世代参照)を指定します。

  • 重複メンバーのアウトラインについては、referOptionとともに使用して、ソース・データのフィールドの想定される世代番号またはレベル番号を指定します。

  • 重複メンバーのアウトラインについては、Essbaseがフィールドのマッピングに使用する構築方法(レベル参照または世代参照)を示すreferOptionを指定します。フィールドがソース・データ内でボトムアップ順に編成されている場合は、レベル参照を使用します。フィールドがソース・データ内でトップダウン順に編成されている場合は、世代参照を使用します。

  • データ・フィールドにのみ適用できます。ソース・データの値をキューブに格納されている値のスケールと一致するようにスケーリングする場合は、trueに設定します。scalingfactorとともに使用する必要があります。

  • scaleがtrueに設定されている場合に、データ・フィールドにのみ適用できます。スケール変更係数(ソース・データの値が、キューブの値と同じスケールでない場合)。たとえば、売上高の実際の値が$5,460であるとします。Salesソース・データが値を100単位で追跡する場合、この値は54.6になります。Essbaseキューブが実際の値を追跡する場合、Salesソース・データから取得した値(54.6)に100を乗算して、Essbaseキューブで値(5460)が正しく表示されるようにします。

  • 指定可能な値: [ "MIN", "MAX", "AVG", "SUM", "COUNT" ]

    特定の方法でソース・データを抽出する列レベルのオプション。データ・フィールドにのみ適用できます。MINは、既存のキューブ・データとの比較を含めて、受信データの最小値を保管します。MAXは、最大値を保管します。SUMは、ADDグローバル・オプションと同様に動作し、受信データを既存のキューブ・データに追加します。COUNTは、受信データに存在する値の件数を保管します。

ネストされたスキーマ : FieldDimBuildOptions
型: object

ディメンション構築ルールに設定できるフィールド・レベルのオプション。たとえば、Essbaseではフィールドを無視、分割、結合および再配置できます。

ソースの表示
ネストされたスキーマ : rejectFilters
型: array

Essbaseキューブへのロード中にデータ・ロード・レコードまたはディメンション構築レコードを省略するための拒否フィルタ基準。フィルタ処理のオプションには、特定の値の文字列一致または数値一致、論理結合オプションおよび大文字と小文字の区別があります。

ソースの表示
ネストされたスキーマ : replaceInformation
型: array

置換値の指定(Essbaseにレコードをロードする際に、ソース・レコード内の値を検索して置換するためのフィルタが設計されている場合)。

ソースの表示
ネストされたスキーマ : selectFilters
型: array

Essbaseキューブへのロード中にデータ・ロード・レコードまたはディメンション構築レコードを承認するための選択フィルタ基準。フィルタ処理のオプションには、特定の値の文字列一致または数値一致、論理結合オプションおよび大文字と小文字の区別があります。

ソースの表示
ネストされたスキーマ : Transform
型: object

索引ベースのディメンション構築ルールで使用できるデータ処理の変換オプション。タイプは、COLUMN、部分文字列関数のSUBSTR、結合のCONCAT、静的文字列のSTATICSTR、またはIGNOREです。次の索引ベースのルール変換の指定は、join(column0,column1)のフィールド式を使用するEssbase Webインタフェースと同じです。"transform" : {"type": "CONCAT", "nodes": [ {"type": "COLUMN", "index" : 0}, {"type": "COLUMN", "index": 1}]}}。

ソースの表示
ネストされたスキーマ : AttributeBuildProperties
型: object

数値範囲を使用する属性ディメンションのディメンション構築プロパティ。

ソースの表示
ネストされたスキーマ : endIndepColumns
型: array
ソースの表示
ネストされたスキーマ : startIndepColumns
型: array
ソースの表示
ネストされたスキーマ : Filter
型: object
ソースの表示
  • 指定可能な値: [ "EQUAL_TO", "NOT_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL_TO", "LESS_THAN", "LESS_THAN_EQUAL_TO", "CONTAIN", "DOES_NOT_CONTAIN" ]

    選択フィルタまたは拒否フィルタの論理条件。

  • trueの場合は条件は文字列一致に適用され、falseの場合は条件は数値に適用されます。

  • 指定可能な値: [ "REJECT", "SELECT" ]

    フィルタのタイプ: レコードのロードを承認するための条件でフィルタが定義されている場合はSELECT。レコードのロードを拒否するための条件でフィルタが定義されている場合はREJECT。

ネストされたスキーマ : ReplaceInfo
型: object
ソースの表示
ネストされたスキーマ : nodes
型: array
ソースの表示
  • Transform

    索引ベースのディメンション構築ルールで使用できるデータ処理の変換オプション。タイプは、COLUMN、部分文字列関数のSUBSTR、結合のCONCAT、静的文字列のSTATICSTR、またはIGNOREです。次の索引ベースのルール変換の指定は、join(column0,column1)のフィールド式を使用するEssbase Webインタフェースと同じです。"transform" : {"type": "CONCAT", "nodes": [ {"type": "COLUMN", "index" : 0}, {"type": "COLUMN", "index": 1}]}}。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

200 レスポンス

OK

ルール・ファイルのデータが正常にプレビューされました。

本体()
ルート・スキーマ : RulePreviewOutput
型: object
ソースの表示
ネストされたスキーマ : data
型: array
ソースの表示
ネストされたスキーマ : items
型: array
ソースの表示

400 レスポンス

不正なリクエスト

このルール・ファイルからこのデータをプレビューできませんでした。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、データ・ロード・ルールまたはディメンション構築ルールのファイル定義をプレビューする方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

プレビュー: 最下位レベルの兄弟としてのメンバーの追加

cURLコマンドを使用したスクリプト

次のスクリプトは、Sample Basicのディメンション構築ルールをプレビューします。このルールは、構築タイプSIBLING_LOWEST_LEVELを使用して、メジャー・ディメンションに新しいメンバー(A100-10およびA100-99)を追加するように設計されています。

call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/utils/rules/preview -H "Accept:application/json" -H "Content-Type:application/json" --data "@./siblow.json"-u %User%:%Password%

サンプルのJSONペイロード

前述のcURLの例では、ルールをプレビューするsiblow.jsonで次のJSONペイロードが提供されます。このペイロードは、データ・レコードの配列で構成され、その後にまだ作成されていないロード・ルールの作業中定義が続きます。 

{
	"data": [
		[
			"100-10",
			"Texas",
			"A100-10",
			"",
			"100",
			"120",
			"100"
		],
		[
			"200-20",
			"Texas",
			"A100-99",
			"",
			"111",
			"154",
			"180"
		]
	],
	"rules": {
		"columnOperations": [],
		"fields": [
			{
				"dimensionBuildOptions": {
					"attributeDimension": "",
					"dimension": "Measures",
					"generation": -1,
					"ignore": true,
					"refer": 0
				},
				"field": 0,
				"trim": true,
				"type": "SIBLING_LOWEST_LEVEL"
			},
			{
				"dimensionBuildOptions": {
					"attributeDimension": "",
					"dimension": "Measures",
					"generation": -1,
					"ignore": true,
					"refer": 0
				},
				"field": 1,
				"trim": true,
				"type": "SIBLING_LOWEST_LEVEL"
			},
			{
				"dimensionBuildOptions": {
					"attributeDimension": "",
					"dimension": "Measures",
					"generation": -1,
					"refer": 0
				},
				"field": 2,
				"trim": true,
				"type": "SIBLING_LOWEST_LEVEL"
			},
			{
				"dimensionBuildOptions": {
					"attributeDimension": "",
					"dimension": "Measures",
					"generation": -1,
					"ignore": true,
					"refer": 0
				},
				"field": 3,
				"trim": true,
				"type": "SIBLING_LOWEST_LEVEL"
			},
			{
				"dimensionBuildOptions": {
					"attributeDimension": "",
					"dimension": "Measures",
					"generation": -1,
					"ignore": true,
					"refer": 0
				},
				"field": 4,
				"trim": true,
				"type": "SIBLING_LOWEST_LEVEL"
			},
			{
				"dimensionBuildOptions": {
					"attributeDimension": "",
					"dimension": "Measures",
					"generation": -1,
					"ignore": true,
					"refer": 0
				},
				"field": 5,
				"trim": true,
				"type": "SIBLING_LOWEST_LEVEL"
			}
		]
	}
}

サンプルのJSONレスポンス

このREST APIでは、次のプレビューが返されます。

{
  "data" : [ [ "100-10", "Texas", "A100-10", "", "100", "120" ], [ "200-20", "Texas", "A100-99", "", "111", "154" ] ]
}

プレビュー: メンバーと属性の関連付けの追加

cURLコマンドを使用したスクリプト

次のスクリプトは、Sample Basicのディメンション構築ルールをプレビューします。このルールは、新しいメンバー(500、500-10および500-20)をProductディメンションに追加し、数値属性メンバー(64)をOuncesディメンションに追加し、属性と基本メンバーの関連付けを作成するように設計されています。

call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/utils/rules/preview -H "Accept:application/json" -H "Content-Type:application/json" --data "@./attrprod.json"-u %User%:%Password%

サンプルのJSONペイロード

前述のcURLの例では、ルールをプレビューするattrprod.jsonで次のJSONペイロードが提供されます。このペイロードは、データ・レコードの配列で構成され、その後にまだ作成されていないロード・ルールの作業中定義が続きます。 

{
	"data": [
		[
			"500",
			"500-10",
			"64",
			"True"
		],
		[
			"500",
			"500-20",
			"64",
			"False"
		]
	],
	"rules": {
		"columnOperations": [],
		"fields": [
			{
				"dimensionBuildOptions": {
					"attributeDimension": "",
					"dimension": "Product",
					"generation": 2,
					"generationType": "GENERATION",
					"refer": 0
				},
				"field": 0,
				"fieldWidth": 13.625,
				"generationOrLevelName": "",
				"generationOrLevelUnique": false,
				"trim": true,
				"type": "GENERATION"
			},
			{
				"dimensionBuildOptions": {
					"attributeDimension": "",
					"dimension": "Product",
					"generation": 3,
					"generationType": "GENERATION",
					"refer": 0
				},
				"field": 1,
				"fieldWidth": 13.125,
				"generationOrLevelName": "",
				"generationOrLevelUnique": false,
				"trim": true,
				"type": "GENERATION"
			},
			{
				"dimensionBuildOptions": {
					"attributeDimension": "Ounces",
					"dimension": "Product",
					"generation": 3,
					"generationType": "ATTRIBUTE_MEMBER",
					"refer": 0
				},
				"field": 2,
				"fieldWidth": 16.375,
				"trim": true,
				"type": "GENERATION"
			},
			{
				"dimensionBuildOptions": {
					"attributeDimension": "Caffeinated",
					"dimension": "Product",
					"generation": 3,
					"generationType": "ATTRIBUTE_MEMBER",
					"refer": 0
				},
				"field": 3,
				"fieldWidth": 24.125,
				"trim": true,
				"type": "GENERATION"
			}
		]
	}
}

サンプルのJSONレスポンス

このREST APIでは、次のプレビューが返されます。

{
  "data" : [ [ "500", "500-10", "64", "True" ], [ "500", "500-20", "64", "False" ] ]
}
先頭に戻る