Skip to content

Asset Change Notification

The asset change notification package sends notifications when assets are created and/or updated and/or deleted. The following events (configurable) are taken into account:

  • Asset created
  • Asset deleted
  • Description created/updated
  • Alias created/updated
  • Asset starred
  • Announcement created/updated
  • Term linked/unlinked
  • Owners added/removed
  • Tag Added
  • Tag Removed
  • Tag Added via propagation
  • Tag Removed via propagation

Configuration

Configuration

  • Asset type: provide the list of asset types in scope, separated by commas. List of asset types.
  • Start date: provide the start date from where to start to extract events. Please note that the Start date paremeter is used only during the first execution of the workflow. Any subsequent runs will use the last processed date from the previous execution.
  • Action

    Export only created assets.

    Export only deleted assets.

    Export only updated assets. One or multiple event types can be selected:

    • Description
    • Alias
    • Asset
    • Announcement
    • Term
    • Owners
    • Tag Added
    • Tag Removed
    • Tag Added via propagation
    • Tag Removed via propagation

    Export both created and updated assets. One or multiple event types can be selected:

    • Description
    • Alias
    • Asset
    • Announcement
    • Term
    • Owners
    • Tag Added
    • Tag Removed
    • Tag Added via propagation
    • Tag Removed via propagation

Filters

Only assets that match the filters will be added to the notification.

  • Qualified name prefix: list of qualified name prefixes, separated by commas.
  • Qualified name contains: list of texts contained in the qualified name, separated by commas.
  • Certificate status: asset certificates
  • Owner user: asset owners (user), separated by commas.
  • Owner group: asset owners (group), separated by commas.
  • Tag: asset tags, separated by commas.

Notification

  • Notification channel

    Tip

    The generated CSV files are also stored in the tenant's S3 bucket (regardless of the notification option selected below) at the prefix:.argo-artifacts/default/<workflow-run-name>/. Three .csv files are stored for their respective events found during the run: Assets created, Assets updated and Assets deleted.

    • Email address(es): provide any email addresses you want the report sent to, separated by commas.
    • Atlan group(s): provide the list of Atlan groups you want the report sent to, separated by commas.
    • Email subject: provide the subject of the email. If empty the default subject is used.

    Note

    The list of assets is sent both in the email body and as attachment (csv file). The attached files contain the list of events, i.e. if an asset is updated twice in a given time period two entries will be added to the file.

    Warning

    The max size for sending attachments is 25 MB. Please consider to use another output method if the generated file is bigger than 25 MB.

    The generated files can be downloaded from the Atlan workflow section.

    Note

    The files contain the list of events, i.e. if an asset is updated twice in a given time period two entries will be added to the file.

    The generated files can be exported to any desired object storage of choice from the below options.

    Note

    The files contain the list of events, i.e. if an asset is updated twice in a given time period two entries will be added to the file.

    • AWS access key: your AWS access key.
    • AWS secret key: your AWS secret key.
    • Region: your AWS region.
    • Bucket: your AWS bucket.

    Reusing Atlan's backing S3 store

    When your Atlan tenant is deployed in AWS, you can leave all of these blank to reuse the backing store of Atlan itself.

    • Project ID: the ID of your GCP project.
    • Servive account JSON: your service account credentials, as JSON.
    • Bucket: your GCS bucket.

    Reusing Atlan's backing GCS store

    When your Atlan tenant is deployed in GCP, you can leave all of these blank to reuse the backing store of Atlan itself.

    • Azure client ID: the unique application (client) ID assigned to your app by Azure AD when the app was registered.
    • Azure client secret: your Azure client secret (it's actual value, not its identifier).
    • Azure tenant ID: the unique identifier of the Azure Active Directory instance.
    • Storage account name: name of your storage account.
    • Container: your ADLS container.

    Reusing Atlan's backing ADLS store

    When your Atlan tenant is deployed in Azure, you can leave all of these blank to reuse the backing store of Atlan itself.

    • Folder Path: The path for folder in the object store where you want to store the files generated by the workflow.
      • Do not add a trailing '/' for the path.
      • Do not include the bucket name in the path.
      • Do not include the file names in the path.
      • When left empty, files are ingested directly in the bucket. There is no default folder path.
    • File Name : Created Assets: Provide the name of the file where the created assets file will be stored. Do not include the extension. (Default: asset-created)
    • File Name : Updated Assets: Provide the name of the file where the updated assets file will be stored. Do not include the extension. (Default: asset-updated)
    • File Name : Deleted Assets: Provide the name of the file where the deleted assets file will be stored. Do not include the extension. (Default: asset-deleted)

What it does

The package performs the following steps:

  • Fetch assets that have been updated/created/deleted since the last workflow run accoring to the filters specified in the Configuration section.
  • Retrieve assets from Atlan.
  • Generate csv files with the extracted assets.
  • Send the generated csv files to the selected output channel.