Use solutions for your customizations

Applies To: Dynamics CRM 2013

All customizations performed in Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online are done in the context of a solution. If you aren’t sure about what a solution is, please see ece68f5f-ad40-4bfa-975a-3e5bafb854aa#BKMK_Solutions.

In This Topic

The default solution

Navigate to a specific solution

Use the solution explorer

Create your own solution

Import, update, and export solutions

Settings options for solution export

The default solution

When you customize Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online, you’ll typically work with the default solution. To open the default solution, navigate to Settings > Customizations and select Customize the System.

Every organization has a default solution and it has some unique properties. The default solution contains all the solution components available in your organization. Other solutions may include a subset of the solution components visible in the default solution, but the default solution contains all of them.

Navigate to a specific solution

If your organization already has a specific solution you should work in, this is how you can find it. To create a new solution, see Create your own solution.

Open an unmanaged solution

1. Navigate to Settings > Customizations and click Solutions.

2. Double-click the unmanaged solution that you want to work in to open it.

When you’re in the solution, you’ll see solution components. More information: Add solution components

Use the solution explorer

Within the solution explorer you can navigate through a hierarchy of nodes using the navigation pane on the left side as shown in the following screenshot:

As you select each node, you can see a list of the solution components. The actions available in the command bar will change depending on the context of the node you have selected and if the solution is the default solution or a managed solution. With unmanaged solutions that are not the default solution, you can use the Add Existing command to bring in solution components that aren’t already in the solution.

With managed solutions there will be no commands available and you’ll see the message:

You can’t directly edit the components within a managed solution. If the managed properties for solution components are set to allow customizations, you can edit them in the Customizations area or from another unmanaged solution.

You’ll need to locate the solution component in the default solution and try to edit it there or add it to another unmanaged solution that you’ve created. The solution component might not be customizable. More information: ece68f5f-ad40-4bfa-975a-3e5bafb854aa#BKMK_ManagedProperties

Many of the customizations you’ll want to do will involve entities. You can expand the Entities node to show a list of all the entities in the system that can be customized in some way. You can further expand each entity to see the solutions components that are part of the entity as shown with the account entity in the following screenshot:

For details about customizing the individual solution components found in the solution explorer, see the following topics:

• For entity, entity relationships, field and message customizations, see Create and edit metadata.

• For entity forms see Create and design forms.

• For processes, see Create and edit processes.

• For business rules, see Create and edit business rules.

Create your own solution

Because the default solution contains all the solutions components, it may be easier for you to locate just the solution components that you’ve customized if you create a separate solution and do all your customization there. This also makes it easy to export a backup of your solution as a smaller file. If you choose to do this, you must always remember to add any of the solution components you edit to this solution. When you create new solution components, you should always create them in the context of this solution. This way the solution publisher customization prefix will be applied consistently. After you have created solution components in your solution, or added existing solution components to that solution, you can also edit them in the default solution if you wish.

1. Navigate to Settings > Solutions.

2. Click New and complete the required fields for the solution

   Field	Description
   Display Name	The name shown in the list of solutions. You can change this later.
   Name	The unique name of the solution. This is generated using the value you enter in the Display Name field. You can edit this before you save the solution, but after you save the solution, you can’t change it.
   Publisher	You can select the default publisher or create a new publisher. Unless you plan to distribute your solution, you should just use the default publisher for your organization.
   Version	Enter a number for the version of your solution. This is only important if you export your solution. The version number will be included in the file name when you export the solution.

3. Click Save.

After you save the solution, you may wish to add information to fields that aren’t required. These steps are optional. Use the Description field to describe the solution and choose an HTML web resource as a Configuration Page for the solution. The configuration page is typically used by ISVs who distribute solutions. When this is set, a new Configuration node appears below the Information node to display this web resource. Developers will use this page to include instructions or controls to allow you to set configuration data or launch their solution.

Add solution components

After you’ve created your solution, it won’t contain any solution components. You can create new solution components or use the Add Existing button in the list menu to add any solution components from the default solution.

When you do this you may see a Missing Required Components dialog.

