OpenEvent real-time message subscription for DataWorks - DataWorks

OpenEvent for DataWorks pushes status-change messages to EventBridge, enabling you to subscribe and respond in real time. For example, subscribe to table changes to monitor core tables, or subscribe to task changes to build custom monitoring dashboards.

Overview

DataWorks pushes status-change messages from its core processes to OpenEvent. Use the OpenEvent module to manage message pushes for your workspace, and use EventBridge to filter and consume event messages.

Advantages:

Low O&M cost: Enable message subscription in DataWorks Open Platform to subscribe to event messages.
Faster development: Configure subscriptions in the DataWorks console without manual message-sending setup. Prepare the SDK and subscribe.
Customizable responses: Subscribe to specific event types to detect business changes and trigger personalized responses.

Usage notes

Edition: DataWorks Enterprise Edition only.
Regions: Supported in China (Beijing), China (Hangzhou), China (Shenzhen), China (Shanghai), China (Zhangjiakou), China (Chengdu), US (Silicon Valley), US (Virginia), Germany (Frankfurt), Japan (Tokyo), China (Hong Kong), and Singapore.
Access control: Only Open Platform Administrator, Tenant Administrator, Alibaba Cloud accounts, or RAM users with Aliyundataworksfullaccess have read and write permissions for the developer console. Open Platform administrator. Grant the AliyunDataWorksFullAccess permission to a RAM user.
Dependency: OpenEvent uses EventBridge for message subscription and consumption. Activate EventBridge before you begin.

Related concepts

DataWorks classifies event messages into regular events and extension point events based on whether they create process checkpoints.

Regular Events: Develop a local program to receive these messages and create custom responses.
Extension Point Events: These events support all regular event capabilities. You can also register a local program as a DataWorks extension to implement custom logic and behavior controls such as intercepting or blocking user operations.

Events are also classified by scope into workspace-level events and tenant-level events.

Workspace-level events: Generated by workspace-level modules such as Data Studio (node execution) and Operation Center (scheduled instance status changes).
Tenant-level events: Generated by tenant-level modules, such as workspace deletion from the console. The following event tables list the type, category, and message format for each module.

Supported event types

The following tables list extension point events and regular events at the workspace and tenant levels.

Tenant-level events

Console

Console message formats: Console event message formats.

Event type	Event	Regular event	Extension point event	Example (operations that generate event messages)
Delete a workspace	Pre-delete workspace event	Not supported	Supported	Before a user deletes a workspace, this event is triggered. The Pre-delete Workspace Event triggers the corresponding extension to create a process checkpoint.
Delete a workspace	Post-delete workspace	Supported	Not supported

Data Upload & Download

Message formats: Data Upload & Download event message formats.

Event type	Event	Regular event	Extension point event	Example (operations that generate event messages)
Data download and upload	Pre-data download event - File generation	Not supported	Supported	A user downloads data from the download center. Before the download, the Pre-data Download Event captures information about the operation.
	Pre-data download event - File download	Not supported	Supported
	Pre-data upload event	Not supported	Supported

Workspace-level events

Data Studio

Message formats: Data Studio event message formats.

Event type	Event	Regular event	Extension point event	Example (operations that generate event messages)
Node changes	Add a node	Supported	Not supported	Create a node and deploy it to production
Node changes	Update a node	Supported	Not supported	Modify a node in the development environment Deploy the modification to production
File changes Node Resource Function	Pre-file delete event	Not supported	Supported	Delete a file in the development environment. The deleted file is moved to the recycle bin.
	Pre-file submit event	Not supported	Supported	Submit a node, resource, or function in Data Studio.
	Pre-file deploy event	Not supported	Supported	Deploy a submitted node, resource, or function in Data Studio.
	Pre-code run event	Not supported	Supported	Run node code in Data Studio.
Table changes	Pre-table submit to development event	Not supported	Supported	Table submit extension point event: For example, submit a table in table management.
Table changes	Pre-table submit to production event	Not supported	Supported	Table deploy extension point event: For example, deploy a table in table management. Note Only standard mode workspaces support deploying tables in table management. Therefore, the table deploy extension point event exists only in standard mode.

Data Integration

Message formats: Data Integration event message formats.

Event type	Event	Regular event	Extension point event	Example (operations that generate event messages)
Node change events	Start a real-time task	Not supported	Supported	Start a real-time task in Data Integration.
Node change events	Batch start real-time tasks	Not supported	Supported	Batch start real-time tasks in Data Integration.

Operation Center

Message formats: Operation Center event message formats.

Event type	Event	Regular event	Extension point event	Example (operations that generate event messages)
Node changes	Delete a node	Supported	Not supported	Deploy the delete operation to production to undeploy the production node Delete a node from the recycle bin
	Pre-node undeploy event	Not supported	Supported	Directly undeploy a node from the scheduled tasks in the production environment. Note This operation also deletes the node in Data Studio and moves it to the recycle bin.
	Pre-node freeze event	Not supported	Supported	Freeze a task on the scheduled tasks page.
	Pre-node unfreeze event	Not supported	Supported	Unfreeze a task on the scheduled tasks page.
