Add and manage issue checklist - Dataphin - Alibaba Cloud Documentation Center

On the issue checklist page, you can view the abnormal results from data quality rule validations and reported issues during asset or tag usage. Additionally, you can initiate governance operations such as remediation, exception ignoring, and whitelisting for these issues. This topic describes the procedures for adding and managing the issue checklist.

Usage instructions

The Data Quality module must be activated.

Permission instructions

Super administrators and quality administrators can access and manage all details of the issue checklist, including initiating remediation, whitelisting, ignoring exceptions, and reprocessing issues.
Other members can view the issues they have reported and, if they are the owner, can perform relevant operations, including initiating remediation, whitelisting, ignoring exceptions, and reprocessing issues.
Users with object view permissions can add issues.
Operation permissions vary by object. For more information, see Issue Checklist Operation Permissions.

View issue checklist from different perspectives

Dataphin supports viewing issue checklist details from three perspectives: Global, Project, and Personal.

Global: Super administrators and quality administrators can view all issue checklists globally.
Project: Super administrators and quality administrators can switch to any project globally and view the issue checklist for asset objects within that project. Other members can only access projects they are part of and view the issue checklist for those projects.
Note
The project perspective does not include object types such as global tables, data sources, and tags.
Personal: Super administrators and quality administrators can switch to any member's view and access their issue checklist. Other members can view the issue checklist for issues they reported or are responsible for, but cannot switch perspectives.

Add issues

Navigate to the Dataphin home page, select Administration > Data Quality from the top menu bar.
In the left-side navigation pane, click Checklist, then click Add Issue to open the Feedback Quality Issue dialog box.

Within the Feedback Quality Issue dialog box, configure the necessary parameters.

Parameter	Description
Issue Object	Select the object for which you need to provide feedback. Configure the corresponding parameters based on the object type. For data tables and real-time meta tables, if no specific field is selected, the issue is recorded at the table granularity. If a specific field is selected, the issue is recorded at the specified field granularity.
Issue Type	Select the type of the issue. If there is no suitable issue type, you can contact an authorized administrator to create one. For more information, see custom issue type.
Issue Description	Please provide a brief description of the issue to help the issue owner understand the relevant background information. The description can be up to 1,000 characters in length.
Attachment	Click the Upload button to select the file you need to upload from your local system. A single issue supports uploading up to five files. Files support Doc (.doc, .docx, .dot, .dotx, .rtf, .html, .xml, .txt), Excel (.xls, .xlsx, .csv), PDF, and image (.jpg, .png, .jpeg) formats, with a size limit of 10 MB.
Contact Information	If convenient, you can provide your contact information to facilitate further communication with the issue owner. Supported contact methods include phone, email, and others. Phone: Supports input of numbers, hyphens (-), plus signs (+), half-width parentheses, and spaces, with a length not exceeding 20 characters. Email: Please enter your email address. Others: Supports input with a length not exceeding 100 characters.

Click OK to finalize the issue addition.

View the issue checklist

The issue checklist page lists issues identified during data quality checks and feedback from asset or tag usage. Here, you can initiate rectification, whitelist, ignore, notify, and carry out other actions for the issues.

