> ## Documentation Index
> Fetch the complete documentation index at: https://docs.5x.co/llms.txt
> Use this file to discover all available pages before exploring further.

# BI integration

> Set up automatic synchronization of cube definitions with your BI tools for consistent metrics across all analytics platforms

**Focus:** Learn how to configure BI integration to automatically sync your Cube definitions with BI tools, ensuring consistent metrics across Tableau, Power BI, Looker, and other analytics platforms.

BI Integration allows you to automatically synchronize your Metrics Store cube definitions with your BI tools, ensuring that all your analytics platforms use the same metric definitions and business logic. This eliminates discrepancies and ensures consistency across your entire analytics stack.

## Overview

### **What is BI integration?**

BI Integration automatically syncs your Cube definitions (cubes, measures, dimensions) with connected BI tools, ensuring:

* **Consistent metrics** - Same definitions across all tools
* **Automatic updates** - Changes propagate automatically
* **Reduced manual work** - No need to manually update each tool
* **Single source of truth** - Metrics Store as the authoritative source

### **Supported BI tools**

* **Metabase** - Connect open-source BI platform

More tools coming soon.

## Accessing BI integration

### **Open BI integration drawer**

1. **Click "BI Integration" button** in Metrics Store header
2. **BI Integration drawer opens** showing:
   * List of connected BI tools
   * Sync status for each connection
   * Last sync time and status
   * Management actions

### **Prerequisites**

Before setting up BI integration:

* ✅ Active project selected
* ✅ Branch selected
* ✅ Server heartbeat status is **"RUNNING"**
* ✅ Cube definitions are deployed

## Creating BI connections

### **Add new connection**

1. **Click "New BI Connection"** in BI Integration drawer

2. **Select BI tool type** from available options

3. **Configure connection details:**
   * Connection name
   * Tool-specific settings
   * Authentication credentials
   * Connection parameters

4. **Save connection**
   * Connection is created and saved
   * Initial sync is triggered automatically
   * Connection appears in connections list

### **Connection configuration**

**Connection name**

* Descriptive name for identification
* Example: "Tableau Production", "Power BI Analytics"
* Helps identify connection purpose

**BI tool selection**

* Choose from supported BI tools
* Each tool has specific configuration requirements
* Tool-specific connectors handle synchronization

**Authentication**

* Provide credentials for BI tool access
* May include API keys, tokens, or OAuth
* Stored securely and encrypted

**Connection settings**

* Tool-specific configuration options
* Sync frequency settings
* Data source mappings
* Additional parameters as needed

## Managing connections

### **Connection list**

The BI Integration drawer displays:

* **Connection name** - Identifies each connection
* **BI tool type** - Shows which tool is connected
* **Sync status** - Current sync status indicator
* **Last sync time** - When last sync occurred
* **Actions** - Sync, edit, delete options

### **Sync status indicators**

**SUCCESS** 🟢

* Last sync completed successfully
* Connection is active and working
* Data is up-to-date

**FAILED** 🔴

* Last sync encountered errors
* Connection may need attention
* Review error messages for details

**PENDING** 🟡

* Sync is currently in progress
* Wait for completion
* Status will update when done

**NEVER\_SYNCED** ⚪

* Connection has never been synced
* Initial sync may be needed
* Set up connection and sync

### **Connection actions**

**Sync now**

* Manually trigger sync for specific connection
* Useful after schema changes
* Updates BI tool with latest definitions

**Sync all**

* Sync all connections at once
* Convenient for bulk updates
* Useful after major schema changes

**Edit connection**

* Update connection settings
* Modify authentication credentials
* Change configuration parameters

**Delete connection**

* Remove connection from Metrics Store
* Requires confirmation
* Cannot be undone

## Sync operations

### **Individual sync**

Sync a specific BI connection:

1. **Locate connection** in connections list
2. **Click "Sync now"** button for that connection
3. **Wait for sync to complete**
4. **Status updates** to show result (SUCCESS or FAILED)

**When to use:**

* After making changes to specific cubes
* Testing connection configuration
* Troubleshooting connection issues
* Updating single BI tool

### **Sync all**

Sync all BI connections at once:

1. **Click "Sync all" button** in drawer header
2. **All connections sync** simultaneously
3. **Status updates** for each connection
4. **Results displayed** when complete

**When to use:**

* After major schema changes
* After deploying new cube definitions
* Ensuring all tools are up-to-date
* Regular maintenance syncs

