Synchronize Sigma

Synchronizing Sigma imports and updates metadata from your Sigma environment into Collibra Data Catalog. This operation uses the Sigma capability (configured in Edge or Collibra Cloud site) to fetch metadata for workspaces, dashboards, datasets, data elements, and data connections, and automatically create or update them as assets in the Collibra Catalog.

You can also choose to create technical lineage (in preview) during synchronization.

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

Before you begin

Requirements and permissions

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. Locate the Sigma connection that you used when you added the Sigma capability and click the link in the Capabilities column.
    The synchronization configuration page opens.
  5. In the Synchronization Configuration section, click the Edit icon.
  6. Enter the required information.
    FieldDescriptionRequired
    Domain

    Select the domain in which Sigma assets should be created.

    Important Choose a domain of type Technology Asset to ensure compatibility.

    		Yes
    Workspace Filter

    Add one or more Sigma workspaces to restrict synchronization to specific workspaces. If left blank, all available workspaces are synchronized.

    Filter by workspace ID or name when entering filters manually.

    To enable the dropdown manually, run the curl request below. Alternatively, you can reach out to Collibra Support to trigger it after installing the capability for the first time.

    Copy
    curl --location '<host>/graphql' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic <Key>' \
    --header 'Cookie: JSESSIONID=<JsessionId>' \
    --data '{
        "query": "mutation EnhancedSchemaRefresh {\n  refreshEnhancedSchemas(input: {capabilityId: \"<capability id>\"}) {\n    enhancedSchema {\n      uiSchema\n      dataSchema\n      message\n      status\n    }\n  }\n}",
        "variables": {}
    }'
    		Yes
    FieldActionRequired
    Source ID

    Enter the identifier of the Sigma source to scope lineage extraction.


    		Yes
    Domain

    Select the domain where Sigma lineage assets will be created.

    		Yes
    Workspaces

    Enter one or more Sigma workspaces IDs to restrict lineage ingestion.

    Leave empty to synchronize lineage for all available workspaces.

    		No
  7. Click Save.
  8. 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. Locate the Sigma connection that you used when you added the Sigma capability and click the link in the Capabilities column.
    The synchronization configuration page opens.
  5. In the Synchronization Configuration section, click the Edit icon.
  6. Enter the required information.
  7. Field Description Required
    Domain

    Select the domain in which Sigma assets should be created.

    Important Choose a domain of type Technology Asset to ensure compatibility.

    		 Yes
    Workspace Filter

    Add one or more Sigma workspaces to restrict synchronization to specific workspaces. If left blank, all available workspaces are synchronized.

    Filter by workspace ID or name when entering filters manually.

    To enable the dropdown manually, run the curl request below. Alternatively, you can reach out to Collibra Support to trigger it after installing the capability for the first time.

    Copy 
    curl --location '<host>/graphql' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic <Key>' \
    --header 'Cookie: JSESSIONID=<JsessionId>' \
    --data '{
        "query": "mutation EnhancedSchemaRefresh {\n  refreshEnhancedSchemas(input: {capabilityId: \"<capability id>\"}) {\n    enhancedSchema {\n      uiSchema\n      dataSchema\n      message\n      status\n    }\n  }\n}",
        "variables": {}
    }'
    		 Yes
    Field Action Required
    Source ID

    Enter the identifier of the Sigma source to scope lineage extraction.


    		 Yes
    Domain

    Select the domain where Sigma lineage assets will be created.

    		 Yes
    Workspaces

    Enter one or more Sigma workspaces IDs to restrict lineage ingestion.

    Leave empty to synchronize lineage for all available workspaces.

    		 No
  8. Click Save.
  9. In the Synchronization Schedule section, click Add Schedule.
  10. Enter the information.
    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.
  11. Click Save

What's next

The synchronization job integrates the metadata.

After the synchronization:

  • You can view a summary of the results from the Activities list.
  • For metadata synchronization, the resulting assets get a relation to the System asset that you selected.