yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-12 19:48:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.6.x-SNAPSHOT/connectors/dashboard/sigma/index.md
Suman Maharana 37b6dc8290
Add Sigma Dashboard Connector (#17855) 
* Add Sigma Dashboard Connector

* changed to id instead of name in dashboard entity

* Address Comments

* addressed comments

* Added Docs

* yaml file changes

* fix ui changes
2024-09-26 16:29:35 +05:30

3.3 KiB
Raw Blame History

title slug
Sigma /connectors/dashboard/sigma

{% connectorDetailsHeader name="Sigma" stage="PROD" platform="OpenMetadata" availableFeatures=["Dashboards", "Charts", "Lineage", "Owners"] unavailableFeatures=["Tags", "Datamodels", "Projects"] / %}

In this section, we provide guides and references to use the Sigma connector.

Configure and schedule Sigma metadata and profiler workflows from the OpenMetadata UI:

{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/sigma/yaml"} /%}

Requirements

OpenMetadata relies on Sigma's REST API. To know more you can read the Sigma API Get Started docs. To generate API client credentials, you must be assigned the Admin account type.

Metadata Ingestion

{% partial file="/v1.6/connectors/metadata-ingestion-ui.md" variables={ connector: "Sigma", selectServicePath: "/images/v1.6/connectors/sigma/select-service.png", addNewServicePath: "/images/v1.6/connectors/sigma/add-new-service.png", serviceConnectionPath: "/images/v1.6/connectors/sigma/service-connection.png", } /%}

{% stepsContainer %} {% extraContent parentTagName="stepsContainer" %}

Connection Details

hostPort: Host and Port Sigma REST API. The hostPort parameter specifies the host and port of the Sigma's API request URL. This should be specified as a string in the format https://aws-api.sigmacomputing.com. Sigma's API request URL varies according to the sigma cloud. you can determine your API url by following the docs here

clientId: Client Id for Sigma REST API. Get the Client Id and client Secret by following below steps:

  • Navigate to your Sigma homepage.
  • Click on Administration in the lower left corner.
  • Click on Developer Access on the left side.
  • To generate a new Client Id and client Secret, On upper left corner click Create New.
  • Enter the required details asked and click Create.
  • Copy the generated access token and password.

For detailed information visit here.

clientSecret: Client Secret for Sigma REST API. Copy the access token password from the step above where a new token is generated.

For detailed information visit here.

apiVersion: Sigma REST API Version. Version of the Sigma REST API by default v2.

To get to know the Sigma REST API Version visit here and look into the Token URL section.

{% /extraContent %}

{% partial file="/v1.6/connectors/test-connection.md" /%}

{% partial file="/v1.6/connectors/dashboard/configure-ingestion.md" /%}

{% partial file="/v1.6/connectors/ingestion-schedule-and-deploy.md" /%}

{% /stepsContainer %}

{% partial file="/v1.6/connectors/troubleshooting.md" /%}