機械翻訳について
  1. Oracle EssbaseのREST API
  2. タスク
  3. ジョブ

ジョブの実行

post

/essbase/rest/v1/jobs

ジョブを実行し、現在のジョブのジョブID、ステータス、入力、出力情報などのジョブ情報を含むレコードを返します。

要求

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

リクエスト本文でjson文字列として指定されたパラメータ。

ルート・スキーマ : JobsInputBean
タイプ: object
Show Source
ネストされたスキーマ : ParametersBean
タイプ: object
Show Source

  • trueの場合、データ・ロードは最初のエラーで停止します。 それ以外の場合、データ・ロードは続行されます。

  • LCMImportジョブ・タイプの場合。 使用するアーティファクト・リストの名前(LCMExportジョブでgenerateArtifactListがtrueの場合のみ有効)。

  • buildAggregationジョブ・タイプの場合。 trueの場合、収集されたユーザー問合せパターンに基づいて、Essbaseが選択するビューを集約します。 このオプションは、問合せトラッキングがオンになっている場合にのみ使用可能です。

  • bufferIds

  • exportExcelジョブ・タイプの場合。 有効な構築メソッドは、PARENT-CHILD (推奨されるメソッド)およびGENERATIONです。

  • importExcelジョブ・タイプの場合。 アプリケーションがすでにワークブックから作成されている場合は、ワークブックから追加のインポートを実行して更新を続行できます。 ワークブックから再度インポートする場合は、次の増分更新オプションを使用できます: NONE、RETAIN_ALL_DATAまたはREMOVE_ALL_DATA。

  • exportExcelジョブ・タイプの場合。 trueの場合、エクスポートに計算スクリプトが含まれます。

  • importExcelジョブ・タイプの場合。 ファイル・カタログ内のアプリケーション・ワークブックへのパス。 importExcelFileNameを使用してファイル名を指定します。

  • exportExcelまたはexportDataジョブ・タイプの場合。 trueの場合、キューブは表形式でエクスポートされます。それ以外の場合は、アプリケーション・ワークブックとしてエクスポートされます。 エクスポートされた表形式データには、Essbaseが新しいキューブをデプロイするために使用できるヘッダーを含む列に編成されたデータおよびメタデータが含まれます。 エクスポートされた表形式データには、アプリケーション・ワークブックより少ない情報が含まれます。

  • exportExcelまたはexportDataジョブ・タイプの場合。 trueの場合は、データを圧縮します。

  • dimbuildまたはdataloadジョブ・タイプ(useConnectionがtrueの場合)。 保存された接続の名前。

  • LCMExportジョブ・タイプの場合。 trueの場合、バックアップのコピーをサーバー・ストレージに保存します。

  • importExcelジョブ・タイプの場合。 trueの場合、キューブ・アーティファクトをキューブ・ディレクトリに作成します。

  • exportExcelジョブ・タイプの場合。 trueの場合、エクスポートにデータが含まれます。

  • exportExcelまたはexportDataジョブ・タイプの場合。 エクスポートするデータ量を示す定数です。 数値または対応する文字列値のいずれかを渡すことができます。0=ALL_DATA、1=UPPER_LEVEL_BLOCKS、2=NON_INPUT_BLOCKS、3=LEVEL_ZERO_BLOCKS、4=INPUT_LEVEL_DATA_BLOCKS

  • buildAggregationジョブ・タイプの場合。 trueの場合、Essbaseでビューの選択にセカンダリ階層(代替ロールアップ)を使用できます。

  • importExcelジョブ・タイプの場合。 trueの場合は、計算スクリプトを実行します。 定義で計算の実行がはいに設定されている計算ワークシートがアプリケーション・ワークブックに含まれている場合にのみ適用されます。

  • columnFormatがtrueの場合のexportDataジョブ・タイプ用。 動的に計算された疎メンバーを表形式データ・エクスポートに含めます。 これらはデフォルトでは含まれません。

  • データ・ロードまたはディメンション構築のソース・ファイル。

  • ディメンション構築用。 trueの場合、他のユーザー・アクティビティが進行中であってもディメンション構築を続行します。 これにより、アクティブなユーザー・セッションが取り消されます。

  • LCMExportジョブ・タイプの場合。 trueの場合、エクスポートされたアーティファクトのテキスト・ファイル・リストを生成します。 リストを使用して、インポートを制御できます。たとえば、インポート順序を制御するためのアーティファクトの順序の再配置や、インポートするリスト内のアイテムの列挙などです。

  • importExcelジョブ・タイプの場合。 アプリケーション・ワークブックのファイル名。 キューブ・ディレクトリにない場合は、catalogExcelPathを使用してパスを指定します。

  • LCMExportおよびLCMImportジョブ・タイプの場合。 trueの場合、グローバルに定義された接続およびデータソースをエクスポートまたはインポートの一部として含めます。

  • LCMImportジョブ・タイプの場合。 trueの場合、サーバー・ストレージに保存されているバックアップからインポートします。

  • importExcelジョブ・タイプの場合。 trueの場合は、データをロードします(ワークブックにデータ・ワークシートが含まれている場合)。 それ以外の場合は、メタデータのみがキューブにインポートされます。

  • データのクリア・ジョブ用。 クリア対象を指定するキーワード。 省略した場合、デフォルトのオプションはallDataです。 ブロック・ストレージ・キューブのオプションは次のとおりです: allData ??? すべてのデータ、リンクされたオブジェクトおよびアウトラインがクリアされます。upperLevel ??? 上位レベルのブロックはクリアされます。nonInput ??? 非入力ブロックはクリアされます。 集約ストレージ・キューブのオプションは次のとおりです: allData ??? すべてのデータ、リンクされたオブジェクトおよびアウトラインがクリアされます。allAggregations ??? すべての集計データがクリアされます。partialData ??? 指定したリージョン(partialDataExpressionパラメータで指定されたMDXリージョン)のみがクリアされます。

  • LCMExportおよびLCMImportジョブ・タイプの場合。 trueの場合は、既存のバックアップを上書きするか(LCMExportの場合)、既存のアプリケーションを上書きします(LCMImportの場合)。

  • dimbuildまたはdataloadジョブ・タイプで、useConnectionがfalseで、ジョブがRDBMSに接続するルール・ファイルを使用する場合。 RDBMSに接続できるユーザーのパスワード。

  • buildAggregationジョブ・タイプの場合。 停止値。 この値を使用して、集計ストレージ・キューブのマテリアライズ中に許可する増加サイズと、キューブの事前集計サイズの比率を指定します。 (集計がマテリアライズされる前は、キューブには入力レベルのデータのみが含まれます。) たとえば、キューブのサイズが1 GBの場合、1.2の停止値は、結果のデータのサイズが1.2 GBの合計サイズで1 GBの20%を超えることができないことを意味します。 停止値を指定しない場合は、このパラメータに0を入力します。

  • importExcelジョブ・タイプの場合。 trueの場合、アプリケーションがすでに存在する場合は再作成します。

  • ディメンション構築用。 キューブ内の既存のデータの保存オプション。 PRESERVE_ALL_DATA: すべての既存のデータ・ブロックを保持します(ブロック・ストレージ・キューブおよび集約ストレージ・キューブに有効)。 PRESERVE_NO_DATA: 既存のデータを破棄します(ブロック・ストレージおよび集約ストレージ・キューブに有効)。 PRESERVE_LEAFLEVEL_DATA: 既存のレベル・ゼロ・データの保持 (ブロック・ストレージのみ)。 PRESERVE_INPUT_DATA: 既存の入力レベル・データの保持 (ブロック・ストレージのみ)。

  • rtsv

  • オプションのルール・ファイル(ジョブがデータ・ロードまたはディメンション構築の場合)。

  • 計算実行用。 計算スクリプト名 .cscファイル拡張子が必要です。 フルパスを指定する必要はありません。 ファイルは、関連するキューブ・ディレクトリにあるとみなされます。

  • selectedDimensions

  • LCMExportジョブ・タイプの場合。 trueの場合、バックアップにデータを含めないでください。

  • LCMImportジョブ・タイプの場合。 インポート/リストア先のアプリケーション名のオプション指定(エクスポート/バックアップされたアプリケーション名と異なる場合)。

  • CompactDesignation

  • dimbuildまたはdataloadジョブ・タイプの場合。 trueの場合、保存済の接続を使用することを指定します(接続名を示すconnectionパラメータも渡す必要があります)。 falseで、ジョブがRDBMSに接続するルール・ファイルを使用する場合は、RDBMSに接続するためのユーザー名とパスワードを指定する必要があります。

  • dimbuildまたはdataloadジョブ・タイプで、useConnectionがfalseで、ジョブがRDBMSに接続するルール・ファイルを使用する場合。 RDBMSに接続できるユーザーの名前。

  • LCMExportおよびLCMImportジョブ・タイプの場合。 バックアップ・ファイルを保持する圧縮ファイルの名前。

