📋 Shared Instructions: shared-instructions.md - Cross-cutting concerns.
References:
Add Dataverse
Two paths: existing tables (skip to Step 5) or new tables (full workflow).
Workflow
- Plan → 2. Setup API Auth → 3. Review Existing Tables → 4. Create Tables → 5. Add Data Source → 6. Review Generated Files → 7. Build
Step 1: Plan
Check memory bank for project context. Ask the user:
- Which Dataverse table(s) do they need? (e.g.,
account, contact, cr123_customentity)
- Do the tables already exist in their environment, or do they need to create new ones?
If tables already exist: Skip to Step 5.
If creating new tables:
- Ask about the data they need and design an appropriate schema
- Use standard Dataverse tables when appropriate (
contact for people, account for organizations)
- Build a dependency graph -- see data-architecture-reference.md for tier classification
- Enter plan mode with
EnterPlanMode, present ER model with tables, columns, relationships, and creation order
- Get approval with
ExitPlanMode
Step 2: Setup API Auth (if creating tables)
See api-authentication-reference.md for full details.
az account show # Verify Azure CLI logged in
# Find your Dataverse environment URL:
# In make.powerapps.com → Settings → Developer resources → Web API endpoint
# It looks like: https://<org-name>.crm.dynamics.com/api/data/v9.2/
# Use the base URL: https://<org-name>.crm.dynamics.com
$api = Initialize-DataverseApi -EnvironmentUrl "https://<org>.crm.dynamics.com"
$headers = $api.Headers
$baseUrl = $api.BaseUrl
$publisherPrefix = $api.PublisherPrefix
Requires System Administrator or System Customizer security role.
Step 3: Review Existing Tables (if creating tables)
Always query existing tables first before creating:
$existingTables = Invoke-RestMethod -Uri "$baseUrl/EntityDefinitions?`$filter=IsCustomEntity eq true&`$select=SchemaName,LogicalName,DisplayName" -Headers $headers
See table-management-reference.md for Find-SimilarTables, Compare-TableSchemas, and Build-TableNameMapping functions.
Present findings to user with AskUserQuestion:
- Tables that can be reused (already exist with matching columns)
- Tables that need extension (exist but missing columns)
- Tables that must be created (no match found)
Step 4: Create Tables (if creating tables)
Get explicit confirmation before creating. Create in dependency order:
- Tier 0: Reference tables (no dependencies)
- Tier 1: Primary entities (reference Tier 0)
- Tier 2: Dependent tables (reference Tier 1)
Use safe functions from table-management-reference.md:
Step 5: Add Data Source
For each table:
pa app add data-source --connector dataverse --table <table-logical-name>
Can add multiple tables by running the command for each one.
Step 6: Review Generated Files
The command generates:
src/generated/models/{Table}Model.ts -- TypeScript interfaces, plus {Table}FileColumnName, {Table}ImageColumnName, {Table}UploadColumnName union types if the table has file/image columns
src/generated/services/{Table}Service.ts -- CRUD methods (create, get, getAll, update, delete) plus upload, downloadFile, downloadImage, deleteFileOrImage if file/image columns exist
Show the user a usage example:
import { AccountsService } from "../generated/services/AccountsService";
const result = await AccountsService.getAll({
select: ["name", "accountnumber"],
filter: "statecode eq 0",
orderBy: ["name asc"],
top: 50
});
const accounts = result.data || [];
Key rules:
- Use generated services (e.g.,
AccountsService.getAll()), not fetch/axios
- Check
result.data for actual data
- Don't edit generated files unless needed
- Read dataverse-reference.md before writing any Dataverse code -- picklist fields, virtual fields, lookups, and file/image columns all have critical gotchas
Step 7: Build
npm run build
Fix TypeScript errors before proceeding. Do NOT deploy yet.
Update Memory Bank
Record which tables were added (or created), generated files, and any schema notes.
1---2name: add-dataverse3description: Adds Dataverse tables to a Power Apps code app with generated TypeScript models and services. Can also create new Dataverse tables. Use when connecting to Dataverse, adding tables, creating schema, or querying Dataverse data.4user-invocable: true5allowed-tools: Read, Edit, Write, Grep, Glob, Bash, LSP, TaskCreate, TaskUpdate, TaskList, TaskGet, AskUserQuestion, Skill, EnterPlanMode, ExitPlanMode6model: opus7metadata:8 source: https://skillmd.com/skills/microsoft/add-dataverse9---1011**📋 Shared Instructions: [shared-instructions.md](../../shared/shared-instructions.md)** - Cross-cutting concerns.1213**References:**1415- [dataverse-reference.md](./references/dataverse-reference.md) - Picklist fields, virtual fields, lookups, file/image columns, form patterns (CRITICAL)16- [api-authentication-reference.md](./references/api-authentication-reference.md) - Dataverse API auth, token, publisher prefix17- [table-management-reference.md](./references/table-management-reference.md) - Query, create, extend tables and columns18- [data-architecture-reference.md](./references/data-architecture-reference.md) - Relationship types, dependency tiers1920# Add Dataverse2122Two paths: **existing tables** (skip to Step 5) or **new tables** (full workflow).2324## Workflow25261. Plan → 2. Setup API Auth → 3. Review Existing Tables → 4. Create Tables → 5. Add Data Source → 6. Review Generated Files → 7. Build2728---2930### Step 1: Plan3132Check memory bank for project context. Ask the user:33341. Which Dataverse table(s) do they need? (e.g., `account`, `contact`, `cr123_customentity`)352. Do the tables **already exist** in their environment, or do they need to **create new** ones?3637**If tables already exist:** Skip to Step 5.3839**If creating new tables:**4041- Ask about the data they need and design an appropriate schema42- Use standard Dataverse tables when appropriate (`contact` for people, `account` for organizations)43- Build a dependency graph -- see [data-architecture-reference.md](./references/data-architecture-reference.md) for tier classification44- Enter plan mode with `EnterPlanMode`, present ER model with tables, columns, relationships, and creation order45- Get approval with `ExitPlanMode`4647### Step 2: Setup API Auth (if creating tables)4849See [api-authentication-reference.md](./references/api-authentication-reference.md) for full details.5051```powershell52az account show # Verify Azure CLI logged in5354# Find your Dataverse environment URL:55# In make.powerapps.com → Settings → Developer resources → Web API endpoint56# It looks like: https://<org-name>.crm.dynamics.com/api/data/v9.2/57# Use the base URL: https://<org-name>.crm.dynamics.com5859$api = Initialize-DataverseApi -EnvironmentUrl "https://<org>.crm.dynamics.com"60$headers = $api.Headers61$baseUrl = $api.BaseUrl62$publisherPrefix = $api.PublisherPrefix63```6465Requires **System Administrator** or **System Customizer** security role.6667### Step 3: Review Existing Tables (if creating tables)6869**Always query existing tables first before creating:**7071```powershell72$existingTables = Invoke-RestMethod -Uri "$baseUrl/EntityDefinitions?`$filter=IsCustomEntity eq true&`$select=SchemaName,LogicalName,DisplayName" -Headers $headers73```7475See [table-management-reference.md](./references/table-management-reference.md) for `Find-SimilarTables`, `Compare-TableSchemas`, and `Build-TableNameMapping` functions.7677Present findings to user with `AskUserQuestion`:7879- Tables that can be **reused** (already exist with matching columns)80- Tables that need **extension** (exist but missing columns)81- Tables that must be **created** (no match found)8283### Step 4: Create Tables (if creating tables)8485Get explicit confirmation before creating. Create in dependency order:8687- **Tier 0**: Reference tables (no dependencies)88- **Tier 1**: Primary entities (reference Tier 0)89- **Tier 2**: Dependent tables (reference Tier 1)9091Use safe functions from [table-management-reference.md](./references/table-management-reference.md):9293- `New-DataverseTableIfNotExists`94- `Add-DataverseColumnIfNotExists`95- `Add-DataverseLookupIfNotExists` (from [data-architecture-reference.md](./references/data-architecture-reference.md))9697### Step 5: Add Data Source9899For each table:100101```bash102pa app add data-source --connector dataverse --table <table-logical-name>103```104105Can add multiple tables by running the command for each one.106107### Step 6: Review Generated Files108109The command generates:110111- `src/generated/models/{Table}Model.ts` -- TypeScript interfaces, plus `{Table}FileColumnName`, `{Table}ImageColumnName`, `{Table}UploadColumnName` union types if the table has file/image columns112- `src/generated/services/{Table}Service.ts` -- CRUD methods (create, get, getAll, update, delete) plus `upload`, `downloadFile`, `downloadImage`, `deleteFileOrImage` if file/image columns exist113114Show the user a usage example:115116```typescript117import { AccountsService } from "../generated/services/AccountsService";118119const result = await AccountsService.getAll({120 select: ["name", "accountnumber"],121 filter: "statecode eq 0",122 orderBy: ["name asc"],123 top: 50124});125const accounts = result.data || [];126```127128**Key rules:**129130- Use generated services (e.g., `AccountsService.getAll()`), not fetch/axios131- Check `result.data` for actual data132- Don't edit generated files unless needed133- **Read [dataverse-reference.md](./references/dataverse-reference.md) before writing any Dataverse code** -- picklist fields, virtual fields, lookups, and file/image columns all have critical gotchas134135### Step 7: Build136137```bash138npm run build139```140141Fix TypeScript errors before proceeding. Do NOT deploy yet.142143### Update Memory Bank144145Record which tables were added (or created), generated files, and any schema notes.