XrmToolkit Files.

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 and 1 folder are generated for each solution that is linked in XrmToolkit:

  • .xrm
  • .xrmcache
  • .xrmsuo
  • .xrm (folder)

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

Xrm File

The .Xrm file contains the information that links your Visual Studio solution, project and individual files to each of the CRM Organizations. If you are using a source control system you should include this file.

XrmCache File

The .XrmCache file contains entity and attribute metadata for each of the linked CRM organizations. This file is zipped to keep the size much smaller than at actually is. To view the contents simply change the extension to .zip and open the zipped file. The zip file contains a single json based file titled 'Serialized.json'. If you are using a source control system, we suggest that you do not include this file.

This file is generated the first time that you login to a CRM organization. This process in most instances takes less than a minute but in some instances can take several minutes to complete. Several factors determine the download time: the number of custom entities and your connection speed. The largest factor is the connection speed between your computer and the organization. Being connected via a VPN can sometimes increase the time this process takes to complete.

Upon subsequent logins, XrmToolkit attempts to download any changes that have occurred since the last time it was connected. You may also manually retrieve any changes from your organization through either of 2 menu buttons on the XrmToolkit solution context menu shown here:

The 'Refresh' button attempts to retrieve only the metadata that has changed since the last download. The 'Clear Cache and Refresh' button deletes all the metadata out of the local file and re-downloads all the entity and attribute metadata from CRM.

XrmSuo File

The .XrmSuo file is an encrypted file containing username and password information (if selected to be saved) for each of the linked CRM Organizations. If you are using a source control system you should NOT include this file.

Xrm Folder

XrmToolkit may also optionally create a hidden folder named '.xrm'. This folder is used to cache plugin files locally. This helps speed up the loading of the plugin window for plugins that do not change frequently.