Crawl Cube

||Connect docs via MCP

Extract metadata from your Cube deployment into Atlan to discover and catalog your semantic layer. After providing your Cube API key, you can crawl cubes, views, dimensions, measures, and segments, and emit Process lineage from the warehouse tables and columns each metric is built on. Review the order of operations and then complete the following steps.

Select source

To select Cube as your source:

1. In the top navigation, click Marketplace.
2. Search for Cube and select it.
3. Click Install.
4. Once installation completes, click Setup Workflow on the same tile.

If you navigated away before installation completed, go to New > New Workflow and select Cube to proceed.

Provide credentials

Provide the Cube tenant URL and API key you gathered when setting up Cube:

1. For Tenant URL, enter your Cube host without the https:// prefix and with no trailing slash or path—for example your-org.cubecloud.dev.
2. For Authentication, API Key is the default and only selection.
3. For API Key, paste the Cube API key you generated. The field is masked.
4. Click the Test Authentication button to confirm connectivity to Cube using these details.
5. Once successful, at the bottom of the screen, click Next.

Configure connection

To complete the Cube connection configuration:

1. For Connection Name, enter a name that uniquely identifies this Cube deployment within Atlan—for example cube-production or cube-prod. Atlan uses this to derive the Cube asset namespace; all cubes, views, and members from this run live under this connection.

2. (Optional) To change the users able to manage this connection, change the users or groups listed under Connection Admins.

   warning

   If you don't specify any user or group, nobody can manage the connection—not even admins.

3. At the bottom of the screen, click Next to proceed.

Configure crawler

Before running the crawler, choose what to extract and tune the extraction settings.

Select deployment and environment

For Deployment and Environment, select exactly one deployment and one environment to extract. When a deployment has only a single environment, Atlan selects it automatically—so choosing just the deployment is enough.

Tune extraction settings (optional)

You can override the defaults for any of these options:

• For Batch Size, set the number of cubes and views fetched and transformed per chunk. Smaller batches keep each data-plane request within Cube's timeout on large models; larger batches reduce round-trips. Defaults to 10; valid range is 1 to 50.
• For Security Context, optionally provide a JSON object that Atlan passes to Cube when minting the metadata-sync token—for example {"role":"analyst"}. Cube applies its security and row-level rules to this context, so the crawl sees only the model visible to that role or tenant. Leave it empty to crawl the full model the API key can access.

Run crawler

To run the Cube crawler, after completing the steps in this guide:

1. To check for connectivity, deployment, environment, and metadata-availability issues before running the crawler, click Preflight checks.
2. You can either:
   • To run the crawler once immediately, at the bottom of the screen, click the Run button.
   • To schedule the crawler to run hourly, daily, weekly, or monthly, at the bottom of the screen, click the Schedule Run button.

Once the crawler has completed running, your Cube assets are available under the Assets page and can be governed with terms, classifications, ownership, and custom metadata like any other Atlan asset! 🎉

What's next?

• Browse the Cube asset reference to understand which Cube properties land on which Atlan asset.
• If you hit a snag, see troubleshooting Cube connectivity.