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

DataWorks:拡張機能の使用

最終更新日:Jan 11, 2025

拡張機能が開発、デプロイ、登録された後、拡張機能はテスト、レビュー、公開される必要があります。拡張機能が公開されると、拡張機能の所有者以外の管理者は、管理センターで拡張機能を有効化できます。このトピックでは、拡張機能のテスト、公開、使用方法について説明します。

背景情報

拡張機能が登録された後、公開前に拡張機能をテストおよびレビューする必要があります。拡張機能が公開されると、ワークスペースまたはテナント管理者は管理センターで拡張機能を有効化できます。

前提条件

オープン プラットフォーム

Open Platform 管理者テナント管理者は、次の手順を実行して拡張機能をテスト、レビュー、および公開できます。

手順 1:オープン プラットフォームの [拡張機能] ページに移動する

[拡張機能] ページで、登録済みの拡張機能を表示できます。

  1. [オープン プラットフォーム] ページに移動します。

    DataWorks コンソール にログオンします。上部のナビゲーションバーで、目的のリージョンを選択します。左側のナビゲーションペインで、[その他] > [オープン プラットフォーム] を選択します。[開発者バックエンド] タブが表示されます。

  2. 拡張機能の詳細を表示します。

    表示されたページの左側のナビゲーションペインで、[拡張機能] をクリックします。[拡張機能] ページが表示されます。公開する拡張機能を見つけ、[アクション] 列の [詳細] をクリックして拡張機能の詳細を表示します。

手順 2:拡張機能をテストする

拡張機能が登録されると、デフォルトで [テスト中] 状態になります。[テスト中] 状態の拡張機能は、公開する必要なく、以下のシナリオで有効になります。

  • テナントレベルの拡張ポイントイベント

    拡張機能の所有者は、管理センターで拡張機能を有効化できます。拡張機能は、拡張機能の所有者によって実行される操作に対してのみ有効になります。詳細については、このトピックの 手順 2:拡張機能を有効にする をご参照ください。

    たとえば、データダウンロード操作をチェックするために使用される拡張機能が [テスト中] 状態にあるとします。拡張機能の所有者が管理センターで拡張機能を有効化すると、拡張機能は所有者によって実行されるデータダウンロード操作をチェックするためにトリガーされ、拡張機能が DataWorks に処理結果を返すまで操作を中断できます。

  • ワークスペースレベルの拡張ポイントイベント

    ワークスペースレベルの拡張ポイントイベントをチェックするために使用される拡張機能は、拡張機能を登録するときに指定されたワークスペースでのみ有効になります。拡張機能のテストワークスペースを表示する方法については、このトピックの 拡張機能の詳細を表示する をご参照ください。

特定の拡張ポイントイベントをチェックするために使用する拡張機能を公開する前に、テストワークスペースで拡張機能を有効にしてテストする必要があります。テストは、DataWorks がイベントメッセージを送信するフェーズ、拡張機能がイベントメッセージを受信して処理するフェーズ、拡張機能が DataWorks に処理結果を返すフェーズで構成されます。

手順 3:拡張機能を公開する

テスト後に拡張機能が期待どおりに動作する場合は、手順 1 の操作を実行して、拡張機能の詳細ページに移動します。[拡張機能] ページで、拡張機能の [アクション] 列にある [送信] をクリックして、レビューのために DataWorks に拡張機能を送信します。拡張機能がレビューに合格したら、[アクション] 列で [詳細] > [公開] を選択して、拡張機能を公開します。

説明

拡張機能のレビューは、拡張機能を送信してから T+3 営業日以内に完了します。T は、レビューのために拡張機能をコミットした時点を示します。拡張機能がレビューに不合格になった場合は、警告アイコンにポインターを合わせて不合格の理由を表示し、その理由に基づいて拡張機能を変更してから、レビューのために拡張機能を再送信できます。/* 拡張機能のレビューは、拡張機能を送信してからT + 3営業日以内に完了します。Tは、レビューのために拡張機能をコミットした時点を示します。拡張機能がレビューに不合格になった場合は、警告アイコンにポインターを合わせて不合格の理由を表示し、その理由に基づいて拡張機能を変更してから、レビューのために拡張機能を再送信できます。 */

手順 4:拡張機能の状態を管理する

