Skip to main content

Connections

Guides

This guide is the authoritative reference for connections in DataLug. It covers the new-connection wizard, environment-specific overrides, the saved actions library, and the connector catalog. For provider-side OAuth and service-principal setup (Google Drive, OneDrive, Azure Blob, SharePoint, Dropbox, S3) follow the File hub setup guide.

The Connections page has two main tabs:

  • Connections: your configured connections.
  • Connectors: the connector catalog (browse available systems).

Workspace activation behavior:

  • ?intent=create opens the New Connection wizard automatically.
  • ?projectId=... applies project context immediately and shows a project-context banner.
  • ?focusConnectionId=... highlights the requested connection row.

Navigation Links (Project + Environments)​

In the Connections list:

  • If a connection is Project scope, the Project name is a hyperlink to open that project.
  • Environment names (from environment settings) are hyperlinks to open the Environments page filtered to that environment.

Create a Connection (Wizard)​

  1. Go to Connections.
  2. Click New Connection.
  3. Wizard Page 1:
    • Scope: Project or Global
    • System: choose the connector (Salesforce, SQL Server, MySQL, PostgreSQL, Oracle, SFTP/FTP, SMTP, Generic API, etc.)
    • Project: only required for Project-scoped connections
    • Connection Name:
      • The UI shows a prefix hint based on the system, such as (Salesforce) -
      • Enter the suffix (for example, DEV, Sandbox, Prod, Partner DB)
  4. Click Next.
  5. Wizard Page 2:
    • The system-specific connection modal is rendered inside the wizard shell.
    • Configure:
      • Basic connection fields
      • Security settings (SSL/TLS, auth, etc.)
      • Advanced settings (timeouts, pool sizes, etc.)
    • Add Environment Settings (recommended):
      • Create per-environment overrides so DEV/QA/PROD use different hosts/credentials.
    • Use Test Connection to verify the environment config.
  6. Click Save.

Notes:

  • If you click Add Environment, the environment config should copy all relevant fields (Basic/Security/Advanced) into that environment entry so tests and deployments are consistent.
  • Connection testing may require a runtime mapped to the selected environment, depending on the connector and environment setup.

File Hub Setup Guide​

For canonical provider-side setup instructions for DataLug file hubs, use:

Use that guide when you need to prepare:

  • Google Drive and Google Sheets OAuth client apps
  • OneDrive OAuth client apps
  • SharePoint Files OAuth client apps and site/library setup
  • Azure Blob Storage SAS or service principal access
  • shipped Dropbox app setup plus shipped AWS S3 bucket access setup

The sections below are short DataLug-specific summaries only.

Google Client App Setup (Google Drive and Google Sheets)​

Use the canonical file-hub setup guide for the full provider walkthrough:

For Google Drive and Google Sheets, DataLug expects:

  • Client ID
  • Client Secret
  • Redirect URI

Important reminders:

  • One Google OAuth web application can support both connectors.
  • DataLug uses a backend-owned OAuth callback.
  • The Google redirect URI must exactly match the callback shown in the DataLug modal.
  • After save, the client secret is write-only and is not returned to the browser.

Microsoft Client App Setup (OneDrive)​

Use the canonical file-hub setup guide for the full provider walkthrough:

For OneDrive, DataLug expects:

  • Client ID
  • Client Secret
  • Redirect URI
  • Tenant ID

Important reminders:

  • The Microsoft Entra redirect URI must be registered as Web, not Single-page application (SPA).
  • DataLug uses a backend-owned OAuth callback and server-side code redemption.
  • Use common only when the app registration supports that sign-in model.
  • After save, the client secret is write-only and is not returned to the browser.

Azure Blob Storage Access Setup​

Use the canonical file-hub setup guide for the full provider walkthrough:

For Azure Blob Storage, DataLug supports these auth paths:

  • SAS Token
  • Service Principal

Important reminders:

  • Required shared fields are Storage Account, Container, and optional Default Path Prefix.
  • Azure Blob supports the shared file-family actions: List Files, Get File, Upload File(s), Write Rows To File(s), Move/Rename, Delete, and Create Folder.
  • Blob paths are treated as virtual directories under the selected container.
  • Create Folder uses a hidden .datalug-folder marker blob for folder-style compatibility.
  • After save, SAS tokens and client secrets are write-only and are not returned to the browser.

Salesforce Connected App Setup​

Use this when you want Salesforce-hosted sign-in in the connector modal instead of manually entering a password or refresh token.

DataLug now supports these Salesforce auth modes:

  • OAuth Username/Password
  • OAuth Refresh Token
  • JWT Bearer
  • Hosted Salesforce Sign-In

For Hosted Salesforce Sign-In, set up a Salesforce Connected App and capture:

  • Login URL
  • Client ID
  • Client Secret
  • Redirect URI

Provider-side setup:

  1. In Salesforce Setup, open App Manager.
  2. Create a new Connected App.
  3. Enable OAuth Settings.
  4. Add the exact Redirect URI shown in the DataLug Salesforce modal.
  5. Enable scopes that allow API access and refresh-token issuance for the connector workflow.
  6. Save the app and wait for the Connected App to finish provisioning.
  7. Copy the generated consumer key as the Client ID.
  8. Copy the consumer secret as the Client Secret.
  9. Choose the correct Login URL for the org you want users to sign in against:
    • production: https://login.salesforce.com
    • sandbox: https://test.salesforce.com
    • My Domain: your org-specific login URL

Important reminders:

  • The popup uses Salesforce-hosted login. DataLug does not collect the Salesforce username/password in the popup flow.
  • The redirect URI must exactly match what DataLug shows in the modal.
  • After save, the client secret and OAuth tokens are stored securely on the server and are not returned to the browser in plaintext.
  • Existing Salesforce auth modes continue to work; this popup flow is additive.

Manage Saved Actions for a Connection​

From the Connections list:

  • Use the "Actions" link/icon to view saved actions for that connection.
  • Saved actions are filtered to the active project context where applicable (project-scoped actions vs global).

Export/Import Connections (Encrypted)​

If you need to move a connection configuration between environments (for example local -> dev), DataLug supports exporting a connection as an encrypted file and importing it elsewhere.

Requirements:

  • You must be logged in.
  • The backend must be configured with DLR_CONNECTION_TRANSFER_SECRET.
    • Important: any instances/environments that exchange exports must use the same secret value.

Export:

  1. Go to Connections.
  2. Find the connection row.
  3. Click Download / Export.
  4. Save the exported file.

Import:

  1. Go to Connections.
  2. Click Import.
  3. Upload the exported file.
  4. Review the imported connection name/scope and save.

Notes:

  • Sensitive environment fields (passwords/tokens) are encrypted in the export.
  • If the destination instance has a different secret, import will fail (cannot decrypt).

Connector Catalog​

Use the Connectors tab to:

  • browse available connectors
  • see connector status (active/inactive)
  • open the New Connection wizard for the selected connector