This dialog alerts you that the solution component has dependencies on other solution components. If you select No, do not include required components, the solution may fail if you import it into another organization where all those required components do not exist. If the solution import succeeds, the behavior in the other solution may not be identical as the original organization because the components are configured differently than those in the source solution.

Generally, it’s safer to include the required components if you intend to export the solution into another organization. If you don’t add these components when you add an individual solution component, you can come back later, select the solution component you added, and click Add Required Components from the menu.

If you don’t intend to export the solution, or if you only intend to export it as an unmanaged solution and import it back into the same organization, it isn’t necessary to include required components. If you ever export the solution you’ll see another warning indicating that some required components are missing. If you are only going to import this solution back into the same organization, it is OK to disregard this warning. The steps to edit application navigation or the ribbon without using a third-party editing tool expect that you’ll export the solution back into the same organization.

Import, update, and export solutions

How often you import, update, or export solutions may depend on the size of your organization, your internal development practices, and whether you are developing a solution that is to be distributed as a managed solution.

• If you have a small organization with few customizations, and you’re the only customizer, you may never export or import solutions except to periodically export the default solution to create a backup or if you choose to use or buy a managed solution provided by someone else.

• Some organizations will have an outside company create customizations for them. In this case, they’ll export any customizations that they currently have and send them to the outside company. That company will develop and test customizations and send them back to the organization to be imported.

• Large organizations may have several teams of people customizing the system. They may have a separate organization just for development and customizations. These organizations frequently also have a separate test organizations and a UAT (User Acceptance Testing) organizations in addition to a production organization which everyone in the organization actually uses. These organizations depend on exporting and importing customizations from one organization to the next in the process of creating, testing, and verifying the solutions. These organizations may want to download the ALM for Microsoft Dynamics CRM 2011: CRM Solution Lifecycle Management or Deploying Microsoft Dynamics CRM 2011 and CRM Online Solutions from Development through Test and Production Environments white papers for ideas about how they can manage this process. Organizations operating at this scale normally write programs to automate exporting and importing solutions.

The strategy you choose should depend on your needs. Some important things to keep in mind:

• You can’t export your default solution as a managed solution.

• We don’t support importing a default solution taken from an on-premise deployment into a CRM Online organization or a default solution taken from a CRM Online organization into an on-premises deployment. We do support importing custom solutions between these deployment types, but not default solutions.

• Custom solutions developed using Microsoft Dynamics CRM 2011 can be imported into Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online organizations.

• Our plan is that custom solutions developed using Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online can be deployed on future point releases of Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online and within support boundaries declared for future versions of CRM.

• Our plan is that custom solutions developed using future versions of Microsoft Dynamics CRM cannot be installed into earlier versions without first being ‘down-leveled’ to match the earlier version. Details about this ‘down-level’ process will be provided when Microsoft Dynamics CRM 2013 is released.

• When you export a managed solution, you can’t import it back into the organization it was imported from.

• Only export a solution as a managed solution when you intend to distribute it.

• Never import an unmanaged solution unless you are sure you want to accept all the customizations in it and allow any of those customizations to overwrite any customizations you previously created.

• Solutions can’t delete anything. Importing an unmanaged solution might overwrite existing customizations, but it can’t entirely remove them. For example, if you create a custom field for an entity, and then import a solution containing the definition of that entity that doesn’t have the custom field, the custom field you created will still be there. Also, any changes defined within the solution you imported will be there.

• You can’t import a custom entity with the same name as an existing entity. Microsoft Dynamics CRM allows duplicate display names, though.

• You can import only items that you have organization-level access to create, read, and update.

• You must have the System Administrator security role to import security roles, organization settings, sdk message processing steps, and plug-in assemblies.

• If you import customizations that include a language that is not installed on your system, any labels defined in the customizations will default to the base language of the Microsoft Dynamics CRM system the customizations were imported from.

• All imported security roles will be attached to the root business unit.

• If an imported security role originated from the same CRM system, any changes applied to the security role will be merged. All privileges on system entities for the security role will be replaced by privileges defined by the security role that is being imported.

Import solutions in Microsoft Dynamics CRM privacy information

