Scripted Planning Exporter による Planning データのエクスポート

カスタマイズされた Pentaho プラグインの Scripted Planning Exporter (SPE) を使用して、Planning データを外部システムにエクスポートすることができます。その他の情報:

Adaptive Planning

SPE について

SPE は、

Adaptive Planning

REST API をエクスポートし、指定されたファイルにその API コールの結果を保存します。SPE は、CSV および XML ファイル形式への出力をサポートしています。すべてのエクスポートデータを CSV 形式に変換できるわけではありません。

SPE はバージョン v51.17.0734 から始まるデータエージェントにバンドルされているプラグインです。プログラムを開くと、どのバージョンのデータエージェントサービスマネージャを所有しているかを確認することができます。バージョン番号は "バージョン情報" タブの情報に表示されます。データエージェントのインストールについては、データエージェントサービスマネージャのインストールを参照してください。SPE がインストールされると、Adaptive Planning プラグインが Spoon の "設計" タブの "入力" フォルダに表示されます。

Scripted Planning Exporter Adapter 関連の用語は多少わかりにくいかもしれません。データは Planning からスクリプトに流れてから、いくつかの外部の宛先に流れるため、Planning からのデータのエクスポートと、外部の宛先へのデータのインポートとなります。ただし、Spoon から見ると、SPE はスクリプトへ入力するため入力ステップとなります。このため、Spoon では "Adaptive Planning Input" というラベルが付けられています。

Spoon 環境から直接 SPE を起動することも、スクリプタローダに SPE を組み込むことによってリモートから起動することもできます。SPE を使用する一般的なプロセスでは、Planning サーバーで受け入れられた形式で XML リクエストを作成し、それを SPE に渡してから結果を処理するスクリプトを作成します。以下は、SPE スクリプトの最低要件を示したサンプルのスクリプトです。


      Scripted Planning Exporter
-------------------------------------------
Input:
      requestXMLString: request in XML format
      targetResponseFormat: CSV or XML
      targetFolder: target folder to store result file generated by
         this plugin

Output: The type of output fields is String, except
    requestSuccess, which is boolean
      requestSuccess: Boolean, Y' or N'
      planningMsgs: concatenate Planning messages in a string,
    delimited by ###'
      responseFileName: complete path of the response file name
      fieldNames: column name in CSV header, or NULL if
    targetResponseFormat is XML
      numberRecReturned: String, number of records returned by
    Planning, or NULL if targetResponseFormat is XML

このスクリプトのベストプラクティスには次のものが含まれます。

すべての入力フィールド名では、大文字と小文字が区別されます。それに応じて Kettle スクリプトで定義します。

requestXMLString:
各エクスポート API には独自のリクエスト XML フォーマットがあります。以下を参照してください。

Adaptive Planning

詳細については、 REST API を参照してください。

targetResponseFormat:
API v11 時点では、'exportData' API のペイロードのみを CSV フォーマットに変換できます。その他のエクスポートはすべて XML である必要があります。

TargetFolder:
通常は、エージェントサービスマネージャで、"ファイルへのランナーアクセスを制限する" チェックボックスをオンにしないでください。ターゲットフォルダはファイルシステム内のどこにでも置くことができます。

responseFileName:
回答ファイルの名前は、次のフォーマットである。

<targetFolder>_ApiResponse_<exportMethod>_<UUID>.<targetFormat>;

例:

C:\pdiTemp\ApResponse_exportData_83980a17b3dc40c48282483cb9ea5e96.csv

requestSuccess:
エクスポートリクエストが Planning サーバー側で処理される場合、requestSuccess は true ('Y') の値を持ちます。Planning への呼び出しの結果、エクスポートリクエストが失敗した場合、SPE は Planning サーバーから返されたエラーメッセージを含む例外をスローします。

Planning から情報を抽出して出力ファイルに送信する一般的なワークフローを以下に示しています。

リクエスト XML ファイルを入力

ファイルコンテンツを文字列に変換

ターゲットフォーマット (CSV | XML) およびフォルダをセット

Adaptive Scripted Planning Exporter

ブロッキングステップ

Adapter 出力の記録

Kettle スクリプトから Planning エクスポート API を使用

SPE は以下を使用します。

Adaptive Planning

API v11 以上。SPE では次の API を使用できます。

customReportValues:
リクエストされたインスタンス内のリクエストされたレポート条件のデータセットを返します

exportData:
特定のバージョンから一連の値を取得します

の理解を参照してください。

Adaptive Planning

詳細については API を参照してください。

SPE Kettle プラグインの構成

SPE Kettle プラグインを設定するには:

Spoon の "設計" タブで "Adaptive Planning Input"
をクリックします。

SPE の情報を入力します。

アクティブエージェント:
SPE によって自動的に入力されます。

インスタンスホスト:
SPE によって自動的に入力されます。

インスタンスコード:
SPE によって自動的に入力されます。

ログイン:
ログインコンテキストパラメータの値です。

ログインパスワード:
パスワードコンテキストパラメータの値です。

ロケール:
デフォルトは en_US
です。

"OK"
をクリックします。

SPE 操作の入力と出力を定義するスクリプトを作成する必要があります。この記事のサンプルスクリプトを参照してください。

内の SPE の構成
Adaptive Planning
インテグレーションクラウド UI

インテグレーションのクラウド UI を使用してスクリプト化されたローダを作成する一般的なプロセスは次のとおりです。

スクリプト化されたローダを作成

エントリポイントを選択

必須パラメータを構成

新しいスクリプト化されたローダの作成から開始します。詳細については、スクリプト化されたローダの作成を参照してください。エントリポイントドロップダウンでエントリポイントも選択する必要があります。エントリポイントは、スクリプト化されたローダが実行されたときに実行されるスクリプトの名前に設定されます。

Kettle/Spoon 環境の環境変数として、スクリプト化されたローダで定義されたローカルおよび共有コンテキストパラメータをマッピングして公開する必要があります。例: "login" というコンテキストパラメータがパラメータセクションのローダ設定画面で定義されている場合、Kettle 環境の変数 "${login}" として公開されます。スクリプト化されたローダの 2 つのコンテキストパラメータが定義され、対応する両方の Kettle 変数の SPE で使用されます。

設計時に現在のデフォルトのコンテキストパラメータ値で Kettle 変数を更新するには、Adaptive スクリプトエディタを起動し、"Refresh Configuration"
をクリックしてリフレッシュをトリガします。

Scripted Planning Exporter による Planning データのエクスポート

SPE について

Kettle スクリプトから Planning エクスポート API を使用

SPE Kettle プラグインの構成

内の SPE の構成 Adaptive Planning インテグレーション クラウド UI

内の SPE の構成
Adaptive Planning
インテグレーションクラウド UI