Node backfill data	Pre-backfill data event	Not supported	Supported	Backfill data for the current node of a scheduled task. Backfill data for the current node and downstream nodes of a scheduled task. Backfill data in massive node mode. Backfill data in advanced mode.
Task status changes	Scheduled task status change	Supported	Not supported	The following scenarios trigger a scheduled task status change event: A scheduled task is sent to Data Quality for data validation. A scheduled task validates branch conditions. A task is triggered by schedule, manually, or by an event. The task status changes from Pending Resource to Running. A scheduled task finishes execution (succeeded or failed). The task status changes from Running to Succeeded. After a scheduled task fails, you choose to rerun it. The task status changes from Failed to Running. A scheduled task is set to run at a specific time. The task status changes to waiting for the scheduled time (DueTime or cycleTime) to arrive.
Instance changes	Freeze an instance	Supported	Not supported	The following events are triggered after you perform these operations on an instance in the scheduled instance list in Operation Center. Freeze an instance. Unfreeze an instance. Terminate an instance. Rerun an instance. Mark an instance as succeeded. Remove a specified upstream dependency of an instance.
	Unfreeze an instance	Supported	Not supported
	Terminate an instance	Supported	Not supported
	Rerun an instance Rerun Rerun downstream	Supported	Not supported
	Mark an instance as succeeded	Supported	Not supported
	Remove a specified upstream dependency of an instance	Supported	Not supported
	Pre-freeze instance event	Not supported	Supported	When you perform an operation on an instance in the scheduled instance list in Operation Center, the corresponding pre-event is triggered. Freeze an instance. Unfreeze an instance. Rerun an instance. Mark an instance as succeeded. Terminate an instance.
	Pre-unfreeze instance event	Not supported	Supported
	Pre-rerun instance event	Not supported	Supported
	Pre-mark instance as succeeded event	Not supported	Supported
	Pre-terminate instance event	Not supported	Supported
	Delete expired instances	Supported	Not supported
Workflow status changes	Workflow status change Backfill data instances Manual workflows	Supported	Not supported	Workflow status monitoring generated when a backfill data operation is performed. Workflow status monitoring generated when a manual workflow is run.
Monitoring alerts	Monitoring alert	Supported	Not supported	Baseline alert example: A task on a baseline has an estimated completion time that is too late, triggering a baseline alert. Event alert example: A task on a baseline fails, triggering an event alert. Rule alert example: After a monitoring rule for orphan nodes is created, an orphan node appears in a workflow, triggering this rule alert.

Security Center

Message formats: Security Center event message formats.

Event type	Event	Regular event	Extension point event	Example (operations that generate event messages)
Permission request creation/approval	Pre-create permission request event	Not supported	Supported	For example, in Security Center, go to the Data Access Control > Permission Request page to create permission requests for Functions, Tables, and Resources.
Permission request creation/approval	Complete a request	Supported	Not supported	For example, in Security Center, go to the Data Access Control > Permission Approval page to approve permissions for tables, resources, and functions across all projects.
Table permission changes	Table permission request	Not supported	Supported	For example, a user requests read, write, or modify permissions for a specific table based on their needs.

Data Quality

Message formats: Data Quality event message formats.

Event type	Event	Regular event	Extension point event	Example (operations that generate event messages)
Data quality validation	Validation result feedback	Supported	Not supported	Feedback on validation results. For example, in Data Quality, enable a rule requiring a table's row count to be greater than 0. A user submits feedback on a validation result, and the system sends the feedback (rule ID, content, and other information) to the subscriber.
Data quality validation	Validation completed	Supported	Not supported	After rule validation completes, the result (pass/fail status, samples, and other information) is sent. For example, in Data Quality, enable a rule requiring a table's row count to be greater than 0. When validation completes, the result is sent to the subscriber.
Pre-data quality rule events	Pre-batch create data quality rules event	Not supported	Supported	For example, in Data Quality, go to the Rule Configuration > Configure by Table page and open the details page of a specific table. The following operations on the Rule Management tab trigger the corresponding pre-events. Create multiple data quality monitoring rules. Modify multiple data quality monitoring rules. Delete multiple data quality monitoring rules. Modify a specific data quality monitoring rule.
	Pre-batch update data quality rules event	Not supported	Supported
	Pre-batch delete data quality rules event	Not supported	Supported
	Pre-update data quality rule event	Not supported	Supported
Pre-data quality monitoring events	Pre-create data quality monitoring event	Not supported	Supported	For example, in Data Quality, go to the Rule Configuration > Configure by Table page and open the details page of a specific table. The following operations on the Quality Monitoring tab trigger the corresponding pre-events. Create a data quality monitoring configuration. Modify a data quality monitoring configuration. Clone a data quality monitoring configuration. Batch delete data quality monitoring configurations.
	Pre-update data quality monitoring event	Not supported	Supported
	Pre-clone data quality monitoring event	Not supported	Supported
	Pre-batch delete data quality monitoring event	Not supported	Supported
Pre-data quality monitoring alert subscription events	Pre-create data quality monitoring alert subscription event	Not supported	Supported	For example, in Data Quality, go to the Rule Configuration > Configure by Table page and open the details page of a specific table. On the Quality Monitoring tab, subscribe to alerts for a specific quality monitoring configuration.
	Pre-update data quality monitoring alert subscription event	Not supported	Supported	For example, in Data Quality, go to the Rule Configuration > Configure by Table page and open the details page of a specific table. On the Quality Monitoring tab, modify the alert subscription information of a specific quality monitoring configuration.
	Pre-delete data quality monitoring alert subscription event	Not supported	Supported	For example, in Data Quality, go to the Rule Configuration > Configure by Table page and open the details page of a specific table. On the Quality Monitoring tab, delete the alert subscription information of a specific quality monitoring configuration.