Parameter	Description
①Legend card	Displays the number of pending issues and total number of issues for different object types, including Dataphin tables, global data tables, metrics, data sources, real-time meta tables, and tags. You can switch to view the corresponding issue checklist.
②Search and filter area	You can perform a fuzzy search based on the name of the verification object or the name of the quality rule. Dataphin tables, global data tables, metrics, data sources, real-time meta tables can be precisely filtered based on pending, proposed by me, owned by me, rule strength, issue status, issue type, proposal method/proposer, issue owner. Tags can be precisely filtered based on pending, proposed by me, owned by me, issue status, issue type, issue owner. Custom Issue Type: Click Manage after the issue type to fill in the name of the issue type in the Manage Issue Type dialog box. The name length should not exceed 20 characters. Click OK to complete the creation of the issue type. System built-in issue types do not support editing or deletion operations; custom issue types support editing or deletion operations. Up to 50 issue types can be created.
③Issue checklist	Only system-automatically identified issues generated through quality rule verification display rule name, rule strength, verification scope, and verification time information; only manually entered quality issues display proposer information. Different issue statuses support different administration operations. For more information, see single operation. Dataphin tables, global data tables display table name, issue object, rule name/ID, issue status, issue type, issue description, rectification flow, rule strength, issue owner, verification scope, verification time, proposal method/proposer, related knowledge base document information. Metrics display metric name, rule name/ID, issue status, issue type, issue description, rectification flow, rule strength, issue owner, verification scope, verification time, proposal method/proposer, related knowledge base document information. Data sources/real-time meta tables display data source name/table name, issue object, rule name/ID, issue status, issue type, issue description, rectification flow, rule strength, issue owner, verification time, proposal method/proposer, related knowledge base document information. Tags display tag name (code), issue status, issue type, issue description, rectification flow, issue owner, proposal method/proposer information. Click the icon before refresh to select the fields of the issue checklist you want to display.
④Batch operation area	System-identified issues can perform batch operations on issue objects such as ignore this exception, cancel ignore, add to whitelist, initiate rectification, modify issue type, associate knowledge base document. Manually entered issues can perform batch operations on issue objects such as ignore this exception, cancel ignore, initiate rectification, mark as processed, return for reprocessing, modify issue type, change issue owner (only for tag object type). You can perform different administration operations in batches based on different issue statuses. For more information, see batch operation.

Operation instructions

Issue Status

Issue status	Operation items
Pending	System-identified issues support View Details, Initiate Rectification, Ignore This Exception, Notify Issue Owner, Add To Whitelist, Revalidate, Modify Issue Type, View Operation Log, Associate Knowledge Base Document. Manually entered issues support View Details, Initiate Rectification, Ignore This Exception, Notify Issue Owner, Change Issue Owner, Mark As Processed, Return For Reprocessing, Modify Issue Type, Delete Issue, View Operation Log.
Validating	System-identified issues support View Details, Initiate Rectification, Notify Issue Owner, Add To Whitelist, Modify Issue Type, View Operation Log, Associate Knowledge Base Document.
Completed	System-identified issues support View Details, Initiate Rectification, Modify Issue Type, View Operation Log, Associate Knowledge Base Document. Manually entered issues support View Details, Initiate Rectification, Change Issue Owner, Return For Reprocessing, Modify Issue Type, Delete Issue, View Operation Log.
Ignored	System-identified issues support View Details, Cancel Ignore, Revalidate, Modify Issue Type, View Operation Log, Associate Knowledge Base Document. Manually entered issues support View Details, Cancel Ignore, Change Issue Owner, Mark As Processed, Return For Reprocessing, Modify Issue Type, Delete Issue, View Operation Log.

Single Operation

