OpenMetadata/openmetadata-docs/content/v1.6.x-SNAPSHOT/connectors/dashboard/sigma/yaml.md

title	slug
Run the Sigma Connector Externally	/connectors/dashboard/sigma/yaml

{% 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:

• Requirements
• Metadata Ingestion

{% partial file="/v1.6/connectors/external-ingestion-deployment.md" /%}

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

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Mode.

In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server.

The workflow is modeled around the following JSON Schema

1. Define the YAML Config

This is a sample config for Sigma:

{% codePreview %}

{% codeInfoContainer %}

Source Configuration - Service Connection

{% codeInfo srNumber=1 %}

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

{% /codeInfo %}

{% codeInfo srNumber=2 %}

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.

{% /codeInfo %}

{% codeInfo srNumber=3 %}

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.

{% /codeInfo %}

{% codeInfo srNumber=4 %}

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.

{% /codeInfo %}

{% partial file="/v1.6/connectors/yaml/dashboard/source-config-def.md" /%}

{% partial file="/v1.6/connectors/yaml/ingestion-sink-def.md" /%}

{% partial file="/v1.6/connectors/yaml/workflow-config-def.md" /%}

{% /codeInfoContainer %}

{% codeBlock fileName="filename.yaml" %}

source:
  type: sigma
  serviceName: local_sigma
  serviceConnection:
    config:
      type: Sigma

      hostPort: https://api.sigmacomputing.com

      clientId: client_id

      clientSecret: client_secret

      apiVersion: v2

{% partial file="/v1.6/connectors/yaml/dashboard/source-config.md" /%}

{% partial file="/v1.6/connectors/yaml/ingestion-sink.md" /%}

{% partial file="/v1.6/connectors/yaml/workflow-config.md" /%}

{% /codeBlock %}

{% /codePreview %}

{% partial file="/v1.6/connectors/yaml/ingestion-cli.md" /%}