ネストされたスキーマ : bufferIds
タイプ: array
Show Source
ネストされたスキーマ : rtsv
タイプ: array
Show Source
ネストされたスキーマ : selectedDimensions
タイプ: array
Show Source
ネストされたスキーマ : CompactDesignation
タイプ: object
Show Source
ネストされたスキーマ : RTSV
タイプ: object
Show Source
ネストされたスキーマ : value
タイプ: object
ネストされたスキーマ : compactDesignationColumn
タイプ: array
Show Source
ネストされたスキーマ : dateDimensionLeaves
タイプ: array
Show Source
ネストされたスキーマ : dimCompactDesignationList
タイプ: array
Show Source
ネストされたスキーマ : CompactDesignationColumn
タイプ: object
Show Source
ネストされたスキーマ : DimCompactDesignation
タイプ: object
Show Source
ネストされたスキーマ : attNames
タイプ: array
Show Source
ネストされたスキーマ : attribute
タイプ: array
Show Source
ネストされたスキーマ : colNames
タイプ: array
Show Source
ネストされたスキーマ : columnTypes
タイプ: array
Show Source
  • 許可される値: [ "TEXT", "INTEGER", "FLOAT", "TIME", "DATE", "BOOLEAN", "EMPTY", "UNKNOWN", "OUT_OF_RANGE" ]