Operation items	Description
View Details	System-identified issues support viewing rule verification details, operation logs, and related knowledge base information of the issue object. Verification Details: Click the icon under the operation column. In the View Details dialog box, click the Verification Details tab to display the latest verification details of the current issue, including basic information, verification configuration, and verification result information. Operation Log: Click the icon under the operation column. In the View Details dialog box, click the Operation Log tab to display the historical operation log information of the current issue. You can also filter operation logs based on the verification scope. Related Knowledge Base: Click the icon under the operation column. In the View Details dialog box, click the Related Knowledge Base tab to view the knowledge base information associated with the rule. You can also perform search, view, edit, and delete operations on the knowledge base. For operation details, see View knowledge base. Manually entered issues support viewing issue details and operation logs. Issue Details: Click the icon under the operation column. In the View Details dialog box, click the Issue Details tab to display the name of the feedback issue object, issue type, issue description, uploaded issue attachment, contact information, proposer, and owner information. Operation Log: Click the icon under the operation column. In the View Details dialog box, click the Operation Log tab to display the operation log information of the current issue, including issue object name, issue operation type, issue status, operation description, operator, and operation time information.
Initiate Rectification	After initiating rectification, you can query and track the entire rectification process of the issue. For rectification flow configuration, see Initiate rectification. For how to manage the rectification flow, see View and manage rectification flow. Note Only super administrators, quality administrators, issue owners, and custom global roles with administration console flow management permissions support initiating flows.
Ignore This Exception	After marking the pending issue as ignored, it will no longer need to be processed. It is recommended to ignore unimportant issues. Scenarios: The data source connectivity was interrupted in the middle, but it is now stable and does not need to be repaired. Alternatively, exceptions occurred in historical tasks, but the latest data processing no longer requires them, so you can choose to ignore them directly.
Cancel Ignore	After canceling the ignore for system-identified issues, the issue status will be determined based on the latest rule verification result. If the verification passes, the issue status will change to processed. If the verification fails, the issue status will change to pending. After canceling the ignore for manually identified issues, the issue status will change to pending. You can re-initiate rectification, add to the whitelist, or perform other administration operations for the issue.
Notify Issue Owner	You can notify the issue owner via Internal Message, Phone, Text Message, Email, Dingtalk.
Change Issue Owner	You can transfer the current issue owner to another user. In the Change Issue Owner dialog box, select the recipient and click OK to transfer immediately. It is recommended to sync the recipient promptly after the transfer.
Mark As Processed	Only manually entered issues in pending status support marking as processed. If rectification needs to be initiated, the processing result can be returned.
Return For Reprocessing	Only manually entered issues in processed status support returning for reprocessing. After returning, the issue status will change to pending. You can notify the issue owner via internal message to inform the relevant owner to handle it promptly. Note Only super administrators, quality administrators, issue owners, and custom global roles with administration console flow management permissions support returning for reprocessing operations.
Modify Issue Type	Supports classifying issues by type for easy filtering and summary statistics. System-automatically identified issues will have the corresponding system issue type added by default based on the quality rule type and do not support modification. Manually configured issue types can be added or deleted. If there is no suitable issue type, you can create one. For details, see Custom issue type.
Delete Issue	After deleting an issue, it will also be removed from the rectification flow. Deletion is irreversible, so please evaluate before proceeding.
Add To Whitelist	Scenarios: The current table is in the testing phase, and the data is unstable daily. Monitoring can be performed after the data stabilizes. For how to add to the whitelist, see Add to whitelist. For how to manage the whitelist, see View and manage administration whitelist. Note Only issues not ignored by system identification support adding to the whitelist. Other issues will be automatically skipped. After adding to the whitelist, the system will automatically ignore the errors generated by the current verification. The corresponding quality rules will still be executed and verified normally, generating quality reports, sending alerts, and blocking downstream tasks. During the whitelist validity period, newly generated quality issues within the same rule scope will not be reported. After the whitelist expires or is deleted, historical issues will not be reported, but subsequent new issues will be reported.
Revalidate	Only system-identified issues in pending or ignored status support revalidation. If the data quality issue has been processed, you can re-execute the verification rule for the current issue. The issue status will be modified based on the verification status after execution. If the verification passes, the issue status will change to processed. If the verification fails, the issue status will change to pending.
View Operation Log	Displays the operation log information of the current issue, including issue object name, issue operation type, issue status, operation description, operator, and operation time information.
Associate Knowledge Base Document	Only system-automatically identified issues support associating knowledge. After associating knowledge with rules, you can view the associated knowledge in quality rules and issue checklists. Supports batch configuration of knowledge bases for issue objects. For creation, see Create knowledge base.

Batch Operation

