ワークスペースレベルのパラメーターを使用すると、キーと値のペアを 1 回定義し、ワークスペース内のすべてのタスクで再利用できます。個々のタスクに同じ値を繰り返し設定する必要がなくなります。複数のタスクでデータベース接続文字列や共通の日付範囲など、同じ構成値を共有する場合にご利用ください。
ワークスペースレベルのパラメーターは、タスクレベルのスケジューリングパラメーターとは異なります。タスクレベルのパラメーターは 1 つのタスクに適用されますが、ワークスペースレベルのパラメーターはワークスペース内のすべてのタスクに適用されます。
前提条件
作業を開始する前に、以下の要件を満たしていることを確認してください。
-
ワークスペースです。詳しくは、「ワークスペースの管理」をご参照ください。
-
該当ワークスペースで ワークスペース管理者 ロールを保有していること。ワークスペースレベルのパラメーターを作成できるのは、ワークスペース管理者のみです。「RAM ユーザーをワークスペースメンバーとして追加し、ロールを割り当てる」をご参照ください。
-
DataWorks Professional Edition またはそれ以上のエディションを利用していること。「DataWorks の各エディションの違い」をご参照ください。
-
専用スケジューリングリソースグループが存在すること。共有リソースグループではこの機能はサポートされていません。
2024 年 1 月 1 日より前に作成された専用スケジューリングリソースグループをお使いの場合は、ワークスペースレベルのパラメーターを使用する前に、テクニカルサポートに連絡してリソースグループの構成をスペックアップしてください。
仕組み
タスクが実行されると、DataWorks はタスクコード内の各変数を、割り当てられたワークスペースレベルのパラメーターの値に置き換えます。この置き換えは、タスクレベルのスケジューリングパラメーターと同じルールに従います。「スケジューリングパラメーターでサポートされるフォーマット」をご参照ください。
標準モード のワークスペースでは、開発環境と本番環境で同じパラメーターに異なる値を設定できます。たとえば、db.endpoint パラメーターを、開発環境ではテスト用データベース、本番環境では本番データベースを指すように設定できます。タスクコードを変更する必要はありません。
ワークスペースレベルのパラメーターの作成
-
DataWorks コンソール にログインします。上部ナビゲーションバーで対象のリージョンを選択します。
-
左側のナビゲーションウィンドウで、データ開発・O&M > オペレーションセンター を選択します。ドロップダウンリストから対象のワークスペースを選択し、オペレーションセンターへ移動 をクリックします。
-
オペレーションセンター画面の左側ナビゲーションウィンドウで、その他 > テナントスケジュール設定 を選択し、ワークスペースレベルのパラメーター タブをクリックします。
-
ワークスペースレベルのパラメーターの作成 をクリックします。
説明複数のパラメーターを一度に作成する場合は、代わりに ワークスペースレベルのパラメーターの一括作成 をクリックします。
-
ワークスペースレベルのパラメーターの作成 ダイアログボックスで、以下のフィールドを設定します。
説明パラメーター値には特定の特殊文字を含めることができます。サポートされている文字セットについては、DataWorks コンソールをご確認ください。ワークスペースレベルのパラメーター値から、別のワークスペースレベルのパラメーターを参照することはできません。
フィールド 説明 パラメーター名 パラメーターの一意な名前です。デフォルトで workspace.がプレフィックスとして付加されます。オーナー このパラメーターの所有者となるワークスペースメンバーです。ワークスペース管理者は任意のメンバーをオーナーに割り当てることができます。所有者に関係なく、パラメーターの変更または削除はワークスペース管理者のみが行えます。 ワークスペース パラメーターが利用可能なワークスペースです。このワークスペース内のすべてのタスクがパラメーターを参照できます。各パラメーターは単一のワークスペースにスコープされます。ドロップダウンリストには、ユーザーがワークスペース管理者であるワークスペースのみが表示されます。 パラメーター種別 値の保存および表示方法を制御します。以下の表をご参照ください。 パラメーター値 (開発環境) 開発環境で使用される値です。標準モードのワークスペースでのみ利用可能です。 パラメーター値 (本番環境) 本番環境で使用される値です。標準モードのワークスペースでのみ利用可能です。 パラメーター種別：
種別 動作 例 定数 (プレーンテキスト) 値はそのまま保存・表示され、ワークスペースメンバー全員に表示されます。 cn-hangzhou.oss.aliyuncs.com定数 (暗号化テキスト) コンソール上では値が ******としてマスクされます。パスワードやアクセスキーなど、機密性の高い構成値にご利用ください。パスワードは ******変数 値は実行時にスケジューリング式に基づいて動的に置き換えられます。 $[yyyy-mm-dd]はタスクのスケジュール実行時刻に解決され、${yyyy-mm-dd}はタスクのデータタイムスタンプに解決されます。「スケジューリングパラメーターでサポートされるフォーマット」をご参照ください。$[yyyy-mm-dd] -
OK をクリックします。
ノードでのワークスペースレベルのパラメーターの使用
-
ノードのコードエディタで、標準のスケジューリングパラメーター構文を使用して変数を定義します。
-
ノードの構成タブで、右側パネルの プロパティ をクリックします。スケジューリングパラメーター セクションで、その変数にワークスペースレベルのパラメーターを割り当てます。
-
解決後のパラメーター値をプレビューし、期待通りであることを確認します。
-
上部ツールバーを使用して、ノード構成を保存・送信します。
スケジューリングパラメーターの構文と使用方法の詳細については、「スケジューリングパラメーターの設定と使用」および「サポートされるノードタイプ」をご参照ください。
ワークスペースレベルのパラメーターの管理
ワークスペースレベルのパラメーター タブでは、ワークスペースレベルのパラメーターの表示、変更、バージョン比較、削除ができます。
ロール権限：
| 操作 | 必要なロール |
|---|---|
| パラメーター詳細、参照タスク、バージョンの表示 | 開発、O&M、またはワークスペース管理者 |
| パラメーターの変更または削除 | ワークスペース管理者のみ |
RAM ユーザーをワークスペースに追加してロールを割り当てる方法については、「RAM ユーザーをワークスペースメンバーとして追加し、ロールを割り当てる」をご参照ください。
表示
パラメーターをクリックすると、その詳細、適用されるワークスペース、および参照しているタスクを確認できます。タスク ID をクリックすると、そのノードの構成タブに直接移動します。
変更
パラメーターのオーナー、値、および説明のみを変更できます。変更ごとに新しいバージョンが作成されます。変更は 10 分以内に有効になります。
ワークスペースレベルのパラメーターを変更すると、それを参照しているすべてのタスクに影響します。変更前に依存タスクを確認してください。
バージョン比較とロールバック
パラメーターの完全なバージョン履歴を表示し、任意の 2 つのバージョンを並べて比較できます。必要に応じて、以前のバージョンにロールバックすることも可能です。
削除
ワークスペースレベルのパラメーターを削除すると、それを参照しているすべてのタスクが失敗します。削除は即時に有効になります。削除後 10 分間は、参照タスクが引き続きパラメーター値を解決できる場合があります。アクティブなタスクから参照されているパラメーターは削除できません。