Skip to main content

About the Sigma collector

Important

The Sigma collector can be run run in the cloud or on-premise using Docker or Jar files.

Note

The latest version of the Collector is 2.248. To view the release notes for this version and all previous versions, please go here.

Use this collector to harvest metadata from Sigma. Users can then:

  • Obtain a clear visibility into your Sigma workbooks, files, datasets, and more, ensuring data protection, control, and traceability.

  • Business decision-makers can effortlessly visualize and integrate Sigma's KPIs and metrics with data from other sources, leading to informed decisions.

  • Data analysts will have improved data trust levels as metadata for Sigma workbooks and elements (for example, titles, descriptions, authors, last updated info) are now easily accessible within data.world, giving quick and deep insight.

  • Gain valuable insight into data quality and health via a Sigma Hoot.

An example of metadata from an Sigma workbook Report, including Lineage:

sigma_collector_sample.png

What is cataloged

The collector catalogs the following information.

Table 1.

Object

Information cataloged

Workspace

  • ID, Name, Created By, Created At, Updated By, Updated At

Workbook

  • ID, URL ID, Name, URL, Path, Badge, Permission, Tags,  Latest Version, Is Archived, Created By, Created At, Updated By, Updated At, List of Data Elements

Folder

  • ID, URL ID, Name, URL, Path, Badge, Permission, Is Archived, Created By, Created At, Updated By, Updated At

Dataset

  • ID, Name, URL, Is Archived, Created By, Created At, Updated By, Updated At

Connection

  • ID, Name, Type, Organization ID, Is Sample, Last Active At, Use OAuth, Is Archived, Created By, Created At, Updated By, Updated At

Tag

  • Name, Tag ID, Owner, Is Archived, Created By, Created At, Updated By, Updated At

Grant

  • ID, Organization ID, Team, Member, Permission, Created By, Created At, Updated By, Updated At

Member

  • ID, Organization ID, Member Type, First Name, Last Name, Email, Profile Image URL, Created By, Created At, Updated By, Updated At, Is Archived, Home Folder

Team

  • ID, Name, Description, Created By, Created At, Updated By, Updated At, Is Archived, Team Members

Data Element

  • ID, Name, Element Type, Element Visualization Type, Query, Query Error



Relationships between objects

By default, the harvested metadata includes catalog pages for the following resource types. Each catalog page has a relationship to the other related resource types. If the metadata presentation for this data source has been customized with the help of the data.world Solutions team, you may see other resource pages and relationships.

Table 2.

Resource page

Relationship

Workspace

  • Member who created Workspace

  • Folder contained within Workspace

  • Grant applied to workspace

  • Resource contained within Workspace

Workbook

  • Member who has access to Workbook

  • Member who created Workbook

  • Folder containing Workbook

  • Grant applied to Workbook

  • Workbook page contained in Workbook

  • Tag referenced by Workbook

  • Workspace containing Workbook

Data Element

  • Workbook page containing Data Element

  • Folder containing Data Element

  • Grant applied to Data Element

  • Workspace containing Data Element

Workbook page

  • Data Element contained within Workbook page

  • Workbook containing Workbook page

Folder

  • Member who has access to this Folder

  • Folder that contains this Folder

  • Resource that is contained within Folder

  • Grant that is applied to this Folder

  • Workspace that contains this Folder

Dataset

  • Member who has access to this Dataset

  • Member who created this Dataset

  • Folder that contains this Dataset

  • Grant applied to this Dataset

Connection

  • Grant that is applied to this Connection

  • Workspace that contains this Connection

  • Member who created this Connection

Tag

  • Workbook that uses Tag

  • Member who created Tag

Grant

  • Folder that contains this Grant

  • Resource that has this Grant

  • Member that has Grant

  • Member that created Grant

  • Team that has Grant

  • Workspace that contains Grant

Member

  • Folder that is used by Member

  • Grant that is provided to Member

  • Grant that is applied to Member

  • Workbook that is accessible to Member

  • Team that contains Member

  • Resource created by Member

  • Member created by this Member

Team

  • Grant provided to Team

  • Grant applied to Team

  • Member contained in Team

  • Member who created Team



Lineage for Sigma

The collector captures inter-system lineage within Sigma, connecting to tables, datasets, and other data elements in the workbook.

Table 3.

Object

Lineage available

Data Element

  • Table that Data Element sources its data from (Only available for Snowflake tables)

  • Dataset that a Data Element sources its data from



Authentication supported

  • The collector authenticates to Sigma using API tokens.

In this section: