DataWorks:Overview

Limits

• The OpenEvent module is in public preview for DataWorks Enterprise Edition users and is available in the following regions: 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 (Singapore).
• The OpenEvent module allows you to use EventBridge to subscribe to and consume messages. Therefore, you must activate EventBridge. For more information, see What is EventBridge?.
• Only an Alibaba Cloud account or a RAM user to which the AliyunDataWorksFullAccess policy is attached can be used to configure parameters to subscribe to and consume event messages in the DataWorks console. For more information about permission control by fine-grained RAM policies, see Manage permissions on the DataWorks services and the entities in the DataWorks console by using RAM policies.

Supported event types

DataWorks allows you to subscribe to regular events and extension point events.

• Regular events: You can only subscribe to this type of event.
• Extension point events: You can subscribe to this type of event, and use an extension provided by DataWorks to customize your responses to the event messages that you receive.

The following table describes the types of events to which you can subscribe in Operation Center, DataStudio, and Data Governance.

Service module	Event category	Event description and type	Example
Operation Center	Instance status change events	Description: the event that is triggered by the changes to the status of an instance. Type: regular events. You can subscribe to this type of event. This way, you can receive notifications about instance status changes in real time.	An instance status change event is triggered when the status of an auto triggered node instance changes from Not running to Running or from Running to Run failed.
	Instance operation events	Description: the event that is triggered when you perform an operation such as freezing or unfreezing an instance in Operation Center. Type: regular events. You can subscribe to this type of event. This way, you can receive notifications about instance operation events in real time.	An instance operation event is triggered when you perform an operation such as freezing an instance in Operation Center.
	Workflow status change events	Description: the event that is triggered by the changes to the status of a workflow. Type: regular events. You can subscribe to this type of event. This way, you can receive notifications about workflow status changes in real time.	A workflow status change event is triggered when you backfill data for a node. A workflow status change event is triggered when a manually triggered workflow is run.
	Node change events	Description: the event that is triggered by the changes to a node in Operation Center in the production environment. Types: regular events and extension point events.	Regular events: You can develop a local consumer program to consume this type of event message. This way, you can customize your responses to the event messages that you receive based on your business requirements. Node addition events Node update events Node deletion events Extension point events: This type of event has the characteristics of regular events. You can also register your local consumer program as a DataWorks extension to customize processing logic and process control for extension point events. Node undeployment pre-events Node freezing pre-events Node unfreezing pre-events Note The nodes here refer to the auto triggered nodes that are displayed on the Cycle Task page of Operation Center in the production environment.
	Data backfill events	Description: the event that is triggered when you backfill data for a node in Operation Center in the production environment. Type: extension point events.	Event examples: Backfill data for an auto triggered node. Backfill data for an auto triggered node and the descendant nodes of the node. Backfill data for a large number of nodes. Backfill data for multiple nodes that do not have dependencies with each other at a time in advanced mode.
Monitoring and alerting	Alert events	Description: the event that is triggered when an alert rule that you specified in Operation Center is matched. Type: regular events.	Event examples: Baseline alerts: If a node in a baseline does not finish running before its estimated latest completion time, an alert is triggered. Event-based alerts: If a node in a baseline fails to be run, an alert is triggered. Rule-based alerts: After you create an alert rule for an isolated node and the isolated node is identified in a workflow, an alert is triggered.
DataStudio	File change events	Description: the event that is triggered by the changes to the status of a file such as a node, resource, or function in DataStudio. Type: extension point events. You can subscribe to this type of event and use an extension provided by DataWorks to customize your responses to the event messages that you receive.	Event examples: File commitment events: When a node, resource, or function is committed, a file commitment event is triggered. File deployment events: When a node, resource, or function is deployed, a file deployment event is triggered. Node execution events: When the code of a node is executed, a node execution event is triggered. File deletion events: When a node, resource, or function is deleted, a file deletion event is triggered.
	Table change events	Description: the event that is triggered by the changes to the status of a table on the Workspace Tables page of DataStudio. Type: extension point events. You can subscribe to this type of event and use an extension provided by DataWorks to customize your responses to the event messages that you receive.	Event examples: Table commitment events: When a table is committed on the Workspace Tables page of DataStudio, a table commitment event is triggered. Table deployment events: When a table is deployed on the Workspace Tables page of DataStudio, a table deployment event is triggered. Note You can deploy tables on the Workspace Tables pane only in a workspace in standard mode. Table deployment events can be triggered only in workspaces that are in standard mode.
Security Center	Approval Center events	Description: the event that is triggered when a request order is created or a request order is processed. Type: regular events. You can subscribe to this type of event. This way, you can receive notifications about event status changes in real time.	Event examples: Request order creation events: When you create a request order by clicking Apply for Function and Resource Permissions in the upper-right corner of the Permission Management tab on the My Data page in Data Map, a request order creation event is triggered. Request order processing events: When the current member that is assigned the Workspace Manager role processes a request order for tables, resources, or functions on the To Be Approved subtab of the Permission Management tab on the My Data page in DataMap, a request order processing event is triggered.
Data Quality	Check result feedback events	Description: the event that is triggered when feedback on a check result obtained based on a monitoring rule is sent in Data Quality. Type: regular events. You can subscribe to this type of event. This way, you can receive notifications about event status changes in real time.	For example, you enable a monitoring rule that is used to check whether the number of rows in a table exceeds 0 for a specific table in Data Quality. If the rule is triggered and the check is complete, the system sends the check result that contains information such as the result of whether data passes the quality check, and samples to a subscriber. A data quality check completion event is triggered when the check result is sent.
	Check completion events	Description: the event that is triggered when a check that is performed based on a monitoring rule is complete in Data Quality. Type: regular events. You can subscribe to this type of event. This way, you can receive notifications about event status changes in real time.	For example, you enable a monitoring rule that is used to check whether the number of rows in a table exceeds 0 for a specific table in Data Quality. After the rule is triggered and the check is complete, users can provide their feedback on the check result. After the feedback is provided, the system sends the feedback that contains information such as the monitoring rule ID and feedback content to a subscriber. A data quality check result feedback event is triggered when the feedback is sent.

Note Network latency may delay the delivery of event messages.

Procedure

To use the OpenEvent module, you must complete the following configurations:

1. In the EventBridge console, activate EventBridge and create a custom bus.
2. Enable the message subscription feature and add an event distribution channel in DataWorks.
3. Configure the custom bus in the EventBridge console.
4. Publish events in the EventBridge console. For more information, see Publish an event.

Benefits