How does version control work for description changes made in source tools vs. the Atlan UI?

Have more questions? Submit a request

Anticipating that users could update metadata across Atlan and at the source, we handle descriptions in two fields, populating either or both depending on where the it was created/updated.

  • Source descriptions are stored in the description field
  • Any description added or updated in Altan is stored in the userDescription field.

These are kept as separate fields so that the connection package doesn't override the description entered by users every time the workflow runs and updates the asset in Atlan.

Basically the Atlan description field becomes the source of truth.

The only exception is, if this field is not edited by any user at all and the connection package only ever brings the descriptions from the source, then the workflow will keep updating the description field with what's available at the source - meaning only source edits will come through.

The moment the description is edited in Atlan, the userDescription field takes over.

As a best practice, we recommend all subsequent edits to the description be done in Atlan.

This is valid across all our connector workflows.

Related articles

Was this article helpful?
0 out of 0 found this helpful