DataWorks:ワークフローパラメーターの使用

サポートされているノードタイプ

ワークフローパラメーター機能は、ODPS SQLノード、EMR Spark Shellノード、EMR Sparkノード、EMR Shellノード、EMR Hiveノード、EMR MRノード、EMR Prestoノード、EMR Trinoノード、EMR Spark SQLノード、EMR Spark Streamingノード、EMR Streaming SQLノード、および Hologres SQLノードのタイプのノードでのみサポートされています。 DataWorksコンソールで、ワークフローパラメーター機能をサポートするノードタイプを表示できます。

注意事項

• ワークフローでワークフローパラメーターを設定し、ワークフローパラメーターの設定を保存した後、ワークフローでワークフローパラメーターをサポートするノードを開くたびに、システムはワークフローパラメーターの最新の設定をノードのパラメーターリストにロードし、ノードは編集可能になります。最新の構成をスケジューリングシナリオで有効にするには、ノードをコミットしてデプロイする必要があります。

• 設定したワークフローパラメーターがノードのパラメーターと同じであるが、ワークフローパラメーターの値がノードパラメーターの値と異なる場合、ワークフローパラメーターの値はノードパラメーターの値を上書きします。

• ワークフローパラメーターを設定する場合、ワークフローパラメーターの [値/式] パラメーターを ${英語の単語}: の形式で設定することはできません。たとえば、パラメーター値を var:1 の形式で指定したり、パラメーター式を ${var}:1 の形式で指定したりすることはできません。

ワークフローパラメーター設定のエントリポイントに移動する

1. [datastudio] ページに移動します。

   DataWorksコンソール にログインします。上部のナビゲーションバーで、目的のリージョンを選択します。左側のナビゲーションペインで、[データ開発とガバナンス] > [データ開発] を選択します。表示されたページで、ドロップダウンリストから目的のワークスペースを選択し、[データ開発に移動] をクリックします。

2. ワークフローパラメーター設定のエントリポイントに移動します。

   [スケジュールされたワークフロー] ペインで、目的のワークフローを見つけ、その名前をダブルクリックします。ワークフローの設定タブの右側のナビゲーションペインで、[ワークフローパラメーター] をクリックします。

ワークフローパラメーターを設定する

ワークフローパラメーター機能をサポートするすべてのタイプのノードで、ワークフローパラメーターを設定するために使用される方法は同じです。ワークフロー内の複数のノードで使用されている同じパラメーターに値を同時に割り当てる必要がある場合は、ワークフローパラメーター機能を使用することをお勧めします。この例では、ワークフローパラメーター機能を使用して、自動トリガーワークフローの ODPS SQLノードの ReplaceMe パラメーターの値 20230613 を値 20230615 に置き換えます。

1. データ開発に使用される ODPS SQLノードのノードパラメーターを設定します。

   1. ODPS SQLノードの設定タブに移動します。

      目的のワークフローで ODPS SQLノードをダブルクリックして、ノードの設定タブに移動します。

   2. ノードのノードパラメーターを設定します。

      次の図に示すように、[プロパティ] タブの [パラメーター] セクションで、ReplaceMe パラメーターを入力し、値 20230613 をパラメーターに割り当てます。ノードのノードパラメーターを設定する方法については、「スケジューリングパラメーターの設定」をご参照ください。

2. ワークフローパラメーター機能を使用して、ODPS SQLノードの ReplaceMe パラメーターの値を置き換えます。

   1. [スケジュールされたワークフロー] ペインで、目的のワークフローを見つけ、その名前をダブルクリックします。ワークフローの設定タブの右側のナビゲーションペインで、[ワークフローパラメーター] をクリックします。

   2. [ワークフローパラメーター] タブで、[パラメーター名] パラメーターと [値/式] パラメーターを設定します。

      次の図では、[値/式] パラメーターの値は 20230615 に設定されています。設定を保存すると、ワークフロー内の ODPS SQLノードの ReplaceMe パラメーターの値は 20230615 に置き換えられます。ビジネス要件に基づいてさらにワークフローパラメーターを追加するには、[ワークフローパラメーター] タブの [追加] をクリックします。

      説明

      • 設定したワークフローパラメーターがノードのパラメーターと同じであるが、ワークフローパラメーターの値がノードパラメーターの値と異なる場合、ワークフローパラメーターの値はノードパラメーターの値を上書きします。

      • ワークフローパラメーターを設定する場合、ワークフローパラメーターの [値/式] パラメーターを ${英語の単語}: の形式で設定することはできません。たとえば、パラメーター値を var:1 の形式で指定したり、パラメーター式を ${var}:1 の形式で指定したりすることはできません。

      次の図は、ODPS SQLノードのノードパラメーターの値がどのように置き換えられるかを示しています。

ワークフローパラメーターの設定が有効になっているかどうかを確認する

ワークフローパラメーターを設定した後、ワークフローを実行して、ワークフローパラメーターに指定された値がノードのノードパラメーターの値を置き換えるかどうかを確認する必要があります。

1. ワークフローを実行し、各ワークフローパラメーターに値を割り当てます。

   実行するワークフローでワークフローパラメーターが使用されている場合は、各ワークフローパラメーターに手動で値を割り当てる必要があります。その他の実行方法については、「デバッグ手順」をご参照ください。

   1. ワークフローの設定タブの上部ツールバーにある アイコンをクリックします。

   2. [パラメーターを入力] ダイアログボックスで、ワークフローパラメーター 20230615ReplaceMe に値 を割り当てます。

2. 実行結果を表示します。

   ワークフローの設定タブで、ODPS SQLノードを右クリックし、[ログの表示] を選択します。次に、ODPS SQLノードの ReplaceMe パラメーターに割り当てられている値を表示できます。 ODPS SQLノードのノードパラメーターの値は 20230613 から 20230615 に変更されます。これは、ワークフローパラメーターが有効になり、ワークフローが期待どおりに実行されていることを示しています。

ワークフローパラメーターをコミットしてデプロイする

ワークフローパラメーターが正しく設定されていることを確認した後、現在のワークフローをコミットしてデプロイする必要があります。ワークフローがコミットおよびデプロイされると、ワークフローパラメーターはスケジューリングシナリオで有効になります。

1. ワークフローをコミットします。

   次の図に示す手順を実行して、ワークフローをコミットします。[送信] をクリックした後に表示される [コミット] ダイアログボックスで、コミットするノードを選択し、[変更の説明] パラメーターを設定します。

   説明

   ビジネス要件に基づいて、コードレビュー 機能を使用するかどうかを指定できます。この機能を使用する場合、選択したノードのコードは、ノードコードがレビューに合格した場合にのみデプロイできます。

   

2. ワークフローをデプロイします。

   ワークフローが標準モードのワークスペースで作成された場合、ワークフローがコミットされた後、ワークフローの設定タブの右上隅にある [デプロイ] アイコンをクリックして、ワークフロー内のノードをデプロイする必要があります。詳細については、「ノードのデプロイ」をご参照ください。