すべてのプロダクト
Search
ドキュメントセンター

DataWorks:ワークスペースレベルパラメーターを使用する

最終更新日:Jan 11, 2025

DataWorks は、タスクレベルでスケジューリングパラメーターに加えて、ワークスペースレベルパラメーターを提供します。ワークスペースの複数のパラメーターを同じ値に設定する場合、ワークスペースレベルパラメーターを使用できます。機密データを保護するために、ワークスペースレベルパラメーターの構成をマスクできます。標準モードのワークスペースでは、本番環境と開発環境でワークスペースレベルパラメーターに異なる値を指定できます。

背景情報

DataWorks では、タスクは、タスクに対して構成したスケジューリングパラメーターに基づいて実行するようにスケジュールされます。スケジューリングパラメーターの値は、タスクが実行されるたびに、スケジューリングパラメーターの値割り当てルールに基づいて自動的に置き換えられます。詳細については、「サポートされているスケジューリングパラメーターの形式」をご参照ください。

前提条件

  • ワークスペースが作成されていること。ワークスペースレベルパラメーターは、特定のワークスペースで使用される必要があります。ワークスペースの作成方法については、「ワークスペースの作成と管理」をご参照ください。

  • ユーザーがワークスペースにメンバーとして追加され、[ワークスペース管理者] ロールが割り当てられていること。ワークスペース管理者ロールが割り当てられているユーザーのみが、ワークスペースレベルパラメーターを作成できます。ユーザーをワークスペースにメンバーとして追加し、ロールをユーザーに割り当てる方法については、「RAM ユーザーをワークスペースにメンバーとして追加し、ロールをメンバーに割り当てる」をご参照ください。

  • DataWorks Professional Edition 以上がアクティブ化されていること。ワークスペースレベルパラメーターは、DataWorks Professional Edition 以上でのみ使用できます。詳細については、「DataWorks エディション間の違い」をご参照ください。

制限事項

  • スケジューリング専用の排他的リソースグループのみがこの機能をサポートしています。スケジューリング用の共有リソースグループはこの機能をサポートしていません。

  • 使用したいスケジューリング専用の排他的リソースグループが 2024 年 1 月 1 日 以降に作成された場合は、ワークスペースレベルパラメーターを想定どおりに使用できます。使用したいスケジューリング専用の排他的リソースグループが 2024 年 1 月 1 日 より前に作成された場合は、ワークスペースレベルパラメーターを使用する前に、テクニカルサポートに連絡してリソースグループの構成をアップグレードする必要があります。

ワークスペースレベルパラメーターを作成する

  1. ワークスペースレベルパラメーターを作成するためのエントリポイントに移動します。

    1. オペレーションセンターページに移動します。

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

    2. オペレーションセンターページの左側のナビゲーションペインで、[その他] > [テナントスケジュール設定] を選択します。表示されるページで、[ワークスペースレベルパラメーター] タブをクリックします。

  2. ワークスペースレベルパラメーターを作成します。

    1. [ワークスペースレベルパラメーター] タブで、[ワークスペースレベルパラメーターの作成] をクリックします。[ワークスペースレベルパラメーターの作成] ダイアログボックスで、ビジネス要件に基づいてパラメーターを構成します。

      説明

      一度に複数のワークスペースレベルパラメーターを作成する場合は、[ワークスペースレベルパラメーターの一括作成] をクリックできます。

      パラメーター

      説明

      パラメーター名

      ワークスペースレベルパラメーターの名前。デフォルトでは、名前にプレフィックス workspace. が付いています。パラメーター名は一意である必要があります。

      所有者

      ワークスペースレベルパラメーターの所有者を指定します。

      説明
      • [ワークスペース管理者] は、ワークスペースの任意のメンバーをワークスペースレベルパラメーターの所有者として指定できます。

      • [ワークスペース管理者] のみすべてのワークスペースレベルパラメーターを変更または削除できます。

      RAM ユーザーとしてワークスペースレベルパラメーターを管理する場合は、RAM ユーザーをワークスペースにメンバーとして追加し、必要なロールを RAM ユーザーに割り当てることができます。詳細については、「RAM ユーザーをワークスペースにメンバーとして追加し、ロールをメンバーに割り当てる」をご参照ください。

      ワークスペース

      ワークスペースレベルパラメーターを使用できるワークスペースを指定します。このパラメーターを構成すると、指定されたワークスペースのすべてのタスクでワークスペースレベルパラメーターを使用できます。

      説明
      • ワークスペース管理者が現在のログインアカウントであるワークスペースのみがドロップダウンリストに表示されます。

      • 各ワークスペースレベルパラメーターは 1 つのワークスペースでのみ使用できます。

      パラメータータイプパラメーター値(開発環境)、パラメーター値(本番環境)

      後続のタスクで使用されるワークスペースレベルのパラメーターの実際の値を指定します。有効な値:

      • 定数(プレーンテキスト): ワークスペースレベルのパラメーターには、すべてのユーザーに表示される定数が割り当てられます。例: 123。

      • 定数(暗号テキスト): デフォルトでは、ワークスペースレベルのパラメーターには、****** としてマスクされた定数が割り当てられます。データが機密性の高いものである場合は、[パラメーターの種類] パラメーターを [定数(暗号テキスト)] に設定できます。たとえば、123 と入力すると、値は ****** と表示されます。

      • 変数: ワークスペースレベルのパラメーターの値は、構成した変数に基づいて特定の値に動的に置き換えられます。

        たとえば、[$[yyyy-mm-dd]] 形式で値を指定できます。これは、タスクが実行されるようにスケジュールされている時刻を示します。また、[${yyyy-mm-dd}] 形式で値を指定することもできます。これは、タスクのデータタイムスタンプを示します。サポートされている形式の詳細については、「スケジューリングパラメーターのサポートされている形式」をご参照ください。

      説明
      • [パラメーター値] には、特定の特殊文字を含めることができます。DataWorks コンソールで、サポートされている特殊文字を確認できます。

      • 現在のワークスペースレベルのパラメーターに値を割り当てるときに、他のワークスペースレベルのパラメーターを参照することはできません。

      標準モードのワークスペースを使用する場合、ビジネス要件に基づいて、開発環境と本番環境で同じワークスペースレベルのパラメーターに異なる値を指定できます。ワークスペースのモードについては、基本モードのワークスペースと標準モードのワークスペースの違いをご参照ください。

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