ネストされたスキーマ : dimGenColumns
タイプ: array
Show Source
ネストされたスキーマ : genNames
タイプ: array
Show Source
ネストされたスキーマ : headerText
タイプ: array
Show Source
ネストされたスキーマ : uniqCount
タイプ: array
Show Source
先頭に戻る

レスポンス

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

200 レスポンス

OK

ジョブは正常に開始されました。 レスポンスで返されるジョブ情報。

本文()
ルート・スキーマ : JobRecordBean
タイプ: object
Show Source
ネストされたスキーマ : jobInputInfo
タイプ: object
許可される追加プロパティ
Show Source
ネストされたスキーマ : jobOutputInfo
タイプ: object
許可される追加プロパティ
Show Source
ネストされたスキーマ : additionalProperties
タイプ: object
ネストされたスキーマ : additionalProperties
タイプ: object

400 レスポンス

不正なリクエスト

アプリケーションが存在しないか、アプリケーション・パラメータが正しくない可能性があります。 または、データベースが存在しないか、データベース・パラメータが正しくない可能性があります。 または、nullの引数が渡された可能性があります。

500 レスポンス

内部サーバー・エラー。

503 レスポンス

サービスは使用できません

ネーミング例外またはサーバー例外。

先頭に戻る

例

次の例は、ジョブの実行方法を示しています。 これらの例では、cURLはWindowsシェル・スクリプト内からREST APIにアクセスします。

コール元のユーザーIDおよびパスワードは、properties.batで値が設定される変数です。

