When to edit the customizations file
Updated: November 29, 2016
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
The customizations.xml file that is exported as part of an unmanaged solution can be edited to perform specific customization tasks. After editing the file you can compress the modified file together with the other files exported in the unmanaged solution. You apply the changes by importing that modified unmanaged solution.
Editing a complex XML file like the customizations.xml file is much easier and less prone to errors if you use a program designed to support schema validation. While it is possible to edit this file using a simple text editor like Notepad, this is not recommended unless you are very familiar with editing this file. For more information, see Edit the customizations XML file with schema validation.
Invalid XML or incorrect definition of solution components can cause errors that will prevent importing a manually edited unmanaged solution.
You can edit the customization.xml file to perform the following tasks.
- Editing the ribbon
The Microsoft Dynamics 365 SDK describes the process of editing the ribbon by editing the customization.xml file directly. Several people have created ribbon editors that provide a user interface to make editing the ribbon easier. Currently the following projects are available on CodePlex:
For support using these programs, contact the program publisher.
For more information about editing the ribbon by editing the customization.xml manually, see Customize commands and the ribbon.
- Editing the SiteMap
The SDK describes the process of editing the SiteMap by editing the customization.xml file directly.
Several people have also created SiteMap editors. Currently the following projects are available on CodePlex:
For more information see Change application navigation using the SiteMap
- Editing FormXml
FormXml is used to define entity forms and dashboards. The form editor and dashboard designer in the application are the most commonly used tools for this purpose. Editing the customizations.xml file is an alternative method. For more information, see Customize entity forms and Create a dashboard.
- Editing saved queries
Definitions of views for entities are included in the customizations.xml file and may be manually edited. The view editor in the application is the most commonly used tool for this purpose. Editing customizations.xml is an alternative method. For more information, see Customize entity views.
- Editing the ISV.config
In earlier versions of Microsoft Dynamics 365, ISV.Config was the way to add client application extensions as well as some other configuration options. For Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online, the Ribbon provides the way to extend the application. The only remaining capability left in ISV.Config is to customize the appearance of the Service Calendar. For more information, see Service calendar appearance configuration.
Defining any other solution components by editing the exported customizations.xml file is not supported. This includes the following:
SDK Message Processing steps
Mail Merge Templates
Field Security Profiles
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright