Dependency tracking for solution components
This topic applies to Dynamics 365 Customer Engagement (on-premises). For the Power Apps version of this topic, see: Dependency tracking for solution components.
Solutions are made of solution components. You'll use the Solutions area in Dynamics 365 Customer Engagement (on-premises) to create or add solution components. You can perform these actions programmatically by using the AddSolutionComponentRequest message or any messages that create or update solution components that include a
Solution components often depend on other solution components. You can't delete any solution component that has dependencies on another solution component. For example, a customized ribbon typically requires image or script web resources to display icons and perform actions using scripts. As long as the customized ribbon is in the solution, the specific web resources it uses are required. Before you can delete the web resources you must remove references to them in the customized ribbon. These solution component dependencies can be viewed in the application by clicking Show Dependencies.
This topic describes the types of solution components you can include in your solutions and how they depend on each other.
All solution components
The complete list of available solutions component types is located in the system
componenttype global option set. You can use the
https://[ORGANIZATION_NAME].api.crm.dynamics.com/api/data/v9.0/GlobalOptionSetDefinitions(Name='componenttype')REST endpoint to query this data and see all componenet using code. The supported range of values for this property is available by including the file SampleCode\CS\HelperCode\OptionSets.cs or SampleCode\VB\HelperCode\OptionSets.vb in your project. However, many of the solution component types listed there are for internal use only and the list doesn’t provide information about the relationships between solution components.
Solution component dependencies
Solution component dependencies help make sure you have a reliable experience working with solutions. They prevent actions that you normally perform from unintentionally breaking customizations defined in a solution. These dependencies are what allow a managed solution to be installed and uninstalled simply by importing or deleting a solution.
The solutions framework automatically tracks dependencies for solution components. Every operation on a solution component automatically calculates any dependencies to other components in the system. The dependency information is used to maintain the integrity of the system and prevent operations that could lead to an inconsistent state.
As a result of dependency tracking the following behaviors are enforced:
Deletion of a component is prevented if another component in the system depends on it.
Export of a solution warns the user if there are any missing components that could cause failure when importing that solution in another system.
Warnings during export can be ignored if the solution developer intends that the solution is only to be installed in an organization where dependent components are expected to exist. For example, when you create a solution that is designed to be installed over a pre-installed "base" solution.
Import of a solution fails if all required components aren't included in the solution and also don't exist in the target system.
- Additionally, when you import a managed solution all required components must match the package type of the solution. A component in a managed solution can only depend on another managed component.
There are three types of solution component dependencies:
Internal dependencies are managed by Dynamics 365 Customer Engagement (on-premises). They exist when a particular solution component can't exist without another solution component.
Published dependencies are created when two solution components are related to each other and then published. To remove this type of dependency, the association must be removed and the entities published again.
Unpublished dependencies apply to the unpublished version of a publishable solution component that is being updated. After the solution component is published, it becomes a published dependency.
Solution internal dependencies are dependencies where actions with a solution component require an action for another solution component. For example, if you delete an entity, you should expect that all the entity attributes will be deleted with it. Any entity relationships with other entities will also be deleted.
However, an internal dependency may lead to a published dependency and still require manual intervention. For example, if you include a lookup field on an entity form and then delete the primary entity in the relationship, you can't complete that deletion until you remove the lookup field from the related entity form and then publish the form.
When you perform actions programmatically with solutions, you can use messages related to the
Dependencyentity. See Dependency Entity for messages you can use to identify dependencies that may exist before you delete a component or uninstall a solution.
Check for solution component dependencies
When you edit solutions you may find that you can't delete a solution component because it has a published dependency with another solution component. Or, you may not be able to uninstall a managed solution because one of the components in the managed solution has been used in a customization in another unmanaged solution.
The following table lists the messages that you can use to retrieve data about solution component dependencies.
|RetrieveDependentComponentsRequest||Returns a list of dependencies for solution components that directly depend on a solution component.
For example, when you use this message for a global option set solution component, dependency records for solution components representing any option set attributes that reference the global option set solution component are returned.
When you use this message for the solution component record for the account entity, dependency records for all of the solution components representing attributes, views, and forms used for that entity are returned.
|RetrieveRequiredComponentsRequest||Returns a list of the dependencies for solution components that another solution component directly depends on. This message provides the reverse of the
|RetrieveDependenciesForDeleteRequest||Returns a list of all the dependencies for solution components that could prevent deleting a solution component.|
|RetrieveDependenciesForUninstallRequest||Returns a list of all the dependencies for solution components that could prevent uninstalling a managed solution.|
Common Solution components
These are the solution components displayed in the application and the components that you'll work with directly when adding or removing solution components using the solution page. Each of the other types of solution components will depend on one or more of these solution components to exist.
- Application Ribbons (RibbonCustomization)
- Entity (Entity)
- Report (Report)
- Article Template (KBArticleTemplate)
- Field Security Profile (FieldSecurityProfile)
- SDK Message Processing Step (SDKMessageProcessingStep)
- Connection Role (ConnectionRole)
- Mail Merge Template (MailMergeTemplate)
- Security Role (Role)
- Contract Template (ContractTemplate)
- Option Set (OptionSet)
- Service Endpoint (ServiceEndpoint)
- Dashboard or Entity Form (SystemForm)
- Plug-in Assembly (PluginAssembly)
- Site Map (SiteMap)
- Email Template (EmailTemplate)
- Process (Workflow)
- Web Resource (WebResource)
Application ribbons (RibbonCustomization)
Ribbon customizations for the application ribbon and entity ribbon templates. Application ribbons don't include definitions of ribbons at the entity or form level.
$webresource: directive to associate the web resource to the ribbon. More information: $webresource directive
Article template (KBArticleTemplate)
Template that contains the standard attributes of an article. There is always an internal dependency between the article template and the KbArticle entity.
Connection role (ConnectionRole)
Role describing a relationship between a two records. Each connection role defines what types of entity records can be linked using the connection role. This creates a published dependency between the connection role and the entity.
Contract template (ContractTemplate)
Template that contains the standard attributes of a contract. There is always an internal dependency between the contract template and the contract entity.
Dashboard or entity form (SystemForm)
Email template (EmailTemplate)
Template that contains the standard attributes of an email message. An email template typically includes fields that insert data from specified entity attributes. An email template can be linked to a specific entity when it is created so there can be an internal dependency on the entity. A global email template isn't associated with a specific entity, but it may have published dependencies on entity attributes used to provide data. A process (workflow) frequently is configured to send an email using an email template creating a published dependency with the workflow.
The primary structure used to model and manage data in Dynamics 365 Customer Engagement (on-premises). Charts, forms, entity relationships, views, and attributes associated with an entity are deleted automatically when the entity is deleted because of the internal dependencies between them. Entities frequently have published dependencies with processes, dashboards, and email templates.
Field security profile (FieldSecurityProfile)
Profile that defines the access level for secured attributes.
Mail merge template (MailMergeTemplate)
Template that contains the standard attributes of a mail merge document. A mail merge template has a published dependency on the entity it's associated with.
Option set (OptionSet)
An option set defines a set of options. A picklist attribute uses an option set to define the options provided. Several picklist attributes may use a global option set so that the options they provide are always the same and can be maintained in one place. A published dependency occurs when a picklist attribute references a global option set. You can't delete a global option set that is being used by a picklist attribute.
Plug-in assembly (PluginAssembly)
Assembly that contains one or more plug-in types. Plug-ins are registered to events that are typically associated with an entity. This creates a published dependency.
Set of logical rules that define the steps necessary to automate a specific business process, task, or set of actions to be performed. Processes provide a wide range of actions that create published dependencies on any other solution component referenced by the process. Each process also has a published dependency on the entity it's associated with.
Data summary in an easy-to-read layout. A report has published dependencies on any entity or attribute data included in the report. Each report must also be associated with a Report category creating an internal dependency on a solution component called Report Related Category (ReportCategory). Reports may be configured to be subreports creating a published dependency with the parent report.
SDK message processing step (SDKMessageProcessingStep)
Stage in the execution pipeline that a plug-in is to execute.
Security role (Role)
Grouping of security privileges. Users are assigned roles that authorize their access to the Dynamics 365 Customer Engagement (on-premises) system. Entity forms can be associated with specific security roles to control who can view the form. This creates a published dependency between the security role and the form.
Only security roles from the organization business unit can be added to a solution. Only a user with read access to those security roles can add them to a solution.
Service endpoint (ServiceEndpoint)
Service endpoint that can be contacted.
Site map (SiteMap)
XML data used to control the application navigation pane. The site map may be linked to display an HTML web resource or an icon in the site map may use an image web resource. When the
$webresource: directive is used to establish these associations a published dependency is created. More information: $webresource directive
Web resource (WebResource)
Data equivalent to files used in web development. Web resources provide client-side components that are used to provide custom user interface elements. Web resources may have published dependencies with entity forms, ribbons and the SiteMap. When the
$webresource: directive is used to establish associations in a ribbon or the SiteMap, a published dependency is created. For more information, see $webresource directive.
Web resources may depend on other web resources based on relative links. For example, an HTML web resource may use a CSS or script web resource. A Silverlight web resource displayed outside of an entity form or chart must have an HTML web resource to host it. These dependencies aren't tracked as solution dependencies.
Package and Distribute Extensions with Dynamics 365 Customer Engagement (on-premises) Solution
Introduction to Solutions
Plan For Solution Development
Create, Export, or Import an Unmanaged Solution
Create, install, and update a managed solution
Create, Install, and Update a Managed Solution
Uninstall or Delete a solution