実行できるジョブは次のとおりです:

データのロード

次のcURLの例では、データ・ロード・ジョブの実行方法を示します。 少なくともデータベースの更新権限が必要です。 

call properties.bat
curl -X POST "https://192.0.2.1:443/essbase/rest/v1/jobs" 
     -H "accept: application/json" 
     -H "Content-Type: application/json" 
     -d "{ \"application\": \"Sample\", 
           \"db\": \"Basic\", 
           \"jobtype\": \"dataload\", 
           \"parameters\": 
            { \"file\": \"Data_Basic.txt\", 
              \"abortOnError\": \"true\" }
         }"
      -u %User%:%Password%

レスポンス本体の例

{
  "job_ID": 1346,
  "appName": "Sample",
  "dbName": "Basic",
  "jobType": "Data Load",
  "jobfileName": null,
  "userName": "admin",
  "startTime": 1574456694000,
  "endTime": 1574456694000,
  "statusCode": 100,
  "statusMessage": "In Progress",
  "jobInputInfo": {
    "dataFileName": "Data_Basic",
    "abortOnError": true,
    "useConnection": false
  },
  "jobOutputInfo": {
    "recordsProcessed": 0,
    "recordsRejected": 0,
    "errorMessage": ""
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "canonical",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "Job Status",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/1346",
      "method": "GET"
    }
  ]
}

ディメンションの構築

次のcURLの例は、ディメンション構築ジョブの実行方法を示しています。 少なくともデータベース・マネージャ権限が必要です。 

call properties.bat

curl -X POST "https://192.0.2.1:443/essbase/rest/v1/jobs" 
     -H  "accept: application/json" 
     -H  "Content-Type: application/json" 
     -d "{  \"application\": \"ASOSamp\",
            \"db\": \"Basic\",
            \"jobtype\": \"dimbuild\",
            \"parameters\": 
            {    \"file\": \"Dim_Products.txt\",
                 \"rule\": \"Products.rul\"  }
         }"
     -u %User%:%Password%

レスポンス本体の例

{
  "job_ID": 4,
  "appName": "ASOSamp",
  "dbName": "Basic",
  "jobType": "Dimension Build",
  "jobfileName": "Products",
  "userName": "power1",
  "startTime": 1574814746000,
  "endTime": 1574814746000,
  "statusCode": 100,
  "statusMessage": "In Progress",
  "jobInputInfo": {
    "rulesFileName": "Products",
    "dataFileName": "Dim_Products",
    "useConnection": false,
    "restructureOption": 1,
    "forceDimBuild": false
  },
  "jobOutputInfo": {
    "recordsProcessed": 0,
    "recordsRejected": 0,
    "errorMessage": ""
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "canonical",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "Job Status",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/4",
      "method": "GET"
    }
  ]
}

計算の実行

次のcURLの例は、計算スクリプトの実行方法を示しています。 少なくともデータベースの更新権限と、計算スクリプトへのプロビジョニングされたアクセス権が必要です。 前提条件: スクリプトを.cscファイルとしてキューブ・ディレクトリにアップロードします。 

call properties.bat
curl -X POST "https://192.0.2.1:443/essbase/rest/v1/jobs" 
     -H "accept: application/json" 
     -H "Content-Type: application/json" 
     -d "{ \"application\": \"Sample\", 
           \"db\": \"Basic\", 
           \"jobtype\": \"calc\", 
           \"parameters\": 
            { \"file\": \"CalcAll.csc\" }
         }"
      -u %User%:%Password%

レスポンス本体の例

{
  "job_ID": 1434,
  "appName": "Sample",
  "dbName": "Basic",
  "jobType": "Calc Execution",
  "jobfileName": null,
  "userName": "admin",
  "startTime": 1574733981000,
  "endTime": 1574733981000,
  "statusCode": 100,
  "statusMessage": "In Progress",
  "jobInputInfo": {},
  "jobOutputInfo": {
    "errorMessage": ""
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "canonical",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "Job Status",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/1434",
      "method": "GET"
    }
  ]
}

