Skip to main content

Creating Connections

Learn how to create and configure connections to your data sources and external systems. Connectors provide the access layer between Autonify and your ecosystem, including databases, applications, CRMs, and ERPs.

VIDEO TUTORIAL⏱️ 3 min

📹 Step-by-Step Connection Setup

Follow this tutorial to create connections to your databases and applications, configure connection parameters, and test connectivity.

Understanding Connectors​

Connectors are the foundation for integrating Autonify with your data ecosystem:

  • Database Connectors: Connect to relational databases and data warehouses
  • Application Connectors: Integrate with CRMs, ERPs, and other business applications
  • Out-of-the-box Support: Many connectors work immediately without configuration
  • Custom Connectors: Some connectors require Autonify support for setup

Creating a New Connection​

Step 1: Access Connectors​

  1. Navigate to the Connectors section in the portal
  2. View existing connectors if any are already configured
  3. Click the Add Connector button to start

Connectors Page

Step 2: Select Connection Type​

  1. Browse available connector types in the dialog
  2. Use the search bar to filter connectors
  3. Choose your desired connection type (e.g., PostgreSQL, MySQL, SQL Server)
  4. Click Next to proceed

Connector Type Selection

Step 3: Configure Basic Information​

Provide the following details:

Connection Name​

  • Enter a descriptive name for your connection
  • Example: "BankFS" for a banking financial services database

Description (Optional)​

  • Add context about the connection's purpose
  • Helps team members understand the data source

Basic Information Form

Step 4: Configure Connection Parameters​

The configuration requirements vary by connector type and are defined by the connector's schema. The form dynamically adjusts based on the selected connector.

Common Fields (PostgreSQL example)​

  • Host: Database server address
  • Port: Database port (default 5432 for PostgreSQL)
  • Database: Database name
  • Username: Authentication username
  • Password: Authentication password
  • SSL Mode: Connection security (disable, prefer, require)

Note: Each connector type has its own specific configuration schema with required and optional fields.

Connection Configuration

Step 5: Additional Parameters​

For advanced configurations:

  1. Click Add Additional Connection Parameters
  2. Enter parameter names and values
  3. These extend the connection string for specific requirements

Additional Parameters

Step 6: Test Connection​

Before saving:

  1. Click Test Connection button
  2. Wait for the connection test to complete
  3. Look for the green tick indicating success
  4. Review any error messages if the test fails

Test Connection Result

Step 7: Create Connection​

Once the test passes:

  1. Click Create Connector button (or Update Connection if editing)
  2. The connector appears in your connectors list
  3. Connection is now ready for use

Managing Existing Connections​

Testing Connections​

  • Click the Test button on any connector card
  • Verify connectivity at any time
  • Useful for troubleshooting connection issues

Editing Connections​

  1. Click the Edit button on a connector card
  2. Update configuration values as needed in the dialog
  3. Test the connection before saving
  4. Click Update Connection to apply changes

Deleting Connections​

  1. Click the Delete button on a connector
  2. Confirm the deletion in the dialog
  3. Warning: Deleting a connector removes all associated data sources

Connector Management Actions

Connection Parameters by Type​

PostgreSQL​

  • Port: 5432 (default)
  • SSL Options: disable, prefer, require
  • Additional: Schema restrictions, connection pooling

MySQL​

  • Port: 3306 (default)
  • SSL Options: Available
  • Additional: Character encoding, timezone settings

SQL Server​

  • Port: 1433 (default)
  • Authentication: SQL or Windows
  • Additional: Instance names, encryption settings

Oracle​

  • Port: 1521 (default)
  • Connection String: TNS or Direct
  • Additional: Service names, SID configuration

Best Practices​

Naming Conventions​

  • Use clear, descriptive names
  • Include environment indicators (Dev, Staging, Prod)
  • Follow organisational naming standards

Security Considerations​

  • Use dedicated read-only accounts when possible
  • Enable SSL/TLS for production connections
  • Store credentials securely
  • Regularly rotate passwords

Performance Optimisation​

  • Limit database scanning scope when appropriate
  • Use connection pooling for high-volume access
  • Configure appropriate timeout values
  • Monitor connection performance

Testing Strategy​

  • Always test connections before saving
  • Retest after configuration changes
  • Verify connectivity after network changes
  • Document connection requirements

Troubleshooting Common Issues​

Connection Failed​

  • Verify network connectivity to database server
  • Check firewall rules and port access
  • Confirm credentials are correct
  • Ensure database user has required permissions

SSL/TLS Errors​

  • Verify SSL mode matches server configuration
  • Check certificate validity
  • Ensure proper SSL parameters in additional settings

Timeout Issues​

  • Increase connection timeout values
  • Check network latency
  • Verify database server performance
  • Consider connection pooling

Permission Denied​

  • Confirm user has SELECT permissions
  • Check schema and table access rights
  • Verify database exists and is accessible
  • Review role assignments

Next Steps​

Once your connection is created:

  1. Create a data source using this connector
  2. Configure scanning to discover your data
  3. Set up scheduled scans for regular updates
  4. View your data catalog