Documentation
How to install, run and build on xrmverse. Each page describes the exact behaviour of xrmverse, including its known deviations from Dataverse.
Concepts
- PhilosophyThe contract with Dataverse, one semantics, self-sufficiency, AI agents, porting first
- ArchitectureModules, the path of a request, plug-ins, data and metadata, environments, identity, the UI
- xrmverse compared with DataverseWhat is the same, what works differently, what is not in xrmverse
Install and run
- Installing xrmverseProduction install from a release: requirements, host names on 443, certificates, your own reverse proxy, offline install, upgrade
- Getting startedQuick start with Docker, the repository compose file, development tokens, notes (ServiceClient port, Apple Silicon)
- Installing the Microsoft SDKBring your own SDK:
xrmd sdk install, what needs it and what does not - ConfigurationConfiguration keys and environment variables of
xrmd - Multiple organizationsSeveral organizations on one SQL Server: one database and one
xrmdprocess each - SQL Server editionsExpress by default,
MSSQL_PID, licensing - ObservabilityHealth checks, Prometheus metrics, OTLP tracing,
xrmd logs
Platform reference
- Tables in every organizationSeeded system tables,
accountandcontact, relationships and cascades - Supported queriesFetchXML, QueryExpression and OData, limits and known deviations
- Elastic tablesPartitions, time to live, bulk messages, session token, what is refused and the known gaps
- Bulk operations
CreateMultiple,UpdateMultiple,UpsertMultiple,Upsertand PATCH upsert on standard tables, the two-way plug-in merge, images, what is refused - Plug-insRegistration, pipeline stages, execution context, async plug-ins
- Classic workflowsWorkflows, business rules and XAML actions from solutions: triggers, stages and order with plug-ins, background jobs and waits,
ExecuteWorkflow, custom workflow activities, the step catalog, known limits - Workflow authoring as codeWorkflows, business rules and actions as YAML: the format,
xrmd workflow, the authoring API and MCP tools, privileges, export, assumed shapes, known limits - WebhooksService endpoints of contract 8 and their steps: registering (CLI, Web API, SDK), the request sent, outcomes and retries, known limits
- SecurityRoles, privileges and depth, business units, teams, sharing, hierarchy security, access teams
- Local identity providerSign-in without Entra:
server init --auth local, users and TOTP, service clients, ServiceClient connection strings, HTTPS and proxy, keys and backups, limits, nopac - AuditingThe
audittable, switches, audit messages, retention, known limits - Field-level securitySecured columns, field security profiles, field sharing, known limits
- Custom APIsImported custom API definitions: tables, calling through the SDK, SOAP and the Web API, validation, the main operation,
$metadata, solutions, known limits - SolutionsImport and export of unmanaged solutions, preserved XML,
DeleteSolution, Delete cascades - Files and imagesFile and image columns, blob stores, thumbnails, known differences
- Activities and notesActivities,
activitypointer, party lists, notes and their attachments, custom activities,SendEmailwithout a provider, refused messages, known limits - CurrenciesBase currency, currencies and rates,
exchangerateand_basecolumns, precision and formatting,RetrieveExchangeRate, known limits - Glossary and synonymsThe five knowledge source, synonym and glossary tables, creating rows over the Web API, what MCP returns, solutions, known limits
- Duplicate detectionThe three switches, rules and their conditions, publishing, the
SuppressDuplicateDetectioncheck and its0x80040333/ 412 error,RetrieveDuplicates,BulkDetectDuplicates, known limits - Change tracking
ChangeTrackingEnabled,RetrieveEntityChanges, Web API delta queries, the deletion log and its retention, known limits - Autonumber columns
AutoNumberFormat, generated values on Create, sequences, seed messages - SQL endpointRead-only SQL for SSMS, Power BI and SqlClient: SQL logins of the local identity provider,
--tds-port, TLS and the certificate sync, the supported SQL and its errors, columns, limits, security, no Entra yet
Tools
- CLI `xrmd`Install, command groups, publishers and the prefix rule, server setup, profiles, backups, schema files
- Admin APIThe
/adminendpoints used by the CLI and the web admin - Web adminThe
/manageUI: sign-in, audit, field security, deleting a solution, development loop - Model-driven appsThe app picker (
/apps),main.aspx, site map navigation, read-only views, quick find, known limits - MCPThe built-in MCP server for AI agents and the stdio bridge