データのクリア

次のcURLの例では、キューブ・データをクリアするジョブの実行方法を示します。 少なくともデータベースの更新権限が必要です。 

call properties.bat

curl -X POST "https://192.0.2.1:443/essbase/rest/v1/jobs"
     -H "accept: application/json"
     -H "Content-Type: application/json"
     -d "{ \"application\": \"Sample\",
           \"db\": \"Basic\",
           \"jobtype\": \"clear\",
           \"parameters\": {
           \"option\": \"PARTIAL_DATA\",
           \"partialDataExpression\":\"{Feb}\"}
	 }"
-u %User%:%Password%

レスポンス本体の例

{
  "job_ID": 116,
  "appName": "Sample",
  "dbName": "Basic",
  "jobType": "Clear Data",
  "jobfileName": null,
  "userName": "dbupdater",
  "startTime": 1598329480000,
  "endTime": 1598329480000,
  "statusCode": 100,
  "statusMessage": "In Progress",
  "jobInputInfo": {
    "clearDataOption": "PARTIAL_DATA"
  },
  "jobOutputInfo": {
    "errorMessage": ""
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "canonical",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "Job Status",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/116",
      "method": "GET"
    }
  ]
}

アプリケーション・ワークブックからのキューブのインポート

次のcURLの例では、Excelアプリケーション・ワークブックからキューブをインポートするジョブの実行方法を示します。 少なくともパワー・ユーザー・ロールまたはアプリケーション・マネージャ権限が必要です。 

call properties.bat

curl -X POST "https://192.0.2.1:443/rest/v1/jobs" 
     -H  "accept: application/json" 
     -H  "Content-Type: application/json" 
     -d "{  \"application\": \"ASOSamp\",  
            \"db\": \"Basic\",  
            \"jobtype\": \"importExcel\",  
            \"parameters\": 
             {    \"loaddata\": \"false\",
                  \"overwrite\": \"true\",
                  \"deleteExcelOnSuccess\": \"false\",
                  \"catalogExcelPath\": \"/gallery/Applications/Demo Samples/Aggregate Storage/\",
                  \"importExcelFileName\": \"ASO_Sample.xlsx\",
                  \"recreateApplication\": \"true\",
                  \"createFiles\": \"true\"  }
         }"
     -u %User%:%Password%

レスポンス本体の例

{
  "job_ID": 2,
  "appName": "ASOSamp",
  "dbName": "Basic",
  "jobType": "Import Excel",
  "jobfileName": "ASO_Sample.xlsx",
  "userName": "power1",
  "startTime": 1574810127000,
  "endTime": 1574810127000,
  "statusCode": 100,
  "statusMessage": "In Progress",
  "jobInputInfo": {
    "catalogExcelPath": "/gallery/Applications/Demo Samples/Aggregate Storage/",
    "importExcelFileName": "ASO_Sample.xlsx",
    "isLoadData": false,
    "recreateApplication": true,
    "isCreateFiles": true,
    "isExecuteScript": false
  },
  "jobOutputInfo": {
    "errorMessage": ""
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "canonical",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "Job Status",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/2",
      "method": "GET"
    }
  ]
}

アプリケーション・ワークブックへのキューブのエクスポート

次のcURLの例では、キューブをExcelアプリケーション・ワークブックにエクスポートするジョブの実行方法を示します。 少なくともデータベース・マネージャ権限が必要です。 

call properties.bat
curl -X POST "https://192.0.2.1:443/essbase/rest/v1/jobs"
     -H  "accept: application/json"
     -H  "Content-Type: application/json"
     -d "{  \"application\": \"Sample\",
            \"db\": \"Basic\",
            \"jobtype\": \"exportExcel\",
            \"parameters\": 
             {
                  \"dataLevel\": \"ALL_DATA\",
                  \"columnFormat\": \"false\",
                  \"compress\": \"false\"  }
         }"
     -u %User%:%Password%