ワークスペースレベルのパラメーターを使用する

ワークスペースレベルのパラメーターを作成したら、ワークスペースレベルのパラメーターが適用されているワークスペースに移動し、特定のノードの構成タブでワークスペースレベルのパラメーターを使用します。 ワークスペースレベルのパラメーターは、スケジューリングパラメーターと同じ方法で使用できます。

  1. 目的のノードのコードで変数を定義します。

  2. ノードの構成タブに移動します。 右側のナビゲーションペインで、[プロパティ] をクリックします。 [スケジューリングパラメーター] セクションで、ワークスペースレベルのパラメーターを変数に割り当てます。

ワークスペースレベルのパラメーターを構成したら、パラメーター値が期待どおりかどうかをプレビューし、ビジネス要件に基づいて値を調整できます。 スケジューリングパラメーターの使用方法については、「スケジューリングパラメーターの構成と使用」をご参照ください。

説明
  • ビジネス要件に基づいてノードを作成できます。 詳細については、「DataWorks ノード」をご参照ください。

  • ノードのワークスペースレベルのパラメーターを構成したら、ノードの構成タブの上部ツールバーでパラメーターを保存して送信する必要があります。

  • 使用するスケジューリング専用の排他リソースグループが 2024年1月1日 以降に作成された場合は、ワークスペースレベルのパラメーターを想定どおりに使用できます。 使用するスケジューリング専用の排他リソースグループが 2024年1月1日 より前に作成された場合は、ワークスペースレベルのパラメーターを使用する前に、テクニカルサポートに連絡してリソースグループの構成をアップグレードする必要があります。

image.png

ワークスペースレベルのパラメーターの管理

[ワークスペースレベルのパラメーター] タブで、ワークスペースレベルのパラメーターに対して次の操作を実行できます。

説明
  • [ワークスペース管理者] ロールが割り当てられているワークスペースメンバーのみが、ワークスペースレベルのパラメーターを変更または削除できます。

  • [開発、O&M、またはワークスペース管理者] ロールが割り当てられているワークスペースメンバーのみが、特定のワークスペースレベルのパラメーターを参照するタスクと、パラメーターのバージョンを表示できます。

RAM ユーザーをワークスペースにメンバーとして追加し、メンバーにロールを割り当てる方法については、RAM ユーザーをワークスペースにメンバーとして追加し、メンバーにロールを割り当てる をご参照ください。

  • ワークスペースレベルのパラメーターの表示: ワークスペースレベルのパラメーターの詳細、ワークスペースレベルのパラメーターが適用されるワークスペース、およびワークスペースレベルのパラメーターを参照するタスクを表示できます。タスクの ID をクリックして、対応するノードの構成タブに移動し、開発操作を実行できます。

  • ワークスペースレベルのパラメーターの変更:

    • ワークスペースレベルのパラメーターの所有者、値、および説明のみを変更できます。ワークスペースレベルのパラメーターを変更するたびに、新しいバージョンが生成されます。

    • 他のタスクによって参照されているワークスペースレベルのパラメーターを変更すると、タスクのワークスペースレベルのパラメーターの値が影響を受けます。ワークスペースレベルのパラメーターを変更する場合は注意してください。

    • 変更は 10 分以内に有効になります。

  • パラメーターバージョンの比較とパラメーターのロールバック: ワークスペースレベルのパラメーターの履歴バージョンを表示し、ワークスペースレベルのパラメーターのバージョンを比較し、ワークスペースレベルのパラメーターを特定のバージョンにロールバックできます。

  • ワークスペースレベルのパラメーターの削除:

    • ワークスペースレベルのパラメーターが他のタスクによって参照されている場合、パラメーターを削除することはできません。

    • ワークスペースレベルのパラメーターを削除すると、パラメーターを参照するタスクは実行に失敗します。ワークスペースレベルのパラメーターを削除する場合は注意してください。

    • 削除操作はすぐに有効になります。ワークスペースレベルのパラメーターを削除した後、ワークスペースレベルのパラメーター タブでパラメーターを見つけることはできません。ワークスペースレベルのパラメーターが削除されてから 10 分以内は、ワークスペースレベルのパラメーターを参照するタスクが引き続きパラメーターの値を取得できる場合があります。