Operation items	Description
Ignore This Exception	After marking the pending issue as ignored, it will no longer need to be processed. It is recommended to ignore unimportant issues. Scenarios: The data source connectivity was interrupted in the middle, but it is now stable and does not need to be repaired. Alternatively, exceptions occurred in historical tasks, but the latest data processing no longer requires them, so you can choose to ignore them directly.
Cancel Ignore	Only ignored issues support cancel ignore operations. After canceling ignore, the status of manually entered issues will change to pending. The status of system-identified issues will be determined based on the latest rule verification result. If the verification passes, the issue status will change to processed. If the verification fails, the issue status will change to pending.
Add To Whitelist	Scenarios: The current table is in the testing phase, and the data is unstable daily. Monitoring can be performed after stabilization. For how to add to the whitelist, see Add to whitelist. For how to manage the whitelist, see View and manage administration whitelist. For batch adding issue objects to the whitelist, the whitelist scope supported by Dataphin tables, global data tables, metrics, data sources, and real-time meta tables is Selected issues, Selected monitored objects. Selected Issues: During the validity period, if new quality verification failures occur for all selected pending and validating issues on the current page, they will automatically become ignored status. Selected Monitored Objects: For the selected issues on the current page and all pending and validating issues under the same monitored object as the selected issues on the current page, if new quality verification failures occur, they will automatically become ignored status. Note Only system-identified, non-ignored issues support adding to the whitelist. Other issues will be automatically skipped. After adding to the whitelist, the system will automatically ignore the errors generated by the current verification. The corresponding quality rules will still be executed and verified normally, generating quality reports, sending alerts, and blocking downstream tasks. During the whitelist validity period, newly generated quality issues within the same rule scope will not be reported. After the whitelist expires or is deleted, historical issues will not be reported, but subsequent new issues will be reported.
Initiate Rectification	After initiating rectification, you can query and track the entire rectification process of the issue details. The batch initiation of rectification flows is consistent with single operations. For more information, see Initiate rectification. For how to manage the rectification flow, see View and manage rectification flow. For batch initiation of rectification for issue objects, the rectification scope supported by Dataphin tables, global data tables, metrics, data sources, and real-time meta tables is Selected issues, Selected issues and rule-related issues, Selected monitored objects. Tags support rectification scope as Selected issues, All objects of selected tags. Selected Issues: Only rectification is performed for the issues selected on the current page. Selected Issues And Rule-related Issues: For the issues selected on the current page and other pending issues belonging to the same rule as the system-identified issues selected on the current page. Selected Monitored Objects: For the selected issues on the current page and all pending issues under the same monitored object as the selected issues on the current page, including manually entered issues and automatically identified issues. All Objects Of Selected Tags: For the issues selected on the current page and all pending issues under the same tag as the selected issues on the current page.
Revalidate	Only system-identified issues in pending or ignored status support revalidation. If the data quality issue has been processed, you can re-execute the verification rule for the selected issues on the current page. The issue status will be modified based on the verification status after execution. If the verification passes, the issue status will change to processed. If the verification fails, the issue status will change to pending.
Mark As Processed	Only manually entered issues in pending status support marking as processed. If rectification needs to be initiated, the processing result can be returned.
Return For Reprocessing	Only manually entered issues in processed status support returning for reprocessing. After returning, the issue status will change to pending status. Note Only super administrators, quality administrators, issue owners, and custom global roles with administration console flow management permissions support returning for reprocessing operations.
Modify Issue Type	Supports appending or modifying issue types. Only effective for custom issue types. System issue types automatically generated based on rule types are not effective. Append: Add the issue type configured this time to the existing issue types. Modify: Overwrite and update the existing custom types with the issue type configured this time.
Export Issues	Export the selected issues on the current page. In the dialog box, select the content to be exported and click OK.
Change Issue Owner	You can transfer the current issue owner to another user. In the Change Issue Owner dialog box, select the recipient and click OK to transfer immediately. It is recommended to sync the recipient promptly after the transfer.
Associate Knowledge Base Document	Only system-automatically identified issues support associating knowledge. After associating knowledge with rules, you can view the associated knowledge in quality rules and issue checklists. Supports batch configuration of knowledge bases for issue objects. For creation, see Create knowledge base.

Add to whitelist

You can add issues to the whitelist individually or in batches.

On the Issue Checklist page, select the desired issue, click the icon under the Actions column , and choose Add To Whitelist.

In the Add To Whitelist dialog box, set the parameters.