You can import and export solutions to and from Microsoft Dynamics CRM Online. When you do so, the solutions, which may contain personal information, are transferred over a secure connection between your computer and Microsoft servers.

Import solutions

You can import solutions manually using the steps below. Only import solutions that you've obtained from a trusted source. Customizations might include code that can send data to external sources.

1. Navigate to Settings > Solutions.

2. In the solutions list menu choose Import.

3. In the Import Solution dialog, Select Solution Package step browse to the compressed (.zip or .cab) file that contains the solution you want to import.

4. Click Next

5. You can view information about the solution before you click Import.

6. You may need to wait a few moments while the solution import completes. If it is successful, you can view the results and click Close.

If you have imported any changes that require publishing, you must publish customizations before they will be available. See ece68f5f-ad40-4bfa-975a-3e5bafb854aa#BKMK_PublishingCustomizations for more information.

If the import isn’t successful, you will see a report showing any errors or warnings that were captured. You can click Download Log File to capture details about what caused the import to fail. The most common cause for a solution import to fail is that the solution did not contain some required solution components.

When you download the log file, you will find an XML file that you can open using Microsoft Office Excel and view the contents.

Update solutions

There are times when you may wish to install an update to an existing managed solution. The procedure is similar to installing a new managed solution, except you will get some different options. If you are updating a solution you got from someone else, you should get guidance from the solution publisher about which options you should choose.

1. Navigate to Settings > Solutions.

2. In the solutions list menu choose Import.

3. In the Import Solution dialog, Select Solution Package step browse to the compressed (.zip or .cab) file that contains the solution you want to update.

4. Click Next

5. You can view information about the solution before you click Next. This page will display a yellow bar saying This solution package contains an update for a solution that is already installed.

6. You will have the following options:

   • Maintain customizations (recommended)

     Selecting this option will maintain any unmanaged customizations performed on components but also implies that some fo the updates included in this solution will not take effect.

   • Overwrite Customizations

     Selecting this option overwrites any unmanaged customizations previously performed on components included in this solution. All updates included in this solution will take effect.

   Choose the appropriate option and then click Next.

7. You may need to wait a few moments while the solution import completes. If it is successful, you can view the results and click Close.

If you have imported any changes that require publishing, you must publish customizations before they will be available. See ece68f5f-ad40-4bfa-975a-3e5bafb854aa#BKMK_PublishingCustomizations for more information.

Solution publishers may ask you to export your existing unmanaged customizations, update their managed solution using the option to overwrite customizations, and then re-import your unmanaged customizations. This will help ensure that the changes they are expecting are applied while preserving your customizations.

Export solutions

We recommend that you export your unmanaged customizations periodically so that you have a backup in case anything happens. You cannot export managed solutions.

1. Navigate to Settings > Solutions.

2. In the list select the solution you want to export and click Export.

3. In the Publish Customizations step you will be reminded that only published customizations are exported and you will have the option to Publish All Customizations before you click Next.

4. If your solution contains any missing required components you will see the Missing Required Components step. You can disregard this warning only if you intend to import this as an unmanaged solution back into the original organization. Otherwise, follow the instructions in the dialog to cancel the export and add the required components.

5. In the Export System Settings (Advanced) step you can choose certain system settings to include in your solution. If your solution depends on any of the groups of system settings, select them and click Next.

   See Settings options for solution export for details about the settings that will be included with each option.

6. In the Package Type step, you must choose whether to export the solution as an Unmanaged or Managed solution.

7. The next step allows you to choose a target solution for a specific CRM version. This option is typically used by ISVs who may want to export a solution that is compliant with a previous version. Unless you intend to import this solution into an organization that is not upgraded to the same version as the organization version you are using, accept the default.

   For more information see the SDK topic Export a solution for a specific CRM version.

8. Click Export to download the solution file.

The exact behavior for downloading files varies between browsers.

Settings options for solution export

The following table shows the options available when you export a solution:

See Also

Getting started with customization
Privileges required for customization
Customization concepts
Customization overview

© 2016 Microsoft Corporation. All rights reserved. Copyright