Synchronize Snowflake Cortex AI

Synchronizing Snowflake Cortex AI is the process of integrating metadata from Snowflake Cortex AI and making the data available in Collibra Platform.

You can synchronize manually or automate it by adding a synchronization schedule.

Prerequisites

In your Collibra environment

In your Snowflake Cortex AI environment

Your Snowflake Cortex AI integration role must have the following permissions:

Note 

For more information on granting permissions to Snowflake roles, go to the Snowflake Cortex AI documentation.

Steps

  1. On the main toolbar, click Products icon Catalog.
    The Catalog homepage opens.
  2. Click Integrations.
    The Integrations page opens.
  3. Click the Integration configuration tab.
  4. In the Connection name column, locate the Snowflake connection that you used when you added the Snowflake capability and click the link in the Capabilities column.
    The Synchronization page opens.
  5. In the Synchronization Configuration section, click Add Configuration.
  6. Complete the fields as needed.
  7. Field Action
    System asset Go to the General settings tab and add the System asset that represents your Snowflake connection. This asset is used by the Snowflake Cortex AI workflow for run tracking.
    Important If this asset doesn't exist yet, you must create it before synchronizing your Snowflake Cortex AI integration.
    Updated: <timestamp> (Optional)

    Click Updated: <timestamp> next to Synchronization Configuration, where timestamp indicates the last time when the data was loaded from Snowflake Cortex AI.

    If the Updated: <timestamp> is green, you don't need to refresh as the data is up to date. If it is red, refresh the data. If you don't see the option, the metadata hasn't been refreshed yet. As metadata is refreshed daily, try checking again later or tomorrow.

    Domain mappings Go to the Cortex AI tab. In Domain mappings, map Snowflake models to Collibra domains using path patterns in the following format: DATABASE > SCHEMA > MODEL.
    Exclude patterns

    In Exclude patterns, add path patterns that contain models you want the synchronization to skip in the following format: DATABASE > SCHEMA > MODEL.

    Excluded patterns are always considered first, regardless of what is added in the Domain mappings field.

    Fallback domain In Fallback domain, select the default domain for models that don't match any path pattern added in Domain mappings. If you don't select a Fallback domain, unmatched models are skipped.

    Fallback domain is required if you haven't added a Domain mapping. Both can be used simultaneously to ensure no models are skipped.

    Custom AI Metrics Mappings

    Optionally, in Custom AI Metrics Mappings, define the custom Snowflake Cortex AI model metrics that you want to integrate. You can do this by adding the mapping between the custom metric and Collibra attribute. The attribute list contains all attribute types that are assigned to the Snowflake Cortex AI Model asset type.

    After you synchronize the capability, the specified custom Snowflake Cortex AI Model metrics are mapped to the corresponding attributes.

    Important 

    If you use this feature, add any custom attributes/characteristics, as needed, to the asset type assignment.

    To add a custom AI metric mapping:

    1. Click Add Custom AI Metrics Mappings.
    2. In Metric, select the custom metric from the list of available Snowflake Cortex AI metrics.
    3. In Attribute, select the attribute in which you want to see the value.
      Make sure to select an attribute that is included in the Snowflake Cortex AI Model asset type assignment.
    Asset deletion mode Optionally, expand Advanced settings and set the Asset deletion mode
    1. Soft: Assets are archived and can be restored if the model reappears. This is the recommended mode.
    2. Hard: Assets are permanently deleted and cannot be recovered.
  8. Click Save.
  9. Click Synchronize.
    A notification indicates the synchronization has started.
  1. On the main toolbar, click Products icon Catalog.
    The Catalog homepage opens.
  2. Click Integrations.
    The Integrations page opens.
  3. Click the Integration configuration tab.
  4. In the Connection name column, locate the Snowflake connection that you used when you added the Snowflake capability and click the link in the Capabilities column.
    The Synchronization page opens.
  5. In the Synchronization Configuration section, click Add Configuration.
  6. Complete the fields as needed.
    FieldAction
    System assetGo to the General settings tab and add the System asset that represents your Snowflake connection. This asset is used by the Snowflake Cortex AI workflow for run tracking.
    Important If this asset doesn't exist yet, you must create it before synchronizing your Snowflake Cortex AI integration.
    Updated: <timestamp> (Optional)

    Click Updated: <timestamp> next to Synchronization Configuration, where timestamp indicates the last time when the data was loaded from Snowflake Cortex AI.

    If the Updated: <timestamp> is green, you don't need to refresh as the data is up to date. If it is red, refresh the data. If you don't see the option, the metadata hasn't been refreshed yet. As metadata is refreshed daily, try checking again later or tomorrow.

    Domain mappingsGo to the Cortex AI tab. In Domain mappings, map Snowflake models to Collibra domains using path patterns in the following format: DATABASE > SCHEMA > MODEL.
    Exclude patterns

    In Exclude patterns, add path patterns that contain models you want the synchronization to skip in the following format: DATABASE > SCHEMA > MODEL.

    Excluded patterns are always considered first, regardless of what is added in the Domain mappings field.

    Fallback domainIn Fallback domain, select the default domain for models that don't match any path pattern added in Domain mappings. If you don't select a Fallback domain, unmatched models are skipped.

    Fallback domain is required if you haven't added a Domain mapping. Both can be used simultaneously to ensure no models are skipped.

    Custom AI Metrics Mappings

    Optionally, in Custom AI Metrics Mappings, define the custom Snowflake Cortex AI model metrics that you want to integrate. You can do this by adding the mapping between the custom metric and Collibra attribute. The attribute list contains all attribute types that are assigned to the Snowflake Cortex AI Model asset type.

    After you synchronize the capability, the specified custom Snowflake Cortex AI Model metrics are mapped to the corresponding attributes.

    Important 

    If you use this feature, add any custom attributes/characteristics, as needed, to the asset type assignment.

    To add a custom AI metric mapping:

    1. Click Add Custom AI Metrics Mappings.
    2. In Metric, select the custom metric from the list of available Snowflake Cortex AI metrics.
    3. In Attribute, select the attribute in which you want to see the value.
      Make sure to select an attribute that is included in the Snowflake Cortex AI Model asset type assignment.
    Asset deletion modeOptionally, expand Advanced settings and set the Asset deletion mode
    1. Soft: Assets are archived and can be restored if the model reappears. This is the recommended mode.
    2. Hard: Assets are permanently deleted and cannot be recovered.
  7. Click Save.
  8. In the Synchronization Schedule section, click Add schedule.
  9. Enter the required information and click Save:
    FieldDescription
    RepeatThe interval when you want to synchronize automatically. The possible values are: Daily, Weekly, Monthly, and Cron expression.
    Cron

    The Quartz Cron expression that determines when the synchronization takes place.

    This field is only visible if you select Cron expression in the Repeat field.

    Every

    The day on which you want to synchronize, for example, Sunday.

    This field is only visible if you select Weekly in the Repeat field.

    Every first

    The day of the month on which you want to synchronize, for example, Tuesday.

    This field is only visible if you select Monthly in the Repeat field.

    At

    The time at which you want to synchronize automatically, for example, 14:00.

    • You can only schedule on the hour. For example, you can add a synchronization schedule at 8:00, but not at 8:45.
    • This field is only visible if you select Daily, Weekly, or Monthly in the Repeat field.
    Time zoneThe time zone for the schedule.

What's next

The synchronization job synchronizes the Snowflake Cortex AI data.
After the synchronization: