Schema Compare — User Guide
Overview
Schema Compare (Entity Metadata Compare) performs a deep comparison of Dataverse entity metadata between two environments. It covers entity properties, fields, forms, views, relationships, keys, and business rules — showing exactly what differs.
Prerequisites
- Two active connections to Dataverse environments
- Read access to entity metadata in both environments (
prvReadEntity,prvReadAttribute, etc.)
Getting Started
- Select Schema Compare from the sidebar
- Select the Source and Target environments from the environment selectors
- Enter the entities to compare
Workflow
1. Choose Environments
- Source — The reference environment (e.g. Production)
- Target — The environment to check against (e.g. Development)
2. Select Entities
You can specify entities in two ways:
- Dropdown picker — Search and select individual entity logical names
- Text input — Enter a comma-separated list of logical names (e.g.
account, contact, opportunity)
3. Run the Comparison
Click Compare to start the analysis.
For each entity, the plugin fetches and compares:
| Metadata section | What is checked |
|---|---|
| Entity properties | Ownership, object type code, display names, flags |
| Attributes (Fields) | Type, required level, display name, max length, etc. |
| Forms | Name, type, default flag |
| Views | Name, query filters |
| Relationships | 1:N, N:1, N:N — cascade settings, lookup field names |
| Keys | Alternate key definitions |
| Business Rules | Name and scope |
4. Review Results
Results are displayed in a collapsible tree per entity:
- Green — Item exists and matches in both environments
- Red / highlighted — Item differs or is missing in one environment
- Only in source — Item exists in source but not in target (deployment gap)
- Only in target — Item exists in target but not in source (unexpected addition)
5. Export Results
Click Export to download the comparison as:
- CSV — Flat rows with entity, section, field, source value, target value
- Excel — Separate sheets per entity, with conditional formatting
Tips
| Tip | Detail |
|---|---|
| Compare after deployment | Run immediately after a solution deployment to confirm all metadata applied correctly |
| Start with key entities | Compare the highest-risk entities first rather than running all at once |
| Use CSV export for diffs | The CSV export is easy to filter in Excel to show only differing rows |
Troubleshooting
| Problem | Resolution |
|---|---|
| Entity not found | Confirm the logical name is correct and the entity exists in both environments |
| Comparison times out for large entities | Compare one entity at a time for very large schemas |
| Missing relationship details | Ensure your account has prvReadRelationship privilege |