## Sync workflow

### **What gets synced**

When you sync a BI connection, the following are synchronized:

**Cube definitions**

* Cube schemas and structures
* Measure definitions and calculations
* Dimension definitions and types
* Time dimension configurations

**Metadata**

* Cube descriptions and documentation
* Measure labels and descriptions
* Dimension hierarchies
* Business logic definitions

**Updates**

* New cubes are added
* Modified cubes are updated
* Deleted cubes are removed
* Changes propagate automatically

### **Sync process**

1. **Initiate sync** - User triggers sync (manual or automatic)
2. **Connect to BI tool** - Establish connection using credentials
3. **Compare definitions** - Identify differences between Metrics Store and BI tool
4. **Apply changes** - Update BI tool with latest definitions
5. **Verify sync** - Confirm changes were applied successfully
6. **Update status** - Record sync status and timestamp

## Best practices

### **Connection management**

<CardGroup cols={2}>
  <Card title="Descriptive names" icon="tag">
    **Clear identification**

    Use descriptive connection names that indicate purpose, environment, or team.
  </Card>

  <Card title="Regular syncing" icon="sync">
    **Stay updated**

    Sync regularly, especially after schema changes, to keep all BI tools current.
  </Card>

  <Card title="Monitor status" icon="chart-line">
    **Track sync health**

    Monitor sync status regularly and address failures promptly to maintain consistency.
  </Card>

  <Card title="Test connections" icon="flask">
    **Validate setup**

    Test connections after setup and after major changes to ensure everything works correctly.
  </Card>
</CardGroup>

### **Sync strategy**

**After schema changes:**

* Sync immediately after deploying cube changes
* Test in one BI tool first, then sync others
* Verify sync status before considering complete

**Regular maintenance:**

* Schedule regular syncs (daily or weekly)
* Review sync status during maintenance windows
* Address any failed syncs promptly

**Environment separation:**

* Use separate connections for dev, staging, and production
* Sync dev environment more frequently for testing
* Be cautious with production syncs

### **Error handling**

* **Review error messages** - Understand why syncs fail
* **Check credentials** - Verify authentication is still valid
* **Test connectivity** - Ensure BI tool is accessible
* **Verify schema** - Check that cube definitions are valid
* **Contact support** - If issues persist after troubleshooting

## Troubleshooting

### **Common issues**

<AccordionGroup>
  <Accordion icon="exclamation-triangle" title="Sync failures">
    **Possible causes:**

    * Invalid or expired credentials
    * BI tool connectivity issues
    * Schema validation errors
    * Permission problems

    **Solutions:**

    * Verify credentials are correct and not expired
    * Check BI tool is accessible and running
    * Review schema for errors or inconsistencies
    * Verify connection has necessary permissions
    * Check error messages for specific issues
  </Accordion>

  <Accordion icon="clock" title="Slow sync performance">
    **Possible causes:**

    * Large number of cubes to sync
    * Network latency issues
    * BI tool performance problems
    * Complex schema definitions

    **Solutions:**

    * Be patient for large syncs
    * Check network connectivity
    * Verify BI tool performance
    * Consider syncing in smaller batches
  </Accordion>

  <Accordion icon="plug" title="Connection not working">
    **Possible causes:**

    * Connection not configured correctly
    * Authentication failures
    * BI tool not accessible
    * Incorrect connection parameters

    **Solutions:**

    * Review connection configuration
    * Verify credentials and authentication
    * Test BI tool accessibility
    * Check connection parameters match requirements
    * Try recreating connection
  </Accordion>
</AccordionGroup>

### **Sync status investigation**

**Check sync details:**

* Review last sync time
* Check sync status indicator
* Look for error messages
* Verify connection is active

**Test connection:**

* Try manual sync
* Verify BI tool is accessible
* Check credentials
* Review connection logs

**Verify schema:**

* Ensure cubes are properly defined
* Check for validation errors
* Verify schema is deployed
* Test queries in Cube Playground

***

<CardGroup cols={2}>
  <Card title="API Credentials" icon="key" href="/core-features/metric-store/api-credentials">
    **Connect applications**

    Learn how to use API credentials to connect custom applications.
  </Card>

  <Card title="Project Management" icon="folder" href="/core-features/metric-store/project-management">
    **Manage projects**

    Understand project and branch management for your cubes.
  </Card>
</CardGroup>