DataWorks ワークスペースで拡張機能を登録・公開・有効化すると、対応する拡張ポイントイベントがトリガーされた際に DataWorks から拡張機能にイベントメッセージが送信されます。その後、拡張機能が返す結果を確認できます。本トピックでは、オペレーションセンターがサポートする拡張ポイントイベントについて説明し、それらを使用して拡張機能の検証をトリガーする方法を解説します。
前提条件
メッセージサブスクリプションが有効になっています。詳細については、「メッセージサブスクリプションの有効化」をご参照ください。
拡張機能プログラムが開発およびデプロイされています。詳細については、「拡張機能プログラムの開発とデプロイ：Function Compute」をご参照ください。
背景情報
DataWorks は、拡張ポイントイベントを通知するためにメッセージを送信できます。また、拡張機能を使用してワークフローを制御することも可能です。これを行うには、特定の拡張ポイントイベントに対して拡張機能を有効化します。その後、拡張機能がカスタムロジックを使用してイベントを処理します。これらの機能を利用するには、まず DataWorks 管理コンソールで拡張機能を登録し、次に で有効化する必要があります。
ワークスペースの管理者権限を持つユーザーのみが、 で拡張機能を有効化できます。
拡張機能の詳細については、「拡張機能の概要」をご参照ください。
この図は、ワークスペースレベルの拡張機能を示しています。詳細については、「対応している拡張ポイントイベントの一覧」をご参照ください。
機能
オペレーションセンター モジュールにより、ご利用のローカルサービスは以下の拡張ポイントイベントのメッセージを受信できます。また、ローカルプログラムを DataWorks 拡張機能として登録することも可能です。拡張機能はイベントメッセージを受信し、カスタムロジックで処理した後、UpdateWorkbenchEventResult コールバック API を使用して結果をプラットフォームに返します。これにより、DataWorks のワークフローを制御できます。オペレーションセンターがサポートする拡張ポイントは以下のとおりです。
イベント名 | イベントの詳細 |
ノード変更イベント |
説明 ここでいうノードとは、本番オペレーションセンターの 定期タスク リスト内のタスクを指します。 |
データバックフィルイベント |
|
ここでいうノードとは、本番オペレーションセンターの 定期タスク リスト内のタスクを指します。拡張機能の検証は、本番オペレーションセンターの 定期タスク インターフェイスでタスクに対して記載された操作を実行した際にトリガーされます。開発環境のオペレーションセンターで自動トリガータスクに対してこれらの操作を行っても、検証はトリガーされません。同様に、インスタンスインターフェイスからインスタンスを凍結または復元しても、検証はトリガーされません。
サポートされる拡張ポイント
オペレーションセンター - ノードの凍結と復元
次の図は、ノード凍結拡張ポイントの例を示しています。
オペレーションセンター - ノードの非公開
オペレーションセンター - データバックフィル
関連ドキュメント
拡張機能の有効化方法の詳細については、「拡張機能の適用」をご参照ください。
オペレーションセンターにおけるその他の拡張ポイントイベントの詳細については、「サポートされる拡張ポイントイベント一覧」をご参照ください。
データバックフィルイベントのメッセージエンティティフォーマットについては、「データバックフィルイベント」をご参照ください。
ノード変更イベントのメッセージエンティティフォーマットについては、「ノード変更イベント（追加、変更、削除、凍結、復元、非公開）」をご参照ください。