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

# WhereScape Setup

> Preview: prerequisites, permissions, and connection steps for the WhereScape connector.

> [!WARNING]
>
> **Preview.** The WhereScape connection form isn't available in Prizm yet, so the field names below come from the product requirements and may change.

## Prerequisites

| Requirement | Notes |
| :- | :- |
| WhereScape RED metadata repository on Microsoft SQL Server | Other repository databases aren't supported |
| A database user for Prizm | Read-only. A dedicated service account is recommended |
| Network access from Prizm | Prizm connects directly to the repository's SQL Server host and port |

### Permissions

| Permission | Purpose |
| :- | :- |
| `db_datareader` role membership on the repository database | Read the repository tables |
| `SELECT` on the repository schema | Read access scoped to the schema you enter on the form |
| `SELECT` on `sys.schemas`, `sys.tables`, and `sys.objects` | Enumerate objects |

> [!NOTE]
>
> Validation returns an error that names any missing permission before the connection is saved. Prizm may also ask for `VIEW SERVER STATE` (granted on `master`); confirm the final list with your Prizm team before granting. Export Failed Rows reporting needs extra permissions (`CREATE VIEW` and `VIEW DEFINITION` on the schema) that standard cataloging and lineage don't.

## Connector Setup

**1. Open the connector wizard**

Navigate to **Source** and click the **+** icon next to the source list. Select **WhereScape** from the connector grid.

**2. Enter source details**

| Field | Description |
| :- | :- |
| Connection Name | A label for this connection |
| Description | Optional notes |
| Metadata Database Type | **Microsoft SQL Server** |
| Server | Host of the repository SQL Server |
| Port | SQL Server port (for example, `1433`) |
| Database | The repository database |
| Schema | The repository schema |
| Authentication Type | **Username and Password**. Windows Authentication isn't available yet |
| User and Password | The database user you created. Toggle **Use Vault** to retrieve them from a vault |

**3. Validate**

Click **Validate**. Prizm checks the connection and the permissions above before you can continue.

**4. Configure what to observe**

| Option | Description |
| :- | :- |
| Groups and Projects | Multi-select lists read from your repository. Only pipelines in the groups and projects you select are offered |
| Run History | How much run history to load on the first sync, in days or runs |
| Auto Mapping of Tags | Optional tag mapping |
| Domain, Product, Application | Optional governance assignments |
| Associated Assets | Optionally queue Structural or Business jobs automatically for the tables a job builds |
| Event Propagation | Raise alerts for **Job Alert Failure** and **Task Alert Failure** |

**5. Select pipelines and save**

Choose the jobs to monitor, then save. Assets appear in the catalog once the first scan completes.

## Next Steps

> **[What We Collect](/sources/wherescape/what-we-collect.md)**
>
> See what Prizm extracts from WhereScape.

> **[FAQ](/sources/wherescape/faq.md)**
>
> Common questions about the WhereScape connector.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.