Skip to main content

​
Overview

Creating a new connection establishes the link between Entegrata and your data source. This process involves selecting a data source type, providing authentication credentials, and configuring connection parameters.
Ensure you have the necessary credentials and network access before creating a connection. Test connectivity from your network if possible.

​
Access Requirements

To create connections, you must:
  • Be logged into the Entegrata Admin Portal
  • Have administrative privileges for your instance
  • Have valid credentials for the data source you’re connecting to
  • Ensure the data source is accessible from Entegrata’s network

​
Creating a New Connection

​
Step 1: Navigate to New Connection

  1. Go to Collectors in the main navigation
  2. Click the New Connection button in the top-right corner
New Connection button

​
Step 2: Select Data Source Type

Choose your data source from the available options.
Data source selection library

​
Available Data Sources

The full list of data connectors can be found at https://www.entegrata.com
Don’t see your data source? Contact your Entegrata Customer Experience Manager to inquire about custom connectors or upcoming integrations.

​
Step 3: Configure Connection Details

After selecting a data source, you’ll see a configuration form with fields specific to that source type.
image.png

​
Universal Fields

​
Nickname
string
required
A unique, descriptive name for this connectionBest practices:
  • Include environment: “Production SQL - Finance”
  • Include purpose: “DealCloud - Deal Data”
  • Avoid generic names like “Connection 1”
  • Must be unique across all your connections
If you enter a nickname that already exists, you’ll see an error and need to choose a different name.
​
Secret Expiration
date
When authentication credentials expire and need renewalWhy set this:
  • Receive notifications before credentials expire
  • Plan credential rotation in advance
  • Avoid unexpected connection failures
Secret expiration date picker

​
Database Connection Fields

For SQL databases (SQL Server, etc.):
​
Host
string
required
Server hostname or IP addressExamples:
  • sqlserver.company.com
  • 192.168.1.100
  • sql.azure.microsoft.com
​
Port
number
Database server port (defaults to standard port for each database type)Default ports:
  • SQL Server: 1433
​
Database
string
required
Name of the database to connect to
The specific database is required and is used to determine which resources can be discovered and collected. If you need to connect to multiple databases, you can create multiple connections.

​
Required SQL Permissions

To automatically throttle the collection of data based on the amount of data being collected, Entegrata needs the following permissions:
Grant VIEW DATABASE STATE
Grant VIEW SERVER STATE permissions for:
  • sys.dm_exec_sessions
  • sys.dm_exec_connections
  • sys.dm_exec_requests

​
API Connection Fields

For cloud platforms (DealCloud, Zoom, ADP, UKG, etc.):
​
API Endpoint
string
required
Base URL for the API (often pre-filled)
​
API Key / Token
string
required
Authentication token or API key for the platform
​
Organization ID
string
Your organization or tenant identifier (if applicable)
This is a non-exhaustive list of fields that may be required for each data source type.Your specific data source may require additional fields.Please contact Entegrata Support for assistance if you need help configuring your connection.

​
Step 4: Configure Authentication

Select the authentication method and provide credentials.

​
SQL Authentication

Standard username and password authentication:
SQL Authentication selected
​
Username
string
required
Database login username
​
Password
string
required
Database login password (encrypted and stored securely)

​
Windows Authentication

Domain-based authentication for on-premise SQL Server:
​
Domain
string
required
Windows domain name
​
Username
string
required
Domain username
​
Password
string
required
Domain password
Windows Authentication requires network connectivity to your domain controller.

​
Azure Entra ID (formerly Azure AD)

Modern authentication for Azure services:
​
Tenant ID
string
required
Azure Active Directory tenant identifier
​
Client ID
string
required
Application (client) ID from Azure AD app registration
​
Client Secret
string
required
Client secret from Azure AD app registration
Entra ID authentication requires an Azure AD app registration with appropriate API permissions or managed identity for self hosted customers.

​
Selecting Authentication Type

For data sources that support multiple authentication methods (like SQL Server), choose from the dropdown:
Authentication type selector
The form fields update based on your selection.