レスポンス本体の例

{
  "job_ID": 10,
  "appName": "Sample",
  "dbName": "Basic",
  "jobType": "Export Excel",
  "jobfileName": null,
  "userName": "admin",
  "startTime": 1575413474000,
  "endTime": 1575413474000,
  "statusCode": 100,
  "statusMessage": "In Progress",
  "jobInputInfo": {
    "calc": false,
    "data": false
  },
  "jobOutputInfo": {
    "errorMessage": ""
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "canonical",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "Job Status",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/10",
      "method": "GET"
    }
  ]
}

Get Job {id}からのレスポンスの例

{
  "job_ID": 10,
  "appName": "Sample",
  "dbName": "Basic",
  "jobType": "Export Excel",
  "jobfileName": null,
  "userName": "admin",
  "startTime": 1575413474000,
  "endTime": 1575413490000,
  "statusCode": 200,
  "statusMessage": "Completed",
  "jobInputInfo": {
    "calc": false,
    "data": false
  },
  "jobOutputInfo": {
    "errorMessage": "",
    "metadataFile": "/applications/Sample/Basic/Basic.xlsx"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/10",
      "method": "GET"
    },
    {
      "rel": "post",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/10",
      "method": "POST"
    }
  ]
}

LCMを使用したキューブのバックアップ

次のcURLの例では、キューブ・アーティファクトをライフサイクル管理(LCM) .zipファイルにバックアップするジョブの実行方法を示します。 少なくともアプリケーション・マネージャ権限が必要です。

このジョブ・タイプはEssbaseマシンの外部から実行できますが、LCMユーティリティはEssbaseマシンで実行する必要があります。

curl -X POST "https://192.0.2.1:443/essbase/rest/v1/jobs"
     -H  "accept: application/json"
     -H  "Content-Type: application/json"
     -d "{  \"application\": \"Sample\",
            \"jobtype\": \"lcmExport\",
            \"parameters\": 
             {
                  \"zipFileName\": \"Sample1.zip\",
                  \"skipdata\": \"true\",
                  \"include-server-level\": \"false\"  }
         }"
     -u %User%:%Password%

レスポンス本体の例

{
  "job_ID": 11,
  "appName": "Sample",
  "dbName": null,
  "jobType": "LCM Export",
  "jobfileName": "Sample1.zip",
  "userName": "appmanager",
  "startTime": 1575424208000,
  "endTime": 1575424208000,
  "statusCode": 100,
  "statusMessage": "In Progress",
  "jobInputInfo": {
    "lcmExportFileName": "Sample1.zip",
    "skipdata": true,
    "copyToStorage": false,
    "threads": 10,
    "include-server-level": false,
    "generateArtifactList": false,
    "filesystemcopy": false,
    "disasterRecovery": false,
    "verbose": false
  },
  "jobOutputInfo": {
    "errorMessage": "",
    "infoMessage": ""
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "canonical",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "Job Status",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/11",
      "method": "GET"
    }
  ]
}

Get Job {id}からのレスポンスの例

{
  "job_ID": 11,
  "appName": "Sample",
  "dbName": null,
  "jobType": "LCM Export",
  "jobfileName": "Sample1.zip",
  "userName": "appmanager",
  "startTime": 1575424208000,
  "endTime": 1575424228000,
  "statusCode": 200,
  "statusMessage": "Completed",
  "jobInputInfo": {
    "lcmExportFileName": "Sample1.zip",
    "skipdata": true,
    "copyToStorage": false,
    "threads": 10,
    "include-server-level": false,
    "generateArtifactList": false,
    "filesystemcopy": false,
    "disasterRecovery": false,
    "verbose": false
  },
  "jobOutputInfo": {
    "errorMessage": "",
    "infoMessage": "",
    "lcmExportFilePath": "/users/appmanager/Sample1.zip"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/11",
      "method": "GET"
    },
    {
      "rel": "post",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/11",
      "method": "POST"
    }
  ]
}

