Source Control.

XrmToolkit uses JSON based files to store configuration and metadata information regarding the links between your CRM organization and your Visual Studio Solution. The following 3 files are generated for each solution that is linked in XrmToolkit:

  • .xrm - This file should be saved in your source control system
  • .xrmcache - We recommend that this file not be saved in your source control system
  • .xrmsuo - This file should NOT be saved in your source control system

As shown in the image below, these files are created in the same directory and with the same name as your Visual Studio solution:

For more information regarding the contents of these files please see 'XrmToolkit Files'.

Checking out the .xrm file

This file will need to be checked out from your source control system for edit whenever a change is made regarding your items linked to CRM. Some of these types of changes include:

  • Adding or removing web resources or reports
  • Linking a plugin assembly project to Dynamics 365
  • Changing backup options on your web resources or projects
  • Modifying minification settings for your JavaScript or CSS files
  • Adding or updating Proxy classes
  • Adding or updating JavaScript or TypeScript intellisense files