[オープン プラットフォーム][拡張機能] ページで、拡張機能を見つけて、[詳細][変更][送信、公開、無効化]、または [削除][アクション] 列でクリックして、拡張機能に関連する操作を実行できます。[ステータス] 列には、拡張機能のステータスが表示されます。

  • テスト中:デフォルトでは、登録されているが公開されていない拡張機能と公開されていない拡張機能は テスト中 状態です。[テスト中] 状態の拡張機能は、テストワークスペースに対してのみ有効にできます。

  • レビュー中:[テスト中] 状態の拡張機能に対して [送信] をクリックすると、拡張機能は レビュー中 状態になります。DataWorks オープン プラットフォームによって承認された拡張機能のステータスは 承認済み に変更されます。拡張機能は、承認された場合にのみ公開できます。拡張機能がレビューに不合格になった場合、拡張機能のステータスは 承認失敗 に変更されます。

  • 公開済み[アクション] 列の [公開] をクリックすると、拡張機能のステータスは 公開済み に変更されます。拡張機能が公開されると、拡張機能が適用可能なすべてのワークスペースで拡張機能を使用できます。ワークスペース管理者は、各ワークスペースの管理センターページで拡張機能を表示および有効化できます。

  • 無効:拡張機能を無効にするには、[アクション] 列の [無効化] をクリックします。拡張機能を無効にすると、拡張機能は無効になり、ワークスペースで関連イベントがチェックまたはブロックされなくなります。

  • 期限切れ:DataWorks Enterprise Edition の有効期限が切れると、拡張機能のステータスは [期限切れ] に変更されます。[期限切れ] 状態の拡張機能は無効になり、[無効] 状態の拡張機能と同様になります。

管理センター

[管理センター][拡張機能] ページで、ワークスペース管理者ワークスペースレベルの拡張ポイントイベントをチェックするために使用される拡張機能を関連ワークスペースで有効化でき、テナント管理者テナントレベルの拡張ポイントイベントをチェックするために使用される拡張機能を有効化できます。

手順 1:管理センターの [拡張機能] ページに移動する

  1. [設定センター] ページに移動します。

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

  2. 有効化できる拡張機能を表示します。

    [設定センター] ページの左側のナビゲーションペインで、[テナント設定] セクションの [拡張機能] をクリックします。[拡張機能] ページで、有効化できる拡張機能を表示できます。

手順 2:拡張機能を有効にする

拡張機能のチェック範囲は、拡張機能のレベルによって異なります。

  • Alibaba Cloud アカウントRAMユーザーAliyunDataWorksFullAccess ポリシーがアタッチされている RAM ユーザー、および テナント管理者は、をチェックするために使用される拡張機能を有効化できます。拡張機能が有効になると、拡張機能が DataWorks に処理結果を返すまで、すべてのワークスペースで実行される操作を中断するために使用できます。/* Alibaba Cloudアカウント、AliyunDataWorksFullAccessポリシーがアタッチされているRAMユーザー、およびテナント管理者は、テナントレベルの拡張ポイントイベントをチェックするために使用される拡張機能を有効化できます。拡張機能が有効になると、拡張機能がDataWorksに処理結果を返すまで、すべてのワークスペースで実行される操作を中断するために使用できます。 */

  • ワークスペース管理者は、ワークスペースレベルの拡張ポイントイベントをチェックするために使用される拡張機能を有効化できます。このタイプの拡張機能は、拡張機能が有効になるワークスペースが指定された後にのみ有効化できます。拡張機能が有効になると、拡張機能が DataWorks に処理結果を返すまで、ワークスペースで実行される操作を中断するために使用できます。

説明
  • 目的の拡張機能が見つからない場合は、[オープン プラットフォーム][拡張機能] ページに移動して、拡張機能が公開されているかどうかを確認します。

  • [オープン プラットフォーム] の [拡張機能] ページで拡張機能の 拡張機能のオプション パラメーターを設定した場合、[管理センター] の [拡張機能のオプション] ダイアログボックスで [オプション] パラメーターを設定できます。[拡張機能のオプション] ダイアログボックスは、[拡張機能] ページの拡張機能の [アクション] 列の [設定] をクリックした後に表示されます。

DataWorks サービス

ワークスペース管理者または テナント管理者が前のセクションの操作を実行して、特定のワークスペースまたはテナントに属するすべてのワークスペースで拡張機能を有効にした場合、開発者または O&M エンジニアが指定されたワークスペースまたはテナントレベルで関連する拡張ポイントで操作を実行すると、拡張機能が DataWorks に処理結果を返すまで操作は中断されます。ユースケースの詳細については、以下のトピックをご参照ください。