Parameter	Description
Whitelist Scope	Only issues detected by the system and not ignored can be added to the whitelist. For a single issue object, you can add the current rule or current monitored object to the whitelist. Current Rule: Within the validity period, if a new quality check failure occurs for issues under the same quality rule as the current issue and its current check record, they will automatically be marked as ignored. Current Monitored Object: Within the validity period, if a new quality check failure occurs for issues under the same monitored object as the current issue, they will automatically be marked as ignored.
Validity Period	You can choose 7 Days, 30 Days, 90 Days, 180 Days, Permanent, or Custom. The application day is not included. Note After the whitelist expires, historical issues will not be reported, but newly occurring issues will be reported.
Operation Instructions	This is a required field. Please provide the reason for adding to the whitelist. No more than 128 characters.

Click OK to add the issue to the whitelist.

Initiate Remediation

Initiating remediation is possible for both individual and batch issues.

On the Issue Checklist page, after selecting the issue, click the icon under the Actions column to enter the Initiate Remediation dialog box.

In the Initiate Remediation dialog box, adjust the parameters as needed.

Parameter	Description
Remediation Scope	For system-detected issue objects, remediation can be initiated for Current Issue, Current Rule, or Current Monitored Object. For manually entered issue objects, remediation can only be initiated for Current Issue. Current Issue: Includes only the issues of the current validation record itself and does not include other pending issues under the same rule as the current issue object. Current Rule: Includes the issues of the current validation record itself and all pending system-detected issues generated under its associated quality rule, which may include multiple different validation scopes. Current Monitored Object: Includes the issues of the current validation record itself and all pending system-detected issues under the same monitored object as the current issue, which may include multiple issue objects and validation scopes. Note If the currently selected issue is already in the remediation process, it will remain in the original remediation process and will not be initiated again.
Initiation Method	Supports creating a new flow or associating with an existing flow. Create New Flow: Customize the name of the remediation flow, up to 128 characters. Associate With Existing Flow: Supports associating with flows that are already created under the current object type and are in remediation or re-remediation status. Only super administrators, quality administrators, issue owners, and custom global roles with administration console flow management permissions can select all flows.
Remediate By	The remediator is the owner of the remediation process in the remediation flow. It is recommended to select the quality owner of the issue object to facilitate editing or re-initiating validation of system-detected issues in the remediation flow. Otherwise, the status of the issue may not be updated. If the initiation method is Associate with Existing Flow, the default is the remediator of the selected flow and cannot be modified.
Validated By	The validator is the final owner of the remediation results in the remediation flow. If the initiation method is Associate with Existing Flow, the default is the validator of the selected flow and cannot be modified.
Priority	Divided into three levels: High, Medium, and Low. If the initiation method is to associate with an existing flow, the default is the priority of the selected flow and cannot be modified.
Operation Instructions	Please fill in the reason for initiating remediation, up to 128 characters.

Click OK to start the remediation process.

Exporting issue checklists

Note

Only issue checklists with view permissions can be exported.
A single tenant can have up to 5 concurrent export tasks.
Generating a file for an extensive issue checklist may take some time. You can check the export history in the batch export panel. For more information, see issue export records or .

On the Issue Checklist page, click the Export Issues button in the upper-right corner. You can opt to Export All Issues or Export By Search And Filter Criteria.
- Export All Issues: Exports all issues of the specified object type within the current perspective.
- Export By Search And Filter Criteria: Exports issues filtered by keywords and search criteria within the current perspective, such as all issues with a Pending status.
In the dialog box, select the content you want to export.
Click OK to complete the export of the issue checklist.

Issue export records

Note

Shows the 50 most recent records of your export operations.
You can download successfully exported files within the past 7 days.

On the Issue Checklist page, click the Export Issues button in the upper right corner, and select View Batch Export Records.
In the Batch Export Records panel, check the status of your exports, including the issue's ordinal number, object type, submission time, and status. You can also download the issues to your local device by clicking the icon in the Actions column , facilitating business analysis and archiving.