Skip to main content
Estimated Time: 5-10 minutesLearn how to configure app connections and credentials to enable seamless integration between 5X capabilities and your data warehouse.Note for 5X managed warehouse users: If you provisioned your workspace with a 5X managed warehouse, default app connections and credentials are automatically configured for all capabilities. You can skip this step and return later if you need to modify, delete, or create additional app connections.

​
Understanding app connections and credentials

App connections and credentials are fundamental concepts that enable the 5X Platform’s capabilities to securely connect and interact with your data warehouse.

​
What are app connections?

App connections define how each 5X capability (ingestion, modeling, orchestration, BI, and metrics layer) connects to your data warehouse. Think of them as capability-specific connection profiles that contain all the technical details needed for that particular workload to access your warehouse. Each app connection includes:
  • Service account details - Username and authentication method
  • Database configuration - Target database, schema, and warehouse
  • Role and permissions - What the connection can access and modify
  • Connection parameters - Timeout settings, SSL configuration, etc.
For example, your ingestion capability needs an app connection with write permissions to load raw data, while your BI capability needs a separate app connection with read-only access to query transformed data.

​
What are credentials?

Credentials are your personal authentication details for accessing the data warehouse through the 5X IDE. Unlike app connections which are shared across your workspace for automated processes, credentials are individual to you and enable interactive development work. Your credentials allow you to:
  • Execute SQL queries in the 5X IDE
  • Run and test dbt models during development
  • Browse database schemas and tables
  • Perform ad-hoc data analysis

​
Do you need to configure app connections?

App connections are essential for all 5X workspaces, but your setup approach depends on how you provisioned your workspace:

​
If you’re using a 5X managed warehouse

You can start with defaults and customize later. When you provision a workspace with a 5X managed warehouse, the platform automatically creates default app connections for all core capabilities based on recommended best practices. These defaults allow you to start using 5X immediately. However, you’ll likely want to re-configure/modify app connections as you grow:
  • Connect to different databases or schemas for specific projects or environments
  • Change roles or permissions to match your organization’s security requirements
  • Create multiple connections when working with multiple databases or data sources
  • Set up environment-specific connections for development, staging, and production workflows
  • Customize connection parameters like warehouses, or authentication methods
For getting started: You can proceed with the default setup and return to configure additional app connections as your needs evolve.

​
If you’re using an existing warehouse

You must configure all app connections manually. When you connect an existing Snowflake, BigQuery, AWS Redshift, or PostgreSQL warehouse, no default app connections are created. This makes app connection configuration critical for basic platform functionality. What you need to set up:
  • Before using any 5X capability, you need to configure its corresponding app connection
  • Each capability requires its own connection with appropriate permissions and settings
  • Without proper app connections, capabilities like data ingestion, dbt modeling, and BI dashboards won’t function
What this means practically:
  • Want to ingest data? You need an app connection of type “Ingestion”
  • Want to run dbt models or orchestrate workflows? You need an app connection of type “Job”
  • Want to create dashboards? You need an app connection of type “Business Intelligence”
  • Want to use metrics? You need an app connection of type “Metrics Store”
  • Want to use Streamlit-based data apps? You need an app connection of type “Data & AI Apps”
This is why understanding app connections is critical when using an existing warehouse: they’re the foundation that enables all 5X platform functionality.

​
Creating app connections

​
1. Access app connections

  1. Navigate to settings
    • From your workspace, click “Settings” in the left sidebar
    • Select “App connections” from the settings menu
    Settings page with app connections highlighted in sidebar
  2. Create new connection
    • Click ”+ New connection”
    • You’ll see the connection configuration form

​
2. Configure connection details

The configuration fields vary depending on your warehouse type and the capability you’re setting up. Here’s how to configure each field:
Connection types and fields:For all Snowflake connections, you’ll configure:
  1. Type: Select the capability type
    • Ingestion - For data ingestion pipelines
    • Job - For dbt modeling and orchestration workflows
    • Business Intelligence - For BI dashboards and analytics
    • Metrics Store - For metrics layer operations
    • Data & AI Apps - For data and AI applications
  2. Connection name: Use descriptive names like:
    • prod_ingestion
    • dev_modeling
    • bi_dashboard
    • metrics_store
    • data_apps
  3. Snowflake account: Your Snowflake account URL
    • Format: https://[account].snowflakecomputing.com
  4. Default role: The role this connection will use
    • Examples: INGESTION_ROLE, DBT_ROLE, BI_ROLE
  5. Default database: Target database name
    • Examples: ANALYTICS_DB, PROD_DB, DEV_DB
  6. Default schema: Default schema for operations
    • Examples: RAW_DATA, TRANSFORMED, MARTS
  7. Default warehouse: Compute warehouse to use
    • Examples: INGESTION_WH, TRANSFORM_WH, BI_WH
Authentication options:
  • Key pair authentication: Service account username with private key (recommended for production)
Pre-requisites and setup: For detailed setup instructions including service account creation, role configuration, and permissions, refer to the “Pre-requisites” section on the app connection setup page as shown in the screenshot.
Snowflake Business Intelligence app connection configuration showing all required fields
Connection types and fields:For all BigQuery connections, you’ll configure:
  1. Type: Select the capability type
    • Ingestion - For data ingestion pipelines
    • Job - For dbt modeling and orchestration workflows
    • Business Intelligence - For BI dashboards and analytics
    • Metrics Store - For metrics layer operations
    • Data & AI Apps - For data and AI applications
  2. Connection name: Use descriptive names like:
    • prod_ingestion
    • dev_jobs
    • bi_analytics
    • data_apps
  3. Upload file: Service account JSON key file
    • Download from Google Cloud Console > IAM & Admin > Service Accounts
    • Must have appropriate BigQuery permissions
  4. Project ID: Your Google Cloud project identifier
  5. Dataset location: Geographic location of your datasets
    • Examples: US, EU, us-central1
