Assertion Settings Changes Erasing Notes Tab Content – DataHub Customer Support Portal

Area: Product Issues

Sub-Area: Assertion Management

Issue

When editing assertion settings in the Settings tab, the description and context content in the Notes tab gets erased after saving changes. This occurs because the assertion update process overwrites the entire assertion record using only the fields present in the settings form, inadvertently clearing the Notes tab content which is not included in that payload.

You Might Be Asking

Why does my assertion documentation disappear when I change settings?
How can I preserve notes when updating assertion configurations?
Is this expected behavior in DataHub assertions?

Solution

This issue has been fixed in DataHub version 3.18 and later. The backend now properly preserves existing notes when updating assertion settings.

For versions 3.18 and later:

Upgrade to DataHub version 3.18 or higher
The fix will automatically preserve Notes tab content when editing Settings
No workaround is needed

For versions prior to 3.18 (workaround):

Before editing assertion settings, open the Notes tab and copy all description text
Navigate to the Settings tab and make your desired changes
Save the settings changes
Return to the Notes tab and paste the content back in
Save the notes content

Example workflow:
1. Copy notes content: "This assertion monitors daily data freshness..."
2. Edit settings: Change schedule from daily to hourly
3. Save settings
4. Restore notes: Paste "This assertion monitors daily data freshness..."
5. Save notes

Additional Notes

This was confirmed as a product defect, not intended behavior. The issue affected DataHub Cloud and required a backend fix from the engineering team. Users on self-hosted deployments should ensure they upgrade to version 3.18 or later to receive this fix. The workaround is only necessary for versions prior to 3.18.