DataWorks Open Platform で拡張機能を登録、公開、有効化すると、拡張機能が有効になります。拡張機能が有効になっているワークスペースのサービスページで、拡張ポイントイベントをトリガーする操作を実行すると、DataWorks はイベントメッセージを拡張機能に送信します。その後、拡張機能は拡張ポイントイベントをチェックします。拡張機能から返された結果を表示できます。このトピックでは、運用センターでサポートされている拡張ポイントイベントと、拡張ポイントを使用して拡張機能をトリガーしてイベントをチェックする方法について説明します。
前提条件
イベントメッセージサブスクリプション機能が有効になっています。詳細については、「イベントメッセージサブスクリプションの有効化」をご参照ください。
拡張機能が開発およびデプロイされています。詳細については、「Function Compute に基づく拡張機能の開発とデプロイ」をご参照ください。
背景情報
DataWorks は、拡張ポイントイベントのメッセージを拡張機能に送信できます。拡張ポイントイベントをチェックするには、DataWorks でサポートされている拡張ポイントに基づいて、拡張ポイントイベントに関連する拡張機能を有効にします。また、拡張機能を使用して、拡張ポイントイベントの処理ロジックをカスタマイズすることもできます。前述の機能を実装するには、DataWorks コンソールで拡張機能を登録し、SettingCenter の [拡張機能] ページに移動して拡張機能を有効にする必要があります。
機能
運用センターでは、次の拡張ポイントに関連するイベントが生成されたときに、ローカルサービスがメッセージを受信できます。また、ローカルプログラムを DataWorks 拡張機能として登録し、拡張機能を使用して拡張ポイントイベントに関連するメッセージを受信することもできます。拡張機能は、カスタムロジックに基づいて拡張ポイントイベントを処理し、UpdateWorkbenchEventResult オペレーションを呼び出すことで、チェック結果をプラットフォームに送信できます。これは、DataWorks でのプロセスコントロールを実現するのに役立ちます。次の表に、運用センターでサポートされている拡張ポイントイベントを示します。
イベント名 | イベント内容 |
ノード変更イベント |
説明 ノードとは、本番環境の運用センターの [周期タスク] ページに表示される自動トリガーノードを指します。 |
データバックフィルイベント |
|
上記のノードは、本番環境の運用センターの [周期タスク] ページに表示される自動トリガーノードを指します。本番環境の [ノード] で上記の操作を実行すると、登録されている拡張機能はトリガーされたイベントをチェックします。開発環境のノードで上記の操作を実行する場合、または [周期インスタンス] ページでノードインスタンスをフリーズまたはフリーズ解除する場合は、拡張機能はトリガーされたイベントをチェックしません。
サポートされている拡張ポイントイベント
運用センターでノードをフリーズまたはフリーズ解除する
次の図は、ノードをフリーズしたときに生成されるイベントのチェックをトリガーして表示する方法を示しています。
運用センターでノードをアンデプロイする
運用センターでノードのデータをバックフィルする
参照
拡張機能を有効にする方法については、「拡張機能の使用」をご参照ください。
運用センターでサポートされているその他の拡張ポイントイベントについては、「拡張機能」をご参照ください。
データバックフィルイベントのメッセージ本文については、「開発リファレンス: イベントリストとイベントメッセージ形式」をご参照ください。
ノード変更イベントのメッセージ本文については、「開発リファレンス: イベントリストとイベントメッセージ形式」をご参照ください。