​
Step 5: Test and Save Connection

  1. Review all entered information for accuracy
  2. Click Connect to test the connection and save it
Connect button to save and test

​
What Happens Next

When you click Connect, Entegrata:
1

Validates Input

Checks that all required fields are filled correctly
2

Tests Connection

Attempts to connect to your data source using the provided credentials
3

Saves Configuration

Stores the connection details securely (credentials are encrypted)
4

Initiates Discovery

Begins discovering available resources (tables, views, endpoints)
5

Redirects to Resources

Takes you to the Resources page to view discovered resources

​
Connection Success

If the connection succeeds, you’ll see a success message and be redirected to the Resources page. The Resources page shows:
  • All discovered resources
  • Discovery status
  • Options to enable resources for collection
Discovery may take a few seconds to a few minutes depending on the size of your data source.

​
Connection Failure

If the connection fails, you’ll see an error message explaining why.

​
Common Error Messages

Cause: Incorrect username, password, or authentication credentialsResolution:
  • Verify credentials are correct
  • Check for typos or extra spaces
  • Ensure the account hasn’t been locked or disabled
  • Try logging in directly to the source system with the same credentials
Cause: Data source is not accessible from Entegrata’s networkResolution:
  • Verify the host/IP address is correct
  • Check firewall rules allow Entegrata’s IP addresses
  • Ensure the database or API service is running
  • Test connectivity from another location on the internet
Cause: User account lacks necessary permissionsResolution:
  • Grant READ permissions on required schemas/tables
  • For APIs, ensure the API key has appropriate scopes
  • Check database-level and schema-level permissions
  • Review the minimum permissions required for your data source type
Cause: Specified database name doesn’t exist or isn’t accessibleResolution:
  • Verify the database name is spelled correctly
  • Check that the database exists on the server
  • Ensure the user account has access to that database
Cause: Data source requires encrypted connectionResolution:
  • Enable SSL/TLS options if available in the connection form
  • Contact Entegrata Support if SSL options aren’t visible
  • Ensure your data source is configured to accept SSL connections
After 3 failed connection attempts, you may need to wait a few minutes before trying again to prevent account lockouts.

​
Post-Creation Steps

After successfully creating a connection:
1

Wait for Discovery

Allow automatic discovery to complete (usually under 5 minutes)
2

Review Discovered Resources

Browse the resources found in your data source
3

Enable Resources

Toggle on the specific tables, views, or endpoints you want to collectSee Enabling Resources for details
4

Configure Collection Settings

Set schedules and collection behavior for the connectionSee Collection Settings for details

​
Best Practices

Use Service Accounts

Create dedicated service accounts with minimum necessary permissions, not personal accounts

Document Credentials

Keep track of which credentials are used for each connection in your organization’s password manager

Set Expiration Dates

Always set secret expiration dates to ensure proactive credential rotation

Test Before Production

Create test connections first to verify configuration before production deployments

Use Read-Only Access

Grant only SELECT/READ permissions to Entegrata - write permissions are not needed

Monitor IP Allowlists

Keep your firewall rules updated if Entegrata’s IP addresses change

​
Security Considerations

​
Credential Storage

  • All credentials are encrypted at rest using industry-standard encryption
  • Passwords are never stored in plain text
  • Credentials are only used for connection and collection purposes

​
Network Security

  • Connections use encrypted protocols (TLS/SSL) when supported
  • Data in transit is encrypted
  • IP allowlisting is recommended for database connections

​
Permission Management

Only grant the minimum permissions required for data collection. Entegrata never needs write, delete, or schema modification permissions.
Recommended permissions:
  • Databases: SELECT on required schemas/tables
  • APIs: Read-only API scopes
  • File systems: Read access to required directories

​
Troubleshooting

If you encounter issues during connection creation, see the Troubleshooting Guide for detailed resolution steps.

​
Next Steps

Collection Settings

Configure schedules and collection behavior

Managing Resources

Enable and configure resources for collection

Discovery

Learn how discovery finds your data

Viewing Connections

Browse and search your connections