runIntegration

データをOracle Enterprise Performance Management Cloudビジネス・プロセスにインポートするか、ビジネス・プロセスから外部システムにエクスポートするには、データ統合ジョブを実行します。

このコマンドにより、runDataRuleコマンドが非推奨になります。runDataRuleコマンドではなくこのコマンドの使用を開始することをお薦めします。

適用対象

Planning、Planningモジュール、フリーフォーム、Financial Consolidation and Close、Tax Reporting、Account Reconciliation、Profitability and Cost Management、Enterprise Profitability and Cost Management、Sales PlanningおよびStrategic Workforce Planning。

必要な役割

「サービス管理者」、「パワー・ユーザー」

使用方法

epmautomate runIntegration JOB_NAME importMode=Append|Replace|"Map and Validate"|"No Import"|Direct exportMode=Merge|Replace|Accumulate|Subtract|"No Export"|Check periodName={PERIOD_NAME} [inputFileName=FILE_NAME] [PARAMETERS]
  • 標準モードの統合の場合は、importMode、exportModeおよびperiodNameの値を指定する必要があります
  • クイック・モードの統合の場合は、exportModeの値を指定する必要があります
  • パラメータ名とその値では大文字と小文字が区別されます
このコマンドのパラメータは次のとおりです:
  • JOB_NAMEは、データ統合に定義された統合ジョブ名です。
  • importModeは、データをデータ統合にインポートする方法を決定します。使用可能なインポート・モードは次のとおりです:
    • APPEND: データ統合の既存のPOVデータに追加します。
    • Replace: POVデータを削除してファイルからのデータで置換します。
    • Map and Validate: データのインポートをスキップし、更新されたマッピングおよびロジック勘定科目を使用してデータを再処理します。
    • No Import: データ統合のステージング表へのデータ・インポートをスキップします。
  • exportModeは、データをターゲット・アプリケーションにロードする方法を決定します。クイック・モードの統合の場合は、exportModeパラメータの値としてCheckおよびNo Exportを使用できません。使用可能なエクスポート・モードの値は次のとおりです:
    • Merge: 既存のデータを更新し、新しいデータを追加します。
    • Replace: POVの既存のデータをクリアし、新しいデータを使用してロードします。標準モードの場合、データがクリアされる対象は、シナリオ、バージョン、年、期間およびエンティティ・ディメンションです。クイック・モードの場合、データがクリアされる対象は、年、期間およびエンティティ・ディメンションです。両方のモードでカスタム領域のクリアを定義できます。
    • Accumulate: データを既存のデータに追加します。Planning、Planningモジュール、Financial Consolidation and Close、Tax Reporting、Profitability and Cost ManagementおよびEnterprise Profitability and Cost Managementに適用されます。
    • Subtract: データを既存の残高から削除します。Profitability and Cost ManagementおよびEnterprise Profitability and Cost Managementに適用されます。

      クイック・モード統合の場合:

      • このパラメータの値にCheckおよびNo Exportは使用できません。

      • Planning、PlanningモジュールおよびFinancial Consolidation and Closeの場合、有効な値はReplace、MergeおよびAccumulateのみです。

    • No Export: データ・エクスポートをスキップします。データをターゲット・アプリケーションにロードする前に確認のためにステージング表にロードするには、このモードを使用します。

    • Check: データの検証チェックのみを実行します。

      Oracle Fusion Cloudがターゲットの場合、次のエクスポート・モードのみサポートされます。

      • MERGE: データ統合のステージング表のデータを既存のデータとマージします
      • NONE: データ統合からアプリケーションへのデータ・エクスポートをスキップします
  • periodNameは、データをインポートまたはエクスポートする1つ以上の期間または期間範囲の名前で、それぞれを中カッコで囲みます。使用可能な期間の命名規則は次のとおりです:
    • 単一期間ロードの場合は、{Jan-21}のように、期間名を中カッコで囲んで指定します
    • 複数期間ロードの場合は、{Jan-21}{Mar-21} (1月21日から3月21日までのすべての期間のデータをロードする)のように、開始期間名と終了期間名を中カッコで囲みます
    • Planning、Planningモジュール、Financial Consolidation and Close、フリーフォームおよびTax Reportingの場合: ビジネス・プロセス期間名と年を{Jan#FY21}{Mar#FY21} (1月21日から3月21日までのすべての期間のデータをロードする)の形式で指定できます。

      期間名は、中カッコで囲む必要があります。

      • 単一期間—期間マッピングに定義されている単一期間のデータ管理期間名を参照します。
      • 複数期間—複数期間ロードを参照します。パラメータは、{Month-Year}{Month-Year}の形式で指定します。たとえば、1月20日から3月20日までの複数期間ロードの場合は、{Jan-20}{Mar-20}と指定します。
      • Planning期間名—{Month#Year}形式のPlanning期間名を参照します。たとえば、{Jan#FY20}{Mar#FY20}。この規則を使用すると、データ統合期間名を指定する必要がありません。かわりに、年ディメンションとシナリオ・ディメンションのメンバー名を指定する必要があります。

        このパラメータは、Planning、Tax ReportingおよびFinancial Consolidation and Closeビジネス・プロセスでサポートされています。オンプレミス・データ・ソースから導出されたサービス・アプリケーションとクラウド・デプロイメントの両方で機能します。

        この規則は、年および期間メンバー名をキャプチャしてEPM Cloud Groovyスクリプトからトリガーされた場合に使用すると便利です。期間マッピングのターゲット値の年と月を持つアプリケーション期間マッピングまたはグローバル期間マッピングが存在する必要があります。

      • 代替変数—前のPlanning期間名の拡張として、実際の年および月メンバー名のかわりに、{Month#&CurYr}{&FcstMonth#&CurYr}形式で代替変数を指定できるようにします。{Jan#&CurYr}{&FcstMonth#&CurYr}などです。

        実際のメンバー名と代替変数の両方を組み合せることがサポートされています。

        この形式は、Planning、Tax ReportingおよびFinancial Consolidation and Closeビジネス・プロセスでサポートされています。

        期間マッピングのターゲット値で使用可能な年と月の値を持つアプリケーション期間マッピングまたはグローバル期間マッピングが、コマンドが実行される環境のデータ統合に存在する必要があります。この場合、年および月は実行中の代替変数の現在の値を参照します。

      • グローバルPOV—グローバルPOV期間のデータ・ロードを実行します。{GLOBAL_POV}形式を使用します。

      Note:

      ここで説明されているパラメータ以外の期間名パラメータを使用した場合は、入力が無効です - HTTP 400というエラー・メッセージが表示されます。

      REST APIドキュメントからperiodNameセクションをコピーします。グローバルPOVやSubvarなどの様々な形式が説明されています。

    • {GLOBAL_POV}: システムのグローバルPOVまたはデータ統合のアプリケーション設定で定義されている期間のデータ・ロードを実行します。

      Note:

      期間命名規則の{Month#Year}という形式は、Planning、Planningモジュール、Financial Consolidation and CloseおよびTax Reportingでサポートされています。この規則では、データ統合期間名のかわりに、年およびシナリオ・ディメンションのメンバー名を指定できます。このアプローチは、コマンドが年および期間メンバー名をキャプチャしてGroovyスクリプトからトリガーされる場合に便利です。

      代替変数の{Jan#&CurYr}{&FcstMonth#&CurYr}という命名規則は、前の期間命名規則の拡張です。代替変数は、このコマンドをPlanning、Planningモジュール、Financial Consolidation and CloseおよびTax Reportingに対して実行する場合に、年および月メンバー名のかわりに指定できます。メンバー名と代替変数を組み合せることもサポートされています。

      前の期間名と代替変数の命名規則は、ターゲット値の年と月を持つアプリケーション期間マッピングまたはグローバル期間マッピングがデータ統合にすでに存在する場合にのみ機能します。
  • inputFileNameはファイルベースのデータ・ロード用で、受信ボックスで使用可能な、データのインポート元のファイル名を指定します。統合の定義でディレクトリ名を指定しない場合は、そのファイル名のみを渡します。統合の定義にディレクトリ名を含めない場合は、inbox/DIR_NAME/FILE_NAME形式を使用します。たとえば、inbox/GLBALANCES.txtまたはinbox/EBSGL/GLBALANCES.txtとします。ファイルが環境のデフォルトの場所にアップロードされた場合は、#epminbox/FILE_NAME規則を使用して入力データ・ファイルを識別します。たとえば、#epminbox/GLBALANCES.txtとします。

    このパラメータは、ネイティブ・ファイルベースのデータ・ロードにのみ適用されます。ファイルベースのデータ・ロードでこのパラメータ値を指定しない場合は、このコマンドによって、統合の定義に指定されているファイルからデータがインポートされます。ファイルベースではないデータ・ロードでこのパラメータ値を指定した場合は、無視されます。

  • PARAMETERSはオプションで、PARAMETER_NAME="PARAMETER"形式のランタイム・パラメータを指定します。パラメータにはソース・フィルタとターゲット・オプションの両方が含まれます。

    Note:

    現時点でディメンション(メタデータ)タイプのターゲット・アプリケーションに対して使用できる唯一のパラメータは"Refresh Database"=Yes|Noです。

例

  • 単一期間インポート:

    epmAutomate runIntegration VisionDataLoad importMode=Replace exportMode=Merge period="{Mar-15}"

  • 複数期間インポート:

    epmAutomate runIntegration VisionDataLoad importMode=Replace exportMode=Merge period="{Mar-15} {Jun-15}"

  • ファイルベースの増分データ統合:

    epmAutomate runIntegration IncrementalFileLoad importMode=Replace exportMode=Merge period="{Jan-20}{Mar-20}" inputFileName=File1.txt