LCMによるキューブのリストア

次のcURLの例では、ライフサイクル管理(LCM) .zipファイルからキューブ・アーティファクトをリストアするジョブの実行方法を示します。 これを行うには、アプリケーションを作成したパワー・ユーザーまたはサービス管理者である必要があります。

このジョブ・タイプはEssbaseマシンの外部から実行できますが、LCMユーティリティはEssbaseマシンで実行する必要があります。

call properties.bat
curl -X POST "https://192.0.2.1:443/essbase/rest/v1/jobs"
     -H  "accept: application/json"
     -H  "Content-Type: application/json" 
     -d "{  \"jobtype\": \"lcmImport\",  
            \"parameters\": 
             {    \"zipFileName\": \"Sample1.zip\",
                  \"include-server-level\": \"false\",
                  \"targetApplicationName\": \"Sample_dup\",
                  \"overwrite\": \"true\"  }
         }"
     -u %User%:%Password%

レスポンス本体の例

{
  "job_ID": 12,
  "appName": null,
  "dbName": null,
  "jobType": "LCM Import",
  "jobfileName": "Sample1.zip",
  "userName": "admin",
  "startTime": 1575425649000,
  "endTime": 1575425649000,
  "statusCode": 100,
  "statusMessage": "In Progress",
  "jobInputInfo": {
    "lcmImportFileName": "Sample1.zip",
    "lcmImportTargetApplicationName": "Sample_dup",
    "lcmImportFromStorage": false,
    "overwrite": true,
    "include-server-level": false,
    "verbose": false
  },
  "jobOutputInfo": {
    "errorMessage": "",
    "infoMessage": ""
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "canonical",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "Job Status",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/12",
      "method": "GET"
    }
  ]
}

集計の作成

次のcURLの例では、集計を作成するジョブの実行方法を示します。 少なくともデータベース・アクセス権限が必要です。 

call properties.bat

curl -X POST "https://192.0.2.1:443/essbase/rest/v1/jobs"
     -H  "accept: application/json"
     -H  "Content-Type: application/json"
     -d "{  \"application\": \"ASOSamp\",
            \"db\": \"Basic\",
            \"jobtype\": \"buildAggregation\",
            \"parameters\":
             {    \"ratioToStop\": \"1.1\",
                  \"basedOnQueryData\": \"false\",
                  \"enableAlternateRollups\": \"false\"  }
         }"
     -u %User%:%Password%

集約は集約ストレージ・キューブに適用されます。 集約は、アウトライン階層に基づく、集約ストレージ・キューブ内のレベル0のデータ値の集計です。 aggregationという用語は、集計プロセスおよびプロセスの結果として格納される値のセットを指すために使用されます。

集計には、集計セルの集合である1つ以上の「集約ビュー」が含まれます。 集約を構築すると、Essbaseでは、ロールアップする集約ビューが選択され、集約されて、選択したビューにセル値が保管されます。 データ・ロードによって変更されるレベル0の値に依存する集計セルが集計に含まれる場合、上位レベルの値はデータ・ロード・プロセスの最後に自動的に更新されます。

集約を構築する場合、Essbase

  • 停止値(ratioToStop)または問合せパターン(basedOnQueryData) (あるいはその両方)に基づいて、0個以上の集計ビューを選択します(これらのパラメータが指定されている場合)
  • 選択されたビューを構築

Note: このジョブ・タイプに相当するMaxLは、execute aggregate process文です。

レスポンス本体の例

{
  "job_ID": 8,
  "appName": "ASOSamp",
  "dbName": "Basic",
  "jobType": "Build Aggregation",
  "jobfileName": null,
  "userName": "dbaccess",
  "startTime": 1575411748000,
  "endTime": 1575411748000,
  "statusCode": 100,
  "statusMessage": "In Progress",
  "jobInputInfo": {
    "enableAlternateRollups": false,
    "basedOnQueryData": false,
    "ratioToStop": 1.1
  },
  "jobOutputInfo": {
    "errorMessage": ""
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "canonical",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "Job Status",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/8",
      "method": "GET"
    }
  ]
}

