Scripted Planning Exporterによるプランニングデータのエクスポート

最後の更新
PDFとして保存

カスタマイズされた Pentaho プラグインの Scripted Planning Exporter（SPE）を使用して、Planning データを外部システムにエクスポートすることができます。（Pentaho の Adaptive Planning の使用の詳細については、「スクリプト化されたデータソースの設定」を参照してください。）

SPE を理解する

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

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

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

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

 Scripted Planning Exporter ------------------------------------------- 入力: requestXMLString: XML形式のリクエストtargetResponseFormat：このプラグイン Outputによって生成された結果ファイルを保存するターゲットフォルダ：出力フィールドのタイプは、requestSuccess（boolean requestSuccess）以外のStringです。ブーリン、‘Y’ および ‘N’ planningMsgs:文字列内のPlanningメッセージを連結し、‘ ### ’responseFileNameで区切る：ファイル名fieldNamesのパスの応答を完了する：CSVヘッダーの列名、またはtargetResponseFormatがXMLの場合はNULL numberRecReturned：String、Planningによって返されたレコード数、またはtargetResponseFormatがXMLの場合はNULL

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

すべての入力フィールド名では、大文字と小文字が区別されます。それに応じて Kettle スクリプトで定義してください。
requestXMLString： 各エクスポート API には独自の要求 XML 形式があります。詳細情報については、「Adaptive PlanningREST 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から情報を抽出して出力ファイルに送信する一般的なワークフローを示しています。

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

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

customReportValues ：リクエストされたインスタンスのリクエストされたレポート条件のデータセットを返します
exportData：特定のバージョンから一連の値を取得します

詳細については、「Adaptive PlanningAPIを理解する」を参照してください。

SPE Kettle プラグインの構成

SPE Kettle プラグインの構成方法:

Adaptive Planning [入力ステップ] ダイアログボックスが表示されます。

[Spoon デザイン] タブで [Adaptive Planning入力] をクリックします。
以下の通り、SPE の情報を入力します。’

アクティブエージェント: SPE が自動的に設定します。
インスタンスホスト： SPE が自動的に設定します。
インスタンスコード: SPE が自動的に設定します。
ログイン： ログインコンテキストパラメータの値です。
ログインパスワード： パスワードコンテキストパラメータの値です。
ロケール: デフォルトは en_US です。

[OK] をクリックします。

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

Adaptive PlanningIntegration のクラウド UI 内での SPE の構成

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

スクリプト化されたローダを作成します
エントリーポイントを選択します
必須パラメータを構成します

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

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

およびSPEにおける対応する両方のKettle 変数の参照：

設計時に現在のデフォルトのコンテキストパラメータ値で Kettle 変数を更新するには、Adaptive Script Editor を起動し、[構成を更新] をクリックして更新をトリガします。