Prerequisites

Alation Cloud Service Applies to Alation Cloud Service instances of Alation

Customer Managed Applies to customer-managed instances of Alation

ACS Customers

If you are an Alation Cloud Service customer, ensure you have Alation Agent installed and running. The Agent is mandatory for this connector in ACS deployments.

On-premise / Self-managed Alation Customers

Check Alation Connector Manager (ACM) is installed and running. ACM is mandatory for OCF connectors. If you need to do so, install Alation Connector Manager using the steps in Install Alation Connector Manager.

Ensure the server where ACM is installed can reach your respective Sigma API URL over port 443.

Obtain Your Sigma API URL

You must determine which cloud provider your instance of Sigma is running on. This will determine which Sigma API URL to utilize in the Connector Configuration.

This information is listed in the Administration Portal under Account > General Settings > Site > Cloud.

Your Sigma Administrator can provide the Sigma cloud provider to the Alation Administrator.

Sigma OCF Connector File

After purchasing the Sigma connector you will receive the Sigma OCF Connector zip file. There is no license key required to activate this connector.

Sigma API Token Generation

A Sigma Administrator should perform the following steps to obtain the Sigma Client ID and Secret.

  1. Open your Sigma Admin Portal.

  2. On the left side of the page, click API & Embed Secrets to open the API & Embed Secrets page.

  3. On the API & Embed Secrets page, click the Create New button.

This will open the Create New API Token or Embed Secret modal. The API Token option will be selected by default.

  1. Enter a Name to identify the specific API Token. Example: Alation OCF API Token

  2. [optional] Enter a description.

  3. Under Owner, select the user account you want to associate with the token. Note: Account type permissions assigned to the selected Sigma user will automatically carry over into the Sigma API Token. The Sigma OCF Connector requires choosing a user with Admin privileges.

  4. Click Create.

  5. An API Key Secret modal will appear. Click Copy and immediately paste the secret in a secure location. The Client Secret is required when configuring the Sigma OCF Connector. Important: The secret cannot be retrieved once this modal is closed.

  6. Click Close.

  7. Your newly created Sigma API Token will be listed in the APIs & Embed Secrets panel. Hover over the token’s Client ID and click copy. The Client ID is required when configuring the Sigma OCF Connector.