カスタムクラウドローダの作成
カスタムクラウドローダを構築するには、JavaScriptのプログラミングに関する十分な知識と経験が必要です。経験豊富なJavaScriptプログラマーを利用できない場合は、カスタムクラウドローダの作成を開始してはなりません。また、カスタムクラウドローダの作成を試みる前に、Adaptive Insightsの管理 > ロールと権限内で、統合開発者として割り当てられる必要があります。
カスタムクラウドローダにより、Adaptive Insights計画データを第三者クラウドシステムに直接エクスポートできます。
ビデオを見る:3分16秒
基本ステップ
- データ ソース設定を入力します。
- パラメーターを定義します。
- CCDS APIを使用してJavaScriptを書き込みます。
- ビジネス ルールを定義します。
- ローダを実行またはスケジュール設定します。
が始める前に
- 統合開発者ロールの権限があることを確認します。
- ステージング テーブルにエクスポートするAdaptive Insights計画データが既に存在することを確認します。
- 外部システムのOAuth認証情報を作成するか、JavaScriptに明示的に含めることができる認証情報を取得します。
- 外部システムに転送する必要があるパラメーターが何であり、外部システムが想定しているデフォルトが何であるかを確認します。
- 外部システムのエンドポイントに書き込む方法を理解します。
そこに着く方法
ナビゲーションメニュー
> [統合] > [デザイン統合] に進みます。
データ ソース設定の入力
データ ソース設定により、インスタンスのステージング データから使用するソース テーブルを選択し、使用する認証情報、およびローダの実行中に記録するログ詳細のレベルを決定できます。
新規カスタムクラウドローダの作成
- [統合] > [デザイン統合] に移動して、[データ デザイナー] にアクセスします。
- コンポーネント ライブラリの [ローダ] フォルダーで [新規ローダの作成] を選択します。
- ローダの種類として [カスタムクラウドローダ] を選択し、名前を入力します。カスタムクラウドローダがオプションの1つとして表示されない場合は、このインスタンスに関して有効化されていないか、アクセスに必要な統合開発者ロール権限がありません。
- [作成] を選択します。
[ソース テーブル]、[認証情報]、および[ログレベル]を選択します。
- カスタムクラウドローダの情報を入力します。
- ソース テーブル:エクスポートするAdaptive Insightsプランニングデータを含むステージング テーブルを選択します。
- 認証情報の要求:外部システムがOAuthを必要とするかどうかを選択し、適切なOAuth認証情報を選択するにあたりインテグレーションオペレーターロールの権限を持つユーザーが必要であるかどうかを選択します。
- ログイン認証情報:既存のOAuth認証情報を選択します。
- ログ レベル:ローダの実行時にどの程度の詳細を記録するかを選択します。
- エラー:エラーのみを記録します。
- 情報:データ ソースが更新されたときなど、すべての基本情報を記録します。
- 冗長: すべてのフェーズとアクションに関する非常に詳細な情報を提供します。典型的な使用方法よりも多くのログ情報を生成する可能性があるため、主にデバッグや監査に使用されます。
- [操作] メニューで [保存] をクリックします。
パラメータの定義
Adaptive Insightsデータを外部システムにエクスポートするためにJavaScriptが必要とするパラメーターを定義します。パラメーターには、接続URL、ユーザー名、パスワード、Adaptive Insightsからの属性、およびその他の情報を含めることができます。パラメータ化された設定により、実行時に値を変更することができます。ローダの実行中は静的設定が保持されます。
- [デザイナー設定] を選択します。
- パラメーター化された設定項目または静的設定項目を [設定コンポーネント] ペインから [デザイナー設定] の下のキャンバスにドラッグします。
- ローダの実行時に別の値を入力しない場合、ここに入力されたパラメータ化された設定値がローダのデフォルトになります。
- ここに入力した静的設定は、ローダが実行されるたびに使用され、実行時に入力する必要はありません。
- ブール値: 1またはゼロとして表される値。
- 属性: Adaptive Insights内の属性管理からの属性。
- 整数: 負ではない整数。
- パスワード: パスワード。この値は、いったん保存されると表示できません。
- 期間範囲:Adaptive Insights内からの期間範囲。
- テキスト: 英数字の値。
- パラメーターに名前を付け、編集するには、キャンバス内で項目をダブルクリックします。
- 必要に応じてJavaScriptで参照する項目をいくつでもドラッグできます。
- ローダを保存します。
- 参照するには、JavaScript内のパラメーターの名前を使用します。
JavaScriptの書き込み
- [スクリプト] を選択します。
- 既存のテンプレートを選択して編集するか、[新しいスクリプト] を選択して独自に作成します。
- CCDS スクリプト化APIを使用してローダで実行するJavaScriptを書き込みます。
- スクリプトに必要なものが含まれていることを確認します。
testConnection
機能:外部システムへのhttpsポストリクエストを作成しますexportData
関数:Adaptive Insightsからデータをエクスポートします。
- [デザイナー設定] で作成したパラメーターを名前によって参照します。
- スクリプトを保存します。
キーボード ショートカットのCtrl+Bを使用して、エディターでスクリプトの書式を設定し、整えることができます。Ctrl+Hを押すと検索・置換が起動します。
長いスクリプトを複数のファイルに分離することにより、メンテナンスを簡単にすることができます。例えば、すべてのtestConnection
論理をtestconnectionscript
と呼ばれる1つのスクリプトに含めることができます。同様に、すべてのexportData
論理をexportdatascript
と呼ばれる2つめのスクリプトに含めることができます。同じ関数が複数のスクリプトで宣言されている場合、最後に追加されたスクリプトからのものが使用されます。
カスタムクラウドローダ スクリプトにおけるOAuthの使用
カスタムクラウドローダの [認証情報を要求] を選択する場合、スクリプトにai.https.authorizedRequestを含める必要があります。
OAuth認証情報を作成する方法については、OAuthによる認証を参照してください。
認証情報を参照してカスタムクラウドローダを実行する場合は、以下のようにする必要があります。
- ローダを実行する前に [認証をリクエスト] を選択します。
- 適用範囲など、外部システムのエンドポイントに必要な追加の認証情報を入力します。
- [テスト接続] を選択して、OAuth認証情報がエンドポイントに正常に送信されたことを確認します。
- 認証ステータスの認証日およびユーザーIDを記録します。認証の有効期限は、外部システムごとに異なります。必要に応じて再認証するには、[操作] ペインで [認証のリセット] を選択します。
ビジネスルールの定義
ビジネスルールを使用して、外部システムにエクスポートするステージング データを制限するSQL式を作成できます。フィルター基準を満たすレコードのみがロードされます。
[ビジネス ルール] タブには、SQLを入力するためのテキスト領域が含まれています。
- [ビジネスルール] タブを選択します。
- [編集] を選択します。
- SQL式を入力します。[使用可能な列] で項目をクリックすると、タイピングせずに、その列をSQL式に持ってくることができます。
- [適用] を選択して、構文を確認します。エラーが発生すると、式を囲む線が赤に変わります。式の上にマウスを合わせて、構文エラー情報を確認します。
- 構文のエラーを修正し、[適用] を選択します。SQL式に一致するステージング行のみがロードされます。
統合タスクにカスタムクラウドローダを含める
カスタムクラウドローダは、統合タスクとして実行する必要があります。Integrationタスクには、1つまたは複数のローダを含めることができます。他の統合タスクおよびローダを1つのタスクに含めることもできます。
ベスト プラクティス: 各ローダに個別の統合タスクを持たせます。
1つのタスクに複数のローダが含まれている場合は、タスクの実行時に各ローダのパラメーターが表示されます。タスク内のローダで共通/共有パラメータが使用されている場合、タスクがパラメータの入力を求めるのは 1 回だけです。パラメータープロンプトは上書きするよう選ぶことができます。
計画実行されるタスクの場合、ローダが作成された際に保存されたパラメーターのデフォルト値が使用されます。