For Job connections (dbt/orchestration):
  • Dataset name: Target dataset for dbt models
  • dbt version: Select your preferred dbt version
Pre-requisites and setup: For detailed setup instructions including service account creation, role assignment, and JSON file generation, refer to the “Pre-requisites” section on the app connection setup page as shown in the screenshots.
BigQuery ingestion app connection configuration showing service account upload and project settings
Key considerations for all warehouse types:
  • Use service accounts instead of personal credentials for app connections
  • Follow least privilege principle - grant only necessary permissions for each capability
  • Use descriptive naming to easily identify connection purposes
  • Test connections before saving to ensure proper configuration

​
3. Connect and create app connection

  1. Click Connect
    • After configuring all required fields, click the “Connect” button
    • This will first test your connection configuration automatically
    • If the test is successful, the app connection will be created and saved
  2. Connection validation
    • The system verifies authentication credentials and database access
    • Checks that the specified role has necessary permissions
    • Ensures all connection parameters are valid
  3. Success confirmation
    • Once created successfully, the connection will appear in your app connections list
    • You can now use this connection for the selected capability

​
Managing user credentials

​
1. Access credentials settings

  1. Navigate to credentials
    • Go to Settings > Credentials
    • Click ”+ Add credential” or edit existing credentials
    Credentials page showing Snowflake authentication options

​
2. Configure personal credentials

Based on your warehouse type, configure your personal access:
Required fields:
  1. Snowflake Account: Your Snowflake account URL
    • Format: https://nnb42337.us-east-1.snowflakecomputing.com
  2. Default Role: Your personal role for queries
    • Examples: ANALYST, DEVELOPER, SYSADMIN
  3. Default Warehouse: Warehouse for your interactive queries
    • Examples: COMPUTE_WH, DEV_WH, ANALYST_WH
  4. Authentication Type: Choose your authentication method
    • Username & Password: Standard authentication with your Snowflake credentials
    • Key Pair: More secure option using private key authentication
dbt Integration (optional):If you plan to use dbt modeling:
  1. Enable dbt toggle: Turn on the “dbt” toggle in credentials
    • This enables dbt operations in the 5X IDE
  2. dbt version: Select your preferred dbt version
    • Available versions: 1.6.18, 1.7.19, 1.8.9, 1.9.10
  3. Database: Target database for dbt models
  4. Schema: Schema for dbt transformations
  5. (optional field) Target name: Environment identifier for dbt
    • Examples: dev, prod, staging
Required fields:
  1. Authentication: Sign in with Google
    • Click “Sign in with Google” to authenticate with your Google account
    • Select the Google account that has access to your BigQuery project
    • Grant necessary permissions for 5X to access BigQuery on your behalf
  2. Project ID: Your Google Cloud project identifier
    • Example: cmp-princestackprovision-czwf
dbt Integration (optional):If you plan to use dbt modeling:
  1. Enable dbt toggle: Turn on the “dbt” toggle in credentials
    • This enables dbt operations in the 5X IDE
  2. dbt version: Select your preferred dbt version
    • Available versions: 1.6.18, 1.7.19, 1.8.9, 1.9.10
  3. Database: Target database for dbt models
  4. Schema: Schema for dbt transformations
  5. (optional field) Target name: Environment identifier for dbt
    • Examples: dev, prod, staging

​
Best practices

​
Naming conventions

App connections

Recommended naming:
  • [Environment]_[Capability]_Connection
  • Examples:
    • Prod_Ingestion_Connection
    • Dev_Modeling_Connection
    • Staging_BI_Connection

Service accounts

Recommended naming:
  • [CAPABILITY]_[ENVIRONMENT]_USER
  • Examples:
    • INGESTION_PROD_USER
    • DBT_DEV_USER
    • BI_STAGING_USER

​
Security guidelines

Security best practices:
  • Use least privilege principle - Grant only necessary permissions for each capability
  • Separate environments - Use different connections for dev/staging/prod
  • Rotate credentials regularly - Implement credential rotation policies
  • Monitor connection usage - Review access logs and connection patterns

​
Troubleshooting common issues

Common causes:
  • Incorrect connection details
  • Invalid credentials or expired passwords
  • Network connectivity issues
  • Insufficient permissions for the specified role
Solutions:
  • Verify the configured credentials
  • Check role permissions in your warehouse
  • Ensure network access and correct firewall settings
  • Test credentials directly in your warehouse console
Common causes:
  • Role lacks necessary database permissions
  • Warehouse access restrictions
  • Schema or table-level permission issues
Solutions:
  • Review and grant necessary permissions to the role
  • Check warehouse access policies
  • Verify schema and table permissions
  • Contact your database administrator for access issues
Common causes:
  • Incorrect private key format
  • Missing or incorrect passphrase
  • Expired or revoked credentials
Solutions:
  • Verify private key format (PEM format required)
  • Check passphrase accuracy
  • Regenerate keys if expired
  • Ensure proper key pair setup in warehouse

​
What’s next?

With your app connections and credentials configured, you’re ready to start using the 5X Platform’s capabilities.

Continue to Step 5

Next: Ingest your dataConfigure your first data ingestion pipeline using the app connections you just set up.

Back to overview

Return to quickstart guide overview

Previous step

Steps 1-3: Account setup and workspace provisioning