集計のクリア

次のcURLの例では、集約ストレージ・キューブの集約をクリアするジョブの実行方法を示します。

call properties.bat
curl -X POST "https://192.0.2.1:443/essbase/rest/v1/jobs"
     -H  "accept: application/json"
     -H  "Content-Type: application/json"
     -d "{  \"application\": \"ASOSamp\",
            \"db\": \"Basic\",
            \"jobtype\": \"clearAggregation\"}"
     -u %User%:%Password%

レスポンス本体の例

{
  "job_ID": 9,
  "appName": "ASOSamp",
  "dbName": "Basic",
  "jobType": "Clear Aggregation",
  "jobfileName": null,
  "userName": "dbaccess",
  "startTime": 1575412855000,
  "endTime": 1575412855000,
  "statusCode": 100,
  "statusMessage": "In Progress",
  "jobOutputInfo": {
    "errorMessage": ""
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "canonical",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "Job Status",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/9",
      "method": "GET"
    }
  ]
}

データのエクスポート

次のcURLの例では、キューブからデータをエクスポートする方法を示します。 少なくともデータベース・マネージャ権限が必要です。 

call properties.bat
curl -X POST "https://192.0.2.1:443/essbase/rest/v1/jobs"
     -H  "accept: application/json"
     -H  "Content-Type: application/json"
     -d "{  \"application\": \"Sample\",
            \"db\": \"Basic\",
            \"jobtype\": \"exportData\",
            \"parameters\": 
             {    \"compress\": \"false\",
                  \"columnFormat\": \"false\",
                  \"dataLevel\": \"LEVEL_ZERO_BLOCKS\"  }
        }"
     -u %User%:%Password%

レスポンス本体の例

{
  "job_ID": 28,
  "appName": "Sample",
  "dbName": "Basic",
  "jobType": "Export Data",
  "jobfileName": null,
  "userName": "dbmanager",
  "startTime": 1575920712000,
  "endTime": 1575920712000,
  "statusCode": 100,
  "statusMessage": "In Progress",
  "jobInputInfo": {
    "compress": false,
    "columnFormat": false,
    "dataLevel": "LEVEL_ZERO_BLOCKS"
  },
  "jobOutputInfo": {
    "scriptOutputFileName": "",
    "scriptOutputFileNamePath": "",
    "infoMessage": "",
    "errorMessage": ""
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "canonical",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "Job Status",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/28",
      "method": "GET"
    }
  ]
}

MDXスクリプトの実行

次のcURLの例では、挿入またはエクスポートを実行するMDXスクリプトの実行方法を示します。 少なくともデータベース・アクセス権限が必要です。 

call properties.bat

curl -X POST "https://192.0.2.1:443/essbase/rest/v1/jobs"
     -H  "accept: application/json"
     -H  "Content-Type: application/json"
     -d "{  \"application\": \"Sample\",
            \"db\": \"Basic\",
            \"jobtype\": \"mdxScript\",
            \"parameters\":
             {    \"file\": \"shared/mdx_scripts/export_examp.mdx\"  }
         }"
     -u %User%:%Password%

レスポンス本体の例

{
  "job_ID": 26,
  "appName": "Sample",
  "dbName": "Basic",
  "jobType": "MDX Script",
  "jobfileName": null,
  "userName": "dbaccess",
  "startTime": 1575918425000,
  "endTime": 1575918425000,
  "statusCode": 100,
  "statusMessage": "In Progress",
  "jobInputInfo": {},
  "jobOutputInfo": {
    "errorMessage": ""
  },
  "links": [
    {
      "rel": "self",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "canonical",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs",
      "method": "POST"
    },
    {
      "rel": "Job Status",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/26",
      "method": "GET"
    }